Interface StandardControl

Interface for a standard control.

See

Control

Hierarchy

Methods

addNotification addOnOutputChange clearNotification getAttribute getControlType getDisabled getLabel getName getOutputs getParent getVisible removeOnOutputChange setDisabled setFocus setLabel setNotification setVisible

Methods

addNotification

  • Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    Parameters

    Returns void

addOnOutputChange

  • Adds an event handler to the OnOutputChange event.

    Parameters

    Returns void

clearNotification

  • Clears the notification identified by uniqueId.

    Parameters

    • Optional uniqueId: string

      (Optional) Unique identifier.

    Returns boolean

    true if it succeeds, false if it fails.

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

getAttribute

  • Gets the control's bound attribute.

    Type Parameters

    Returns T

    The attribute.

  • Gets the control's bound attribute.

    Returns Xrm.Attributes.Attribute<any>

    The attribute.

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

getDisabled

  • Gets a boolean value, indicating whether the control is disabled.

    Returns boolean

    true if it is disabled, otherwise false.

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

getOutputs

  • Returns a dictionary of the output properties of the control.

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

getParent

getVisible

  • Gets the visibility state.

    Returns boolean

    true if the tab is visible, otherwise false.

removeOnOutputChange

  • Removes an event handler from the OnOutputChange event.

    Parameters

    Returns void

setDisabled

  • Sets the state of the control to either enabled, or disabled.

    Parameters

    • disabled: boolean

      true to disable, false to enable.

    Returns void

setFocus

  • Sets focus on the element.

    Returns void

setLabel

  • Sets the label.

    Parameters

    • label: string

      The label.

    Returns void

setNotification

  • Sets a control-local notification message.

    Parameters

    • message: string

      The message.

    • uniqueId: string

      Unique identifier.

    Returns boolean

    true if it succeeds, false if it fails.

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon appears next to the control. Tapping on the icon will display the message.

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