Class Tab<Sections>

constructor

• new Tab<Sections>(name, section?): XrmEx.Class.Tab<Sections>

• Type Parameters

  • Sections extends TabSections

  Parameters

  • name: string

  • Optional section: Sections

  Returns XrmEx.Class.Tab<Sections>

Readonly Name

Section

Tab

• get Tab(): Xrm.Controls.Tab

• Returns Xrm.Controls.Tab

sections

• get sections(): ItemCollection<Xrm.Controls.Section>

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

  Returns ItemCollection<Xrm.Controls.Section>

  See

  External Link: Collections (Client API reference)

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"

getLabel

• getLabel(): string

• Gets the label.

  Returns string

  The label.

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.

getVisible

• getVisible(): boolean

• Gets the visibility state.

  Returns boolean

  true if the tab is visible, otherwise false.

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.

setFocus

• setFocus(): void

• Sets focus on the element.

  Returns void

setLabel

• setLabel(label): void

• Sets the label.

  Parameters

  • label: string

    The label.

  Returns void

setVisible

• setVisible(visible): void

• Sets the visibility state.

  Parameters

  • visible: boolean

    true to show, false to hide.

  Returns void