Interface StringAttribute

Interface for a String attribute.

Index

Properties

controls

Methods

addOnChange fireOnChange getAttributeType getFormat getIsDirty getMaxLength getName getParent getRequiredLevel getSubmitMode getUserPrivilege getValue removeOnChange setIsValid setRequiredLevel setSubmitMode setValue

Properties

controls

controls: ItemCollection<Xrm.Controls.StringControl>

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

See

External Link: Collections (Client API reference)

Methods

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
Inherited from Attribute.addOnChange
- Defined in node_modules/@types/xrm/index.d.ts:2606

fireOnChange

fireOnChange(): void
Fire all "on change" event handlers.

Returns void
Inherited from Attribute.fireOnChange
- Defined in node_modules/@types/xrm/index.d.ts:2611

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
Inherited from Attribute.getAttributeType
- Defined in node_modules/@types/xrm/index.d.ts:2628

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
Overrides Attribute.getFormat
- Defined in node_modules/@types/xrm/index.d.ts:2790

getIsDirty

getIsDirty(): boolean
Gets a boolean value indicating whether this Attribute has unsaved changes.

Returns boolean
true if there are unsaved changes, otherwise false.
Inherited from Attribute.getIsDirty
- Defined in node_modules/@types/xrm/index.d.ts:2654

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.
- Defined in node_modules/@types/xrm/index.d.ts:2797

getName

getName(): string
Gets the logical name of the attribute.

Returns string
The logical name.
Inherited from Attribute.getName
- Defined in node_modules/@types/xrm/index.d.ts:2660

getParent

getParent(): Xrm.Entity
Gets a reference to the record context of this attribute.

Returns Xrm.Entity
The parent record context.
Inherited from Attribute.getParent
- Defined in node_modules/@types/xrm/index.d.ts:2666

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"
Inherited from Attribute.getRequiredLevel
- Defined in node_modules/@types/xrm/index.d.ts:2672

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"
Inherited from Attribute.getSubmitMode
- Defined in node_modules/@types/xrm/index.d.ts:2679

getUserPrivilege

getUserPrivilege(): Xrm.Privilege
Gets the current user's privileges for the attribute.

Returns Xrm.Privilege
The user privileges.
Inherited from Attribute.getUserPrivilege
- Defined in node_modules/@types/xrm/index.d.ts:2685

getValue

getValue(): string
Gets the value.

Returns string
The value.
Inherited from Attribute.getValue
- Defined in node_modules/@types/xrm/index.d.ts:2718

removeOnChange

removeOnChange(handler): void
Removes the handler from the "on change" event.
Parameters
- handler: ChangeEventHandler
  
  The handler.
Returns void
Inherited from Attribute.removeOnChange
- Defined in node_modules/@types/xrm/index.d.ts:2691

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)
Inherited from Attribute.setIsValid
- Defined in node_modules/@types/xrm/index.d.ts:2733

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
Inherited from Attribute.setRequiredLevel
- Defined in node_modules/@types/xrm/index.d.ts:2698

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"
```
See
AttributeRequirementLevel
Inherited from Attribute.setSubmitMode
- Defined in node_modules/@types/xrm/index.d.ts:2706

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.
Overrides Attribute.setValue
- Defined in node_modules/@types/xrm/index.d.ts:2806

Interface StringAttribute

See

Hierarchy

Implemented by

Index

Properties

Methods

Properties

controls

See

Methods

addOnChange

Parameters

handler: ChangeEventHandler

Returns void

fireOnChange

Returns void

getAttributeType

Returns Xrm.Attributes.AttributeType

getFormat

Returns Xrm.Attributes.StringAttributeFormat

getIsDirty

Returns boolean

getMaxLength

Returns number

Remarks

getName

Returns string

getParent

Returns Xrm.Entity

getRequiredLevel

Returns Xrm.Attributes.RequirementLevel

getSubmitMode

Returns Xrm.SubmitMode

Remarks

getUserPrivilege

Returns Xrm.Privilege

getValue

Returns string

removeOnChange

Parameters

handler: ChangeEventHandler

Returns void

setIsValid

Parameters

isValid: boolean

Optional message: string

Returns void

See

setRequiredLevel

Parameters

requirementLevel: Xrm.Attributes.RequirementLevel

Returns void

See

setSubmitMode

Parameters

submitMode: Xrm.SubmitMode

Returns void

Default

See

setValue

Parameters

value: string

Returns void

Remarks

Settings

Member Visibility

Theme

On This Page

`Optional` message: string