Interface for a CRM grid control.

See

Control

Hierarchy

  • GridControl

Implements

Constructors

Properties

Name: string
_gridControl?: Xrm.Controls.GridControl

Accessors

Methods

  • 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).
  • 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.

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

    Returns string

    The FetchXML query.

  • 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_.

  • 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.

  • Displays the associated grid for the grid.

    Returns void

    Remarks

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

  • Refreshes the sub grid.

    Returns void

    Remarks

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

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

    Parameters

    • handler: (() => void)

      The handler.

        • (): void
        • Returns void

    Returns void

  • Sets the visibility state.

    Parameters

    • visible: boolean

      true to show, false to hide.

    Returns void

Generated using TypeDoc