Interface OptionSetAttribute<T>

Interface an OptionSet attribute.

See

EnumAttribute

Type Parameters

T extends number = number

Hierarchy

Xrm.Attributes.EnumAttribute<T>
- OptionSetAttribute
  - Xrm.Page.OptionSetAttribute

Implemented by

OptionsetField

Properties

controls

controls: ItemCollection<Xrm.Controls.OptionSetControl>

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

fireOnChange

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

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

getFormat

getFormat(): Xrm.Attributes.OptionSetAttributeFormat
Gets the attribute format.

Returns Xrm.Attributes.OptionSetAttributeFormat
The format of the attribute. Values returned are: language, timezone
Overrides EnumAttribute.getFormat
- Defined in node_modules/@types/xrm/index.d.ts:2878

getInitialValue

getInitialValue(): T
Gets the initial value of the attribute.

Returns T
The initial value.

Remarks
Valid for OptionSet and boolean attribute types

See
External Link: getInitialValue (Client API reference)
Inherited from EnumAttribute.getInitialValue
- Defined in node_modules/@types/xrm/index.d.ts:2826

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

getName

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

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

getOption

getOption(value): Xrm.OptionSetValue
Gets the option matching a value.
Parameters
- value: number
  
  The enumeration value of the option desired.
Returns Xrm.OptionSetValue
The option.
- Defined in node_modules/@types/xrm/index.d.ts:2885
getOption(label): Xrm.OptionSetValue
Gets the option matching a label.
Parameters
- label: string
  
  The label of the option desired.
Returns Xrm.OptionSetValue
The option.
- Defined in node_modules/@types/xrm/index.d.ts:2892

getOptions

getOptions(): Xrm.OptionSetValue[]
Gets all of the options.

Returns Xrm.OptionSetValue[]
An array of options.
- Defined in node_modules/@types/xrm/index.d.ts:2898

getParent

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

Returns Xrm.Entity
The parent record context.
Inherited from EnumAttribute.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 EnumAttribute.getRequiredLevel
- Defined in node_modules/@types/xrm/index.d.ts:2672

getSelectedOption

getSelectedOption(): Xrm.OptionSetValue
Gets selected option.

Returns Xrm.OptionSetValue
The selected option.
- Defined in node_modules/@types/xrm/index.d.ts:2904

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

getText

getText(): string
Gets the label of the currently selected option.

Returns string
The current value's label.
- Defined in node_modules/@types/xrm/index.d.ts:2910

getUserPrivilege

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

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

getValue

getValue(): T
Gets the value.

Returns T
The value.
Inherited from EnumAttribute.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 EnumAttribute.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 EnumAttribute.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 EnumAttribute.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 EnumAttribute.setSubmitMode
- Defined in node_modules/@types/xrm/index.d.ts:2706

setValue

setValue(value): void
Sets the value.
Parameters
- value: number
  
  The value.
Returns void

Remarks
The getOptions() method returns option values as strings. You must use parseInt to convert them to numbers before you can use those values to set the value of an OptionSet attribute. Attributes on Quick Create Forms will not save values set with this method.
Overrides EnumAttribute.setValue
- Defined in node_modules/@types/xrm/index.d.ts:2920

Interface OptionSetAttribute<T>

See

Type Parameters

T extends number = number

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

getInitialValue

Returns T

Remarks

See

getIsDirty

Returns boolean

getName

Returns string

getOption

Parameters

value: number

Returns Xrm.OptionSetValue

Parameters

label: string

Returns Xrm.OptionSetValue

getOptions

Returns Xrm.OptionSetValue[]

getParent

Returns Xrm.Entity

getRequiredLevel

Returns Xrm.Attributes.RequirementLevel

getSelectedOption

Returns Xrm.OptionSetValue

getSubmitMode

Returns Xrm.SubmitMode

Remarks

getText

Returns string

getUserPrivilege

Returns Xrm.Privilege

getValue

Returns T

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

Returns void

`Optional` message: string