Class Field

constructor

• new Field(attributeName): Field

• Parameters

  • attributeName: string

  Returns Field

Readonly Name

Static allFields

Attribute

• get Attribute(): Xrm.Attributes.Attribute<any>

• Returns Xrm.Attributes.Attribute<any>

Value

• get Value(): any

• Gets the value.

  Returns any

  The value.
• set Value(value): void

• Parameters

  • value: any

  Returns void

controls

• get controls(): ItemCollection<Xrm.Controls.StandardControl>

• A collection of all the controls on the form that interface with this attribute.

  Returns ItemCollection<Xrm.Controls.StandardControl>

  See

  External Link: Collections (Client API reference)

addNotification

• addNotification(message, notificationLevel, uniqueId, actions?): Field

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

  Parameters

  • message: string

  • notificationLevel: "ERROR" | "RECOMMENDATION"

  • uniqueId: string

  • Optional actions: Xrm.Controls.ControlNotificationAction[]

  Returns Field

addOnChange

• addOnChange(handlers): Field

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

  Parameters

  • handlers: Xrm.Events.ContextSensitiveHandler | Xrm.Events.ContextSensitiveHandler[]

    The function reference or an array of function references.

  Returns Field

fireOnChange

• fireOnChange(): Field

• Fire all "on change" event handlers.

  Returns Field

getAttributeType

• getAttributeType(): Xrm.Attributes.AttributeType

• Gets attribute type.

  Returns Xrm.Attributes.AttributeType

  The attribute's type name.
  
  Values returned are:

  • boolean
  • datetime
  • decimal
  • double
  • integer
  • lookup
  • memo
  • money
  • optionset
  • string

getFormat

• getFormat(): Xrm.Attributes.AttributeFormat

• Gets the attribute format.

  Returns Xrm.Attributes.AttributeFormat

  The format of the attribute.
  
  Values returned are:

  • date (datetime)
  • datetime (datetime)
  • duration (integer)
  • email (string)
  • language (optionset)
  • none (integer)
  • phone (string)
  • text (string)
  • textarea (string)
  • tickersymbol (string)
  • timezone (optionset)
  • url (string)

  See

  getAttributeType

getIsDirty

• getIsDirty(): boolean

• Gets a boolean value indicating whether this Attribute has unsaved changes.

  Returns boolean

  true if there are unsaved changes, otherwise false.

getName

• getName(): string

• Gets the logical name of the attribute.

  Returns string

  The logical name.

getParent

• getParent(): Xrm.Entity

• Gets a reference to the record context of this attribute.

  Returns Xrm.Entity

  The parent record context.

getRequiredLevel

• getRequiredLevel(): Xrm.Attributes.RequirementLevel

• Gets the current level of requirement for the attribute.

  Returns Xrm.Attributes.RequirementLevel

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

getSubmitMode

• getSubmitMode(): Xrm.SubmitMode

• Gets current submit mode for the attribute.

  Returns Xrm.SubmitMode

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

  Remarks

  The default value is "dirty"

getUserPrivilege

• getUserPrivilege(): Xrm.Privilege

• Gets the current user's privileges for the attribute.

  Returns Xrm.Privilege

  The user privileges.

getValue

• getValue(): any

• Gets the value.

  Returns any

  The value.

removeNotification

• removeNotification(uniqueId): Field

• Clears the notification identified by uniqueId.

  Parameters

  • uniqueId: string

    (Optional) Unique identifier.

  Returns Field

  true if it succeeds, false if it fails.

  Remarks

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

removeOnChange

• removeOnChange(handler): void

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

  Parameters

  • handler: ChangeEventHandler

    The handler.

  Returns void

setDisabled

• setDisabled(disabled): Field

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

  Parameters

  • disabled: boolean

    true to disable, false to enable.

  Returns Field

setIsValid

• setIsValid(isValid, message?): void

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

  Parameters

  • 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

  See

  External Link: setIsValid (Client API reference)

setNotification

• setNotification(message, uniqueId): Field

• Sets a control-local notification message.

  Parameters

  • message: string

    The message.

  • uniqueId: string

    Unique identifier.

  Returns Field

  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.

setRequired

• setRequired(required): Field

• Sets the required level.

  Parameters

  • required: boolean

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

  Returns Field

setRequiredLevel

• setRequiredLevel(requirementLevel): Field

• Sets the required level.

  Parameters

  • requirementLevel: Xrm.Attributes.RequirementLevel

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

  Returns Field

setSubmitMode

• setSubmitMode(submitMode): void

• Sets the submit mode.

  Parameters

  • submitMode: Xrm.SubmitMode

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

  Returns void

  Default

  submitMode "dirty"
  Copy

  See

  AttributeRequirementLevel

setValue

• setValue(value): void

• Sets the value.

  Parameters

  • value: any

    The value.

  Returns void

  Remarks

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

setVisible

• setVisible(visible): Field

• Sets the visibility state.

  Parameters

  • visible: boolean

    true to show, false to hide.

  Returns Field