Folder Generic Events
The folder generic events allow you to implement custom functionality for folders, including folder types. Some of the events that apply to folders also apply to documents.
Folder Generic Event Sequences
The events that occur for the folder generic commands are shown in the following lists in the sequence that they occur.
Change Folder Type event sequence
-
DocGenericEvent_PrepareCommand
-
FolderGenericEvent_InitializeChangeFolderType
-
FolderGenericEvent_BeforeChangeFolderType
-
FolderGenericEvent_AfterChangeFolderType
-
FolderGenericEvent_BeforeNewFolder
-
FolderGenericEvent_AfterNewFolder
-
FolderGenericEvent_TerminateChangeFolderType
Delete Folder event sequence
-
DocGenericEvent_PrepareCommand
-
DocGenericEvent_InitializeDelete
-
DocGenericEvent_BeforeDelete
-
DocGenericEvent_AfterDelete
-
DocGenericEvent_TerminateDelete
New Folder event sequence
-
FolderGenericEvent_BeforeNewFolder
-
DocGenericEvent_OnProperties
-
FolderGenericEvent_AfterNewFolder
-
DocGenericEvent_*Rename events — Occurs in PowerWeb only when creating a new folder.
AfterNewFolder Event
Occurs after a user creates a new folder in the vault.
Syntax
FolderGenericEvent_AfterNewFolder(Batch, Action)
| Name | Description |
|---|---|
|
Batch |
An object that represents the batch of documents the user has selected. |
|
Action |
Long integer that represents one or more AS_IMPORTTYPE constants. |
BeforeNewFolder Event
Occurs before a user creates a new folder in the vault.
Syntax
FolderGenericEvent_BeforeNewFolder(Batch, Action)
| Name | Description |
|---|---|
|
Batch |
An object that represents the batch of documents the user has selected. |
|
Action |
Long integer that represents one or more AS_IMPORTTYPE constants. |
*ChangeFolder Events
Occurs when a user changes the folder type of an existing folder.
Syntax
FolderGenericEvent_*ChangeFolder(Batch)
| Name | Description |
|---|---|
|
Batch |
An object that represents the batch of documents the user has selected. |
|
NewType |
A string that contains the name of the new folder type selected by the user. Passed only to the BeforeChangeFolder event. |
|
OldType |
A string that contains the name of the original folder type of the folder. Passed only to the AfterChangeFolder event. |
FileUploaded Event
Occurs when a file is uploaded, but before a document is created or updated.
Syntax
FolderGenericEvent_FileUploaded (Batch, FileName As String, FilePath As String, CancelDefault as Boolean)
| Name | Description |
|---|---|
| Batch | The current batch object. |
| FileName | The display name of the uploaded file. |
| FilePath | The local path of the uploaded file on the server PC. |
|
CancelDefault |
If set to True, the event is canceled. If set to False, the event is not canceled. |
