AuthoritEventArgs - Cloud - Author-it

Development Documentation

AuthoritEventArgs are used to send information about the current state of Author-it to a plug-in.

AuthoritEventArgs have the following properties:

LibraryPath

String. The filename and path of the currently open library. Jet only.

SqlServername

String. The name of the server that contains the library. SQL Server only.

SqlDatabase

String. The name of the database that contains the library. SQL Server only.

SqlUsername

String. The username used to connect to the SQL server. Will be blank for trusted connection. SQL Server only.

SqlPassword

String. The password used to connect to the SQL server. SQL Server only.

Username

String. The name of the user currently logged in to the Author-it library.

Password

String. The password of the user currently logged in to the Author-it library.

CurrentFolderId

Integer. The folder ID of the currently selected folder in the Author-it library.

CurrentBookId

Integer. The object ID of the book currently open in the book editor.

CurrentTopicId

Integer. The object ID of the topic currently open in the book editor.

SelectedObjectIDs

List of integers. The object IDs of the currently selected objects in the object list or book tree.

SelectedText

String. The text that is currently selected in the book editor.

Cancel

Boolean. With event triggered plug-ins, for Before... events, the plug-in may set this to true to cancel the following event.

SelectedObjectID

Integer. The ID of the object that is currently selected in the object list.

SelectedObjectType

Integer. The type of the object that is currently selected in the object list. (Enum ObjectType).

SelectedObjectBasedOnID

Integer. The based on ID of the object that is currently selected in the object list.

SelectedObjectIsLocked

Boolean. True if the object currently selected in the object list is locked.

SelectedObjectXML

String. The xml representation of the object that is currently open in an object properties form.

TargetReleaseStateID

Integer. The ID of the release state that is being applied to the selected object(s).

TargetTemplateID

Integer. The ID of the template that is being applied to the selected object(s).

PublishProfileID

Integer. The ID of the publish profile object that is being used by the current publish job.

CurrentFolderPath

String. The full path of the currently selected folder.