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

Article
07/27/2016

Applies To: Dynamics CRM 2015

A section contains methods to manage how it appears as well as accessing the tab that contains the section.

Properties and Methods

controls
A collection of controls in the section.
getName
Method to return the name of the section.
getParent
Method to return the tab containing the section.
Label
Use the getLabel and setLabel methods to retrieve or change the label for the section.
Visible
Use the getVisible and setVisible methods to check whether the section is visible or hide and show the section.

controls

The section controls collection provides access to the controls within a section. See Collections (client-side reference) for information about the methods exposed by collections. See Xrm.Page.ui control (client-side reference) for information about the properties and methods exposed by the objects in this collection.

getName

Method to return the name of the section.

sectionObj.getName()

Return Value
Type: String

getParent

Method to return the tab containing the section.

sectionObj.getParent()

Return Value
Type: Object

Label

Use the getLabel and setLabel methods to retrieve or change the label for the section.

getLabel

Returns the label for the section.

sectionObj.getLabel()

Return Value
Type: String

setLabel

Sets the label for the section.

sectionObj.setLabel(
string
)

Arguments
String: The label text to set.

Visible

Use the getVisible and setVisible methods to check whether the section is visible or hide and show the section.

getVisible

Returns true if the section is visible, otherwise returns false.

sectionObj.getVisible()

Return Value
Type: Boolean

setVisible

Sets a value to show or hide the section.

sectionObj.setVisible(
Boolean
)

Arguments
Boolean