Interface Tab

sections

addTabStateChange

• addTabStateChange(handler): void

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

  Parameters

  • handler: Xrm.Events.ContextSensitiveHandler

    The function to be executed on the TabStateChange event.

  Returns void

getDisplayState

• getDisplayState(): Xrm.DisplayState

• Gets display state of the tab.

  Returns Xrm.DisplayState

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

getName

• getName(): string

• Gets the name of the tab.

  Returns string

  The name.

getParent

• getParent(): Ui

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

  Returns Ui

  The parent.

removeTabStateChange

• removeTabStateChange(handler): void

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

  Parameters

  • handler: Xrm.Events.ContextSensitiveHandler

    The function to be removed from the TabStateChange event.

  Returns void

setDisplayState

• setDisplayState(displayState): 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.