Interface ProcessControl

Interface for UI elements which can have the visibility value read.

Hierarchy

Xrm.Controls.UiCanGetVisibleElement
Xrm.Controls.UiCanSetVisibleElement
- ProcessControl
  - Xrm.Page.ui.ProcessManager

Index

Methods

getDisplayState getVisible reflow setDisplayState setVisible

Methods

getDisplayState

getDisplayState(): Xrm.DisplayState
Gets the display state of the process flow control.

Returns Xrm.DisplayState
- Defined in node_modules/@types/xrm/index.d.ts:4383

getVisible

getVisible(): boolean
Gets the visibility state.

Returns boolean
true if the tab is visible, otherwise false.
Inherited from UiCanGetVisibleElement.getVisible
- Defined in node_modules/@types/xrm/index.d.ts:3100

reflow

reflow(updateUI, parentStage, nextStage): void
Reflow the UI of the process control
Parameters
- updateUI: boolean
  
  Specify true to update the UI of the process control; false otherwise.
- parentStage: string
  
  ID of the parent stage.
- nextStage: string
  
  ID of the next stage.
Returns void
- Defined in node_modules/@types/xrm/index.d.ts:4391

setDisplayState

setDisplayState(displayState): void
Sets display state of the process flow control.
Parameters
- displayState: Xrm.DisplayState
  
  Display state of the process flow control, as either "expanded" or "collapsed"
Returns void
- Defined in node_modules/@types/xrm/index.d.ts:4378

setVisible

setVisible(visible): void
Sets the visibility state.
Parameters
- visible: boolean
  
  true to show, false to hide.
Returns void
Inherited from UiCanSetVisibleElement.setVisible
- Defined in node_modules/@types/xrm/index.d.ts:3111

Generated using TypeDoc