Register Method

Description

Registers a handler object/function for handling the specified type of events.

Syntax

Visual Basic
Public Function Register( _ ByVal eventToListen As Event, _ ByVal eventSink As Object _ ) As Long

Parameters

eventToListen

Value	Description
Event_ActiveListingChanged	OnActiveListingChanged Event
Event_AddObjectFile	OnAddObjectFile Event
Event_AddObjectsToFavorites	OnAddObjectsToFavorites Event
Event_AddObjectToFavorites	OnAddObjectsToFavorites Event
Event_AutoInstallScheduleChanged	OnAutoInstallScheduleChanged Event
Event_BuiltinCommand	OnBuiltinCommand Event
Event_ChangeVaultLanguage	OnChangeVaultLanguage Event
Event_CheckInObject	OnCheckInObject Event
Event_CheckInObjects	OnCheckInObjects Event
Event_CheckOutObject	OnCheckOutObject Event
Event_CheckOutObjects	OnCheckOutObjects Event
Event_CloseWindow	OnCloseWindow Event
Event_ContentChanged	OnContentChanged Event
Event_CopyConflictObjectAsNewVersionToBaseObject	OnCopyConflictObjectAsNewVersionToBaseObject Event
Event_CreateObject	OnCreateObject Event
Event_CrossApplicationBroadcast	OnCrossApplicationBroadcast Event
Event_CrossApplicationNotification	OnCrossApplicationNotification Event
Event_CustomCommand	OnCustomCommand Event
Event_DestroyObject	OnDestroyObject Event
Event_DestroyObjects	OnDestroyObjects Event
Event_DestroyObjectVersion	OnDestroyObjectVersion Event
Event_DestroyObjectVersions	OnDestroyObjectVersions Event
Event_DragEntered	OnDragEntered Event
Event_DragLeft	OnDragLeft Event
Event_DragOver	OnDragOver Event
Event_FacetValuesError	OnFacetValuesError Event
Event_FacetValuesReady	OnFacetValuesReady Event
Event_HidePane	OnHidePane Event
Event_HideTab	OnHideTab Event
Event_ItemsDropped	OnItemsDropped Event
Event_ListingActivated	OnListingActivated Event
Event_ListingDeactivated	OnListingDeactivated Event
Event_ListingUpdated	OnListingUpdated Event
Event_LoggedIn	OnLoggedIn Event
Event_LogOut	OnLogOut Event
Event_MinimizedStateChanged	OnMinimizedStateChanged Event (ShellPaneContainer)
Event_ModifyObjectVersionLabels	OnModifyObjectVersionLabels Event
Event_NewBottomPane	OnNewBottomPane Event
Event_NewCommands	OnNewCommands Event
Event_NewCommonDialogShellFrame	OnNewCommonDialogShellFrame Event
Event_NewEmbeddedShellFrame	OnNewEmbeddedShellFrame Event
Event_NewNormalShellFrame	OnNewNormalShellFrame Event
Event_NewRightPane	OnNewRightPane Event
Event_NewSearchPane	OnNewSearchPane Event
Event_NewShellFrame	OnNewShellFrame Event
Event_NewShellListing	OnNewShellListing Event
Event_NewSpecialShellFrame	OnNewSpecialShellFrame Event
Event_NewTab	OnNewTab Event
Event_NewTaskPane	OnNewTaskPane Event
Event_NewTopPane	OnNewTopPane Event
Event_NewVaultEntry	OnNewVaultEntry Event
Event_NewVersionBasedOnConflictObjectCreated	OnNewVersionBasedOnConflictObjectCreated Event
Event_Notification	OnNotification Event
Event_ObjectAddedToFavorites	OnObjectAddedToFavorites Event
Event_ObjectCheckedIn	OnObjectCheckedIn Event
Event_ObjectCheckedOut	OnObjectCheckedOut Event
Event_ObjectCheckoutsUndone	OnObjectCheckoutsUndone Event
Event_ObjectCheckoutUndone	OnObjectCheckoutUndone Event
Event_ObjectCreated	OnObjectCreated Event
Event_ObjectDestroyed	OnObjectDestroyed Event
Event_ObjectFileAdded	OnObjectFileAdded Event
Event_ObjectFileRemoved	OnObjectFileRemoved Event
Event_ObjectFileRenamed	OnObjectFileRenamed Event
Event_ObjectLevelPropertySet	OnObjectLevelPropertySet Event
Event_ObjectOfflineAvailabilityRemoved	OnObjectOfflineAvailabilityRemoved Event
Event_ObjectOfflineAvailabilitySet	OnObjectOfflineAvailabilitySet Event
Event_ObjectRemoved	OnObjectRemoved Event
Event_ObjectRemovedFromFavorites	OnObjectRemovedFromFavorites Event
Event_ObjectsAddedToFavorites	OnObjectsAddedToFavorites Event
Event_ObjectsCheckedIn	OnObjectsCheckedIn Event
Event_ObjectsCheckedOut	OnObjectsCheckedOut Event
Event_ObjectsDestroyed	OnObjectsDestroyed Event
Event_ObjectsRemoved	OnObjectsRemoved Event
Event_ObjectsRemovedFromFavorites	OnObjectsRemovedFromFavorites Event
Event_ObjectsUndeleted	OnObjectsUndeleted Event
Event_ObjectUndeleted	OnObjectUndeleted Event
Event_ObjectVersionDestroyed	OnObjectVersionDestroyed Event
Event_ObjectVersionLabelsModified	OnObjectVersionLabelsModified Event
Event_ObjectVersionPermissionsSet	OnObjectVersionPermissionsSet Event
Event_ObjectVersionRolledBack	OnObjectVersionRolledBack Event
Event_ObjectVersionsDestroyed	OnObjectVersionsDestroyed Event
Event_OfflineSyncStarted	OnOfflineSyncStarted Event
Event_OfflineSyncStopped	OnOfflineSyncStopped Event
Event_PaneResized	OnPaneResized Event
Event_PropertiesOfObjectVersionSet	OnPropertiesOfObjectVersionSet Event
Event_PropertiesOfObjectVersionsSet	OnPropertiesOfObjectVersionsSet Event
Event_RemoveObject	OnRemoveObject Event
Event_RemoveObjectFile	OnRemoveObjectFile Event
Event_RemoveObjectFromFavorites	OnRemoveObjectFromFavorites Event
Event_RemoveObjectOfflineAvailability	OnRemoveObjectOfflineAvailability Event
Event_RemoveObjects	OnRemoveObjects Event
Event_RemoveObjectsFromFavorites	OnRemoveObjectsFromFavorites Event
Event_RenameObjectFile	OnRenameObjectFile Event
Event_RollBackObjectVersion	OnRollBackObjectVersion Event
Event_SearchCriteriaChanged	OnSearchCriteriaChanged Event
Event_SearchCriteriaReset	OnSearchCriteriaReset Event
Event_SearchInitiated	OnSearchInitiated Event
Event_SearchReady	OnSearchReady Event
Event_SelectedItemsChanged	OnSelectedItemsChanged Event
Event_SelectionChanged	OnSelectionChanged Event
Event_SetObjectLevelProperty	OnSetObjectLevelProperty Event
Event_SetObjectOfflineAvailability	OnSetObjectOfflineAvailability Event
Event_SetObjectVersionPermissions	OnSetObjectVersionPermissions Event
Event_SetPropertiesOfObjectVersion	OnSetPropertiesOfObjectVersion Event
Event_SetPropertiesOfObjectVersions	OnSetPropertiesOfObjectVersions Event
Event_ShowContextMenu	OnShowContextMenu Event
Event_ShowMainMenu	OnShowMainMenu Event (ShellFrame), OnShowMainMenu Event (ShellListing)
Event_ShowPane	OnShowPane Event
Event_ShowTab	OnShowTab Event
Event_Started	OnStarted Event
Event_Stop	OnStop Event
Event_TabSelected	OnTabSelected Event (ShellPaneContainer), OnTabSelected Event (ShellPaneTab)
Event_TabUnselected	OnTabUnselected Event (ShellPaneContainer), OnTabUnselected Event (ShellPaneTab)
Event_TemporarySearchModified	OnTemporarySearchModified Event
Event_UndeleteObject	OnUndeleteObject Event
Event_UndeleteObjects	OnUndeleteObjects Event
Event_UndoObjectCheckout	OnUndoObjectCheckout Event
Event_UndoObjectCheckouts	OnUndoObjectCheckouts Event
Event_VaultLanguageChanged	OnVaultLanguageChanged Event
Event_ViewLocationChanged	OnViewLocationChanged Event
Event_ViewLocationChangedAsync	OnViewLocationChangedAsync Event

The event type to handle.

eventSink

The event sink to register.

Return Type

Returns handle to the registered event handler. This handle can be used later to unregister the handler.