Show/Hide Toolbars

Therefore Programming Interface 3.0

Application Events

Name

Description

InitApplication

Occurs when an application is started. Always the first event to be triggered.

ExitApplication

Occurs when an application is closed. Always the last event to be triggered.

 

Category Dialog Events - Mouse Events

Name

Description

CategoryFieldLeftMouseDown

Occurs when the left mouse button is pressed on a field in the category dialog.

CategoryFieldLeftMouseUp

Occurs when the left mouse button is released on a field in the category dialog.

CategoryFieldLeftDoubleClick

Occurs when the left mouse button is double-clicked on a field in the category dialog.

CategoryFieldRightMouseDown

Occurs when the right mouse button is pressed on a field in the category dialog.

CategoryFieldRightMouseUp

Occurs when the right mouse button is released on a field in the category dialog.

CategoryFieldRightDoubleClick

Occurs when the right mouse button is double-clicked on a field in the category dialog.

CategoryFieldMiddleMouseDown

Occurs when the middle mouse button is pressed on a field in the category dialog.

CategoryFieldMiddleMouseUp

Occurs when the middle mouse button is released on a field in the category dialog.

CategoryFieldMiddleDoubleClick

Occurs when the middle mouse button is double-clicked on a field in the category dialog.

Category Dialog Events - Field Events

Name

Description

CategoryFieldVerify

Occurs when the category field is being verified.

CategoryFieldGotFocus

Occurs when the category gets the focus.

CategoryFieldLostFocus

Occurs when the category loses the focus.

CategoryFieldChanged

Occurs when a field value in the category dialog has been changed by the user.

CategoryFieldShowKeywordList

Occurs when a combo box shows the possible values.

Category Dialog Events - Dialog Events

Name

Description

CreateCategoryDialog

Occurs when a the category dialog has been created.

ShowCategoryDialog

Occurs when a the category dialog is being displayed.

ValidateCategoryDialog

Occurs when the category field values are being validated.

HideCategoryDialog

Occurs when a the category dialog is being hidden.

DestroyCategoryDialog

Occurs when a the category dialog is being destroyed.

CategoryDialogSetValues

Occurs when the index data values in the category are initialized.

CategoryFieldTableRowInserted

Occurs when a new row has been inserted into a table field.

CategoryFieldTableRowDelete

Occurs when a row in a table field is about to be deleted.

Category Dialog Events - Other

Name

Description

CategoryDialogButtonClick


IndexDataInitialized


VerifyIndexData


QueryFinished

Occurs when a query has been completed.

 

Document Events

Document events always exist in pairs of Before Event and After Event.

 

Before Events

Always occurs before the actual action and skips the action if the return code is greater then zero.

 

After Events

Occurs when the action has been completed successfully and ignores a possible return code.

 

Before Event

After Event

Description

NewDocument

DocumentCreated

Occurs before/after a new document is created.

OpenDocument

DocumentOpened

Occurs before/after a document is opened.

CloseDocument

DocumentClosed

Occurs before/after a document is closed.

ShowHistory

DocumentHistoryShowing

Occurs before/after the document history is being shown.

ShowSecurity

DocumentSecurityShowing

Occurs before/after the security settings are being shown.

RetrieveDocument

DocumentRetrieved

Occurs before/after a document is retrieved.

DeleteDocument

DocumentDeleted

Occurs before/after a document is deleted.

PrintDocument

DocumentPrinted

Occurs before/after a document is printed.

ExportDocument

DocumentExported

Occurs before/after a document is exported.

EditDocument

DocumentEdited

Occurs before/after a document is edited.

CheckOut

DocumentCheckedOut

Occurs before/after a document is checked out.

CheckIn

DocumentCheckedIn

Occurs before/after a document is checked in.

UndoCheckOut

DocumentCheckOutUndone

Occurs before/after a document checkout is reverted.

SaveDocument

DocumentSaved

Occurs before/after a document is saved.

MoveDocument

DocumentMoved

Occurs before/after a document is moved.

AddPageToDocument

DocumentPageAdded

Occurs before/after a page is added to a document.

RemovePageFromDocument

DocumentPageRemoved

Occurs before/after a page is removed from a document.

 

 

 


 

 


 

 


 

 

Menu Events - Main Menu

Name

Description

InitMenu

Occurs when the main menu is initialized. Use this event to add custom menu entries and corresponding toolbar buttons.

UpdateMenu

Occurs when the menu is updated (e.g. when the selection changes). Use this event to enable/disable menu entries based on selection and system state.

MenuClick

Occurs when a custom menu is clicked.

 

Menu Events - Context Menu (Navigator)

Name

Description

InitContextMenu

Occurs when the context menu is created and displayed.

UpdateContextMenu

Currently not used because the context menu is dynamically recreated every time it is needed.

ContextMenuClick

Occurs when a custom context menu item is clicked.

 

Workflow Events

Name

Description

OpenWorkflowInstance

Occurs when the workflow instance dialog is about to be opened.

ClaimWorkflowInstance

Occurs when a workflow instance is claimed.

UnclaimWorkflowInstance

Occurs when a workflow instance is unclaimed.

© 2023 Therefore Corporation, all rights reserved.