Hierarchy

  • Fields

Constructors

Methods

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

    Parameters

    • fields: Field[]

      An array of fields to on which this method should be applied.

    • message: string
    • notificationLevel: "ERROR" | "RECOMMENDATION"
    • uniqueId: string
    • Optional actions: Xrm.Controls.ControlNotificationAction[]

    Returns void

  • Adds a handler or an array of handlers to be called when the attribute's value is changed.

    Parameters

    Returns void

  • Fire all "on change" event handlers.

    Parameters

    • fields: Field[]

      An array of fields to on which this method should be applied.

    Returns void

  • Clears the notification identified by uniqueId.

    Parameters

    • fields: Field[]

      An array of fields to on which this method should be applied.

    • uniqueId: string

      (Optional) Unique identifier.

    Returns void

    true if it succeeds, false if it fails.

    Remarks

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

  • Removes the handler from the "on change" event.

    Parameters

    • fields: Field[]

      An array of fields to on which this method should be applied.

    • handler: ChangeEventHandler

      The handler.

    Returns void

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

    Parameters

    • fields: Field[]

      An array of fields to on which this method should be applied.

    • disabled: boolean

      true to disable, false to enable.

    Returns void

  • Sets a value for a column to determine whether it is valid or invalid with a message

    Parameters

    • fields: Field[]

      An array of fields to on which this method should be applied.

    • isValid: boolean

      Specify false to set the column value to invalid and true to set the value to valid.

    • Optional message: string

      The message to display.

    Returns void

  • Sets a control-local notification message.

    Parameters

    • fields: Field[]

      An array of fields to on which this method should be applied.

    • message: string

      The message.

    • uniqueId: string

      Unique identifier.

    Returns void

    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.

  • Sets the required level.

    Parameters

    • fields: Field[]

      An array of fields to on which this method should be applied.

    • required: boolean

      The requirement level, as either false for "none" or true for "required"

    Returns void

  • Sets the required level.

    Parameters

    • fields: Field[]

      An array of fields to on which this method should be applied.

    • requirementLevel: Xrm.Attributes.RequirementLevel

      The requirement level, as either "none", "required", or "recommended"

    Returns void

  • Sets the submit mode.

    Parameters

    • fields: Field[]

      An array of fields to on which this method should be applied.

    • submitMode: Xrm.SubmitMode

      The submit mode, as either "always", "never", or "dirty".

    Returns void

    Default

    submitMode "dirty"
    

    See

    AttributeRequirementLevel

  • Sets the value.

    Parameters

    • fields: Field[]

      An array of fields to on which this method should be applied.

    • value: any

      The value.

    Returns void

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

  • Sets the visibility state.

    Parameters

    • fields: Field[]

      An array of fields to on which this method should be applied.

    • visible: boolean

      true to show, false to hide.

    Returns void

Generated using TypeDoc