Xrm.Page.ui.process (client-side reference)

Article
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

With Microsoft Dynamics 365 (online & on-premises), the Xrm.Page.ui.process namespace provides methods to interact with the business process flow control in a form.

Xrm.Page.ui.process methods

DisplayState
Use setDisplayState to expand or collapse the business process control. Use getDisplayState to retrieve the display state for the business process control.
Visible
Use setVisible to show or hide the business process control. Use getVisible to retrieve whether the business process control is visible.

DisplayState

Use setDisplayState to expand or collapse the business process control. Use getDisplayState to retrieve the display state for the business process control.

getDisplayState

Use this method to retrieve the display state for the business process control.

Xrm.Page.ui.process.getDisplayState();

Return value
Type:String

Returns “expanded” when the control is expanded, “collapsed” when the control is collapsed.

setDisplayState

Use this method to expand or collapse the business process flow control.

Xrm.Page.ui.process.setDisplayState(strExpanded);

Parameter
Type:String

Use “expanded” to expand the control, “collapsed” to collapse it.

Visible

Use setVisible to show or hide the business process control. Use getVisible to retrieve whether the business process control is visible.

Xrm.Page.ui.process.getVisible();

Return value
Type:Boolean

Returns true when the control is visible; otherwise, false.

getVisible

Use this method to retrieve whether the business process control is visible.

setVisible

Use this method to show or hide the business process flow control.

Xrm.Page.ui.process.setVisible(boolVisible);

Parameter
Type:Boolean

Use true to show the control; otherwise, false.