Interface StringAttribute

controls

addOnChange

• addOnChange(handler): void

• Adds a handler to be called when the attribute's value is changed.

  Parameters

  • handler: ChangeEventHandler

    The function reference.

  Returns void

fireOnChange

• fireOnChange(): void

• Fire all "on change" event handlers.

  Returns void

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

• Gets the attribute format.

  Returns Xrm.Attributes.StringAttributeFormat

  The format of the attribute. Values returned are: email, phone, text, textarea, tickersymbol, url

getIsDirty

• getIsDirty(): boolean

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

  Returns boolean

  true if there are unsaved changes, otherwise false.

getMaxLength

• getMaxLength(): number

• Gets maximum length allowed.

  Returns number

  The maximum length allowed.

  Remarks

  The email form's "Description" attribute does not have the this method.

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(): string

• Gets the value.

  Returns string

  The value.

removeOnChange

• removeOnChange(handler): void

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

  Parameters

  • handler: ChangeEventHandler

    The handler.

  Returns void

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)

setRequiredLevel

• setRequiredLevel(requirementLevel): void

• Sets the required level.

  Parameters

  • requirementLevel: Xrm.Attributes.RequirementLevel

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

  Returns void

  See

  AttributeRequirementLevel

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: string

    The value.

  Returns void

  Remarks

  A String field with the email format enforces email address formatting. Attributes on Quick Create Forms will not save values set with this method.