Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDocumentActionCollection

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

Hierarchy

  • IDocumentActionCollection

Index

Methods

Methods

addDocumentAction

  • 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: string, subsection: string, id: string, title: string, classStr: string, icon: string, action: function, validate: function, qpUpdate: function): 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

  • 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

  • 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