Interface: IDocumentActionCollection

Document-level actions available at the top of the document viewer

Methods

addDocumentAction()

addDocumentAction(docAction, section, subsection): any

Parameters

docAction: IDocumentActionControl

Document Action Control to add to the collection

section: string

String representing the section of the collection

subsection: string

String representing the subsection of the collection

Returns

any


createDocumentAction()

createDocumentAction(section, subsection, id, title, classStr, icon, action, validate, qpUpdate, options?): IDocumentActionControl

Parameters

section: string

subsection: string

id: string

title: string

classStr: string

icon: string

action

validate

qpUpdate

options?: ICreateDocumentActionOptions

Returns

IDocumentActionControl


disable()

disable(): Promise<void>

Disables the toolbar control and all associated document actions.

Returns

Promise<void>


enable()

enable(): Promise<void>

Enables the toolbar control and all associated document actions.

Returns

Promise<void>


getDocumentAction()

getDocumentAction(title, section, subsection): IDocumentActionControl

Parameters

title: string

Title of the target Document Action

section: string

String representing the section of the collection

subsection: string

String representing the subsection of the collection

Returns

IDocumentActionControl


removeDocumentAction()

removeDocumentAction(docAction, section, subsection): boolean

Parameters

docAction: IDocumentActionControl

Document Action object to be removed

section: string

String representing the section of the collection

subsection: string

String representing the subsection of the collection

Returns

boolean