Class GridControl

constructor

• new GridControl(name): XrmEx.Class.GridControl

• Parameters

  • name: string

  Returns XrmEx.Class.GridControl

Readonly Name

Grid

• get Grid(): Xrm.Controls.Grid

• Returns Xrm.Controls.Grid

GridControl

• get GridControl(): Xrm.Controls.GridControl

• Returns Xrm.Controls.GridControl

addOnLoad

• addOnLoad(handler): void

• Use this method to add event handlers to the GridControl's OnLoad event.

  Parameters

  • handler: Xrm.Events.GridControl.LoadEventHandler

    The event handler.

  Returns void

getContextType

• getContextType(): GridControlContext

• This method returns context information about the GridControl.

  Returns GridControlContext

  The context type.

getControlType

• getControlType(): string

• Gets the controls type.

  Returns string

  The control type.
  
  Values returned are:

  • standard
  • iframe
  • lookup
  • optionset
  • subgrid
  • webresource
  • notes
  • timercontrol
  • kbsearch
  • quickform (see ui.QuickForm)
  • customcontrol: . (A custom control for mobile phone and tablet clients).
  • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).

getEntityName

• getEntityName(): string

• Gets the logical name of the table data displayed in the grid.

  Returns string

  The logical name of the table data displayed in the grid.

getFetchXml

• getFetchXml(): string

• Gets the FetchXML query that represents the current data, including filtered and sorted data, in the grid control.

  Returns string

  The FetchXML query.

getGrid

• getGrid(): Xrm.Controls.Grid

• Get access to the Grid available in the GridControl (gridContext).

  Returns Xrm.Controls.Grid

  The Grid object.

getLabel

• getLabel(): string

• Gets the label.

  Returns string

  The label.

getName

• getName(): string

• Gets the name of the control on the form.

  Returns string

  The name of the control.

  Remarks

  The name assigned to a control is not determined until the form loads. Changes to the form may change the name assigned to a given control. When you use the control getName method the name of the first control will be the same as the name of the attribute. The second instance of a control for that attribute will be "1". The pattern +N will continue for each additional control added to the form for a specific attribute. When a form displays a business process flow control in the header, additional controls will be added for each attribute that is displayed in the business process flow. These controls have a unique name like the following: header_process_.

getParent

• getParent(): Xrm.Controls.Section

• Gets a reference to the Section parent of the control.

  Returns Xrm.Controls.Section

  The parent Section.

getRelationship

• getRelationship(): GridRelationship

• Gets information about the relationship used to filter the subgrid.

  Returns GridRelationship

  A relationship object.

getUrl

• getUrl(client?): string

• Gets the URL of the current grid control.

  Parameters

  • Optional client: GridClient

    Indicates the client type.

  Returns string

  Gets the URL of the current grid control.

getViewSelector

• getViewSelector(): Xrm.Controls.ViewSelector

• Use this method to get access to the ViewSelector available for the GridControl when it is configured to display views.

  Returns Xrm.Controls.ViewSelector

  The view selector.

getVisible

• getVisible(): boolean

• Gets the visibility state.

  Returns boolean

  true if the tab is visible, otherwise false.

openRelatedGrid

• openRelatedGrid(): void

• Displays the associated grid for the grid.

  Returns void

  Remarks

  This method does nothing if the grid is not filtered based on a relationship.

refresh

• refresh(): void

• Refreshes the sub grid.

  Returns void

  Remarks

  Not available during the "on load" event of the form.

refreshRibbon

• refreshRibbon(): void

• Refreshes the sub grid ribbon.

  Returns void

  See

  External Link: refreshRibbon (Client API reference)

removeOnLoad

• removeOnLoad(handler): void

• Use this method to remove event handlers from the GridControl's OnLoad event.

  Parameters

  • handler: (() => void)

    The handler.

    • • (): void

      • Returns void

  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