Interface for a form tab.

See

Hierarchy

Implemented by

Properties

A reference to the collection of form sections within this tab.

Methods

  • Adds a function to be called when the TabStateChange event occurs.

    Parameters

    Returns void

  • Gets display state of the tab.

    Returns Xrm.DisplayState

    The display state, as either "expanded" or "collapsed"

  • Gets the label.

    Returns string

    The label.

  • Gets the name of the tab.

    Returns string

    The name.

  • Gets a reference to the formContext.ui parent of the tab.

    Returns Ui

    The parent.

  • Gets the visibility state.

    Returns boolean

    true if the tab is visible, otherwise false.

  • Removes a function to be called when the TabStateChange event occurs.

    Parameters

    Returns void

  • Sets display state of the tab.

    Parameters

    • displayState: Xrm.DisplayState

      Display state of the tab, as either "expanded" or "collapsed"

    Returns void

    Deprecated

    Deprecated in the 2021 release wave 1 (April 2021). Use the setFocus method in Unified Interface to ensure the correct tab is opened on a form.

  • Sets focus on the element.

    Returns void

  • Sets the label.

    Parameters

    • label: string

      The label.

    Returns void

  • Sets the visibility state.

    Parameters

    • visible: boolean

      true to show, false to hide.

    Returns void

Generated using TypeDoc