Scripts
    Preparing search index...

    Class DocumentElementAbstract

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    asButton asCalculation asClauseLibrary asContinuousSection asDate asElementGroup asEndnote asFootnote asImage asLink asMoney asNextPageSection asPageNumber asParagraph asQrCode asQuestion asRichText asSelect asSwitcher asTable asTableCell asTableColumn asTableOfContents asTableRow asText asTextInput asTitle getDocument getElementType getId getParagraphLevel getParentElement getParentParagraph getSystemName getTags getValue hasTag isRepeated isVisible setValue

    Methods

    • Returns the current element typed as a Button Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns ButtonElement

      Current element typed as a Button Element

    • Returns the current element typed as a Calculation Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns CalculationElement

      Current element typed as a Calculation Element

    • Returns the current element typed as a Clause Library Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns ClauseLibraryElement

      Current element typed as a Clause Library Element

    • Returns the current element typed as a Date Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns DateElement

      Current element typed as a Date Element

    • Returns the current element typed as a Element Group. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns ElementGroup

      Current element typed as a Element Group

    • Returns the current element typed as a Endnote Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns EndnoteElement

      Current element typed as a Endnote Element

    • Returns the current element typed as a Footnote Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns FootnoteElement

      Current element typed as a Footnote Element

    • Returns the current element typed as a Image Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns ImageElement

      Current element typed as a Image Element

    • Returns the current element typed as a Link Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns LinkElement

      Current element typed as a Link Element

    • Returns the current element typed as a Money Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns MoneyElement

      Current element typed as a Money Element

    • Returns the current element typed as a Next Page Section Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns NextPageSectionElement

      Current element typed as a Next Page Section Element

    • Returns the current element typed as a Page Number Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns PageNumberElement

      Current element typed as a Page Number Element

    • Returns the current element typed as a Qr Code Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns QrCodeElement

      Current element typed as a Qr Code Element

    • Returns the current element typed as a Question Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns QuestionElement

      Current element typed as a Question Element

    • Returns the current element typed as a Rich Text Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns RichTextElement

      Current element typed as a Rich Text Element

    • Returns the current element typed as a Select Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns SelectElement

      Current element typed as a Select Element

    • Returns the current element typed as a Switcher Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns SwitcherElement

      Current element typed as a Switcher Element

    • Returns the current element typed as a Table Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns TableElement

      Current element typed as a Table Element

    • Returns the current element typed as a TableCell Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns TableCellElement

      Current element typed as a TableCell Element

    • Returns the current element typed as a TableColumn Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns TableColumnElement

      Current element typed as a TableColumn Element

    • Returns the current element typed as a TableRow Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns TableRowElement

      Current element typed as a TableRow Element

    • Returns the current element typed as a Text Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns TextElement

      Current element typed as a Text Element

    • Returns the current element typed as a Text Input Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns TextInputElement

      Current element typed as a Text Input Element

    • Returns the current element typed as a Title Element. Use this method to allow specific element auto-complete whenever a given element is known to be of a specific type.

      Returns TitleElement

      Current element typed as a Title Element

    • Returns document in which the element is located.

      Returns Document

      Document in which the element is located.

    • Returns type of the element.

      Returns string

      Type of the element as string.

    • Returns id of the element.

      Returns string

      Id of the element.

    • Returns depth of the element.

      Returns number

      Depth of the element.

    • Returns parent paragraph of the element. The paragraph doesn't have to be direct parent of the element.

      Returns ParagraphElement

      Parent paragraph of the element, or null if this element has no parent.

    • Returns system name of the element.

      Returns string

      System name of the element.

    • Returns array of tags of the element.

      Returns Tag[]

      Array of tags of the element.

    • Returns value of the element.

      Returns any

      Value of the element.

    • Checks if the element has specified tag.

      Parameters

      • tag: Tag

        Tag that is checked.

      Returns boolean

      True if element has specified tag, false otherwise.

    • Checks if the element is repeated.

      Returns boolean

      True if element is repeated, false otherwise.

    • Checks if the element is visible.

      Returns boolean

      True if element is visible, false otherwise.

    • Sets value of the element.

      Parameters

      • Optionalvalue: any

        Value to be set to the element.

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods