Interface GridControl

Interface for a CRM grid control.

See

Control

Hierarchy

Implemented by

Methods

addOnLoad getContextType getControlType getEntityName getFetchXml getGrid getLabel getName getParent getRelationship getUrl getViewSelector getVisible openRelatedGrid refresh refreshRibbon removeOnLoad setLabel setVisible

Methods

addOnLoad

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

    Parameters

    Returns void

getContextType

  • This method returns context information about the GridControl.

    Returns GridControlContext

    The context type.

getControlType

  • 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

  • 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

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

    Returns string

    The FetchXML query.

getGrid

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

    Returns Xrm.Controls.Grid

    The Grid object.

getLabel

  • Gets the label.

    Returns string

    The label.

getName

  • 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

getRelationship

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

    Returns GridRelationship

    A relationship object.

getUrl

  • 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

  • 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

  • Gets the visibility state.

    Returns boolean

    true if the tab is visible, otherwise false.

openRelatedGrid

  • 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

  • Refreshes the sub grid.

    Returns void

    Remarks

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

refreshRibbon

removeOnLoad

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

    Parameters

    • handler: (() => void)

      The handler.

        • (): void

        • Returns void

    Returns void

setLabel

  • Sets the label.

    Parameters

    • label: string

      The label.

    Returns void

setVisible

  • Sets the visibility state.

    Parameters

    • visible: boolean

      true to show, false to hide.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc