Interface OptionSetControl

Interface for an OptionSet control.

Methods

addNotification

addNotification(notification): void
Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.
Parameters
- notification: Xrm.Controls.AddControlNotificationOptions
Returns void
Inherited from OptionSetControl.addNotification
- Defined in node_modules/@types/xrm/index.d.ts:3340

addOnOutputChange

addOnOutputChange(handler): void
Adds an event handler to the OnOutputChange event.
Parameters
- handler: Xrm.Events.ContextSensitiveHandler
  
  The function to add to the OnOutputChange event.
Returns void
Inherited from OptionSetControl.addOnOutputChange
- Defined in node_modules/@types/xrm/index.d.ts:3346

addOption

addOption(option, index?): void
Adds an option.
Parameters
- option: Xrm.OptionSetValue
  
  The option.
- Optional index: number
  
  (Optional) zero-based index of the option.
Returns void

Remarks
This method does not check that the values within the options you add are valid. If index is not provided, the new option will be added to the end of the list.
Inherited from OptionSetControl.addOption
- Defined in node_modules/@types/xrm/index.d.ts:3581

clearNotification

clearNotification(uniqueId?): boolean
Clears the notification identified by uniqueId.
Parameters
- Optional uniqueId: string
  
  (Optional) Unique identifier.
Returns boolean
true if it succeeds, false if it fails.

Remarks
If the uniqueId parameter is not used, the current notification shown will be removed.
Inherited from OptionSetControl.clearNotification
- Defined in node_modules/@types/xrm/index.d.ts:3325

clearOptions

clearOptions(): void
Clears all options.

Returns void
Inherited from OptionSetControl.clearOptions
- Defined in node_modules/@types/xrm/index.d.ts:3586

getAttribute

getAttribute(): Xrm.Attributes.OptionSetAttribute<number>
Gets the control's bound attribute.

Returns Xrm.Attributes.OptionSetAttribute<number>
The attribute.
Inherited from OptionSetControl.getAttribute
- Defined in node_modules/@types/xrm/index.d.ts:3593

getControlType

getControlType(): string
Gets the controls type.

Returns string
The control type.

Values returned are:
- standard
- iframe
- lookup
- optionset
- subgrid
- webresource
- notes
- timercontrol
- kbsearch
- quickform (see ui.QuickForm)
- customcontrol: . (A custom control for mobile phone and tablet clients).
- customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
Inherited from OptionSetControl.getControlType
- Defined in node_modules/@types/xrm/index.d.ts:3262

getDisabled

getDisabled(): boolean
Gets a boolean value, indicating whether the control is disabled.

Returns boolean
true if it is disabled, otherwise false.
Inherited from OptionSetControl.getDisabled
- Defined in node_modules/@types/xrm/index.d.ts:3062

getLabel

getLabel(): string
Gets the label.

Returns string
The label.
Inherited from OptionSetControl.getLabel
- Defined in node_modules/@types/xrm/index.d.ts:3045

getName

getName(): string
Gets the name of the control on the form.

Returns string
The name of the control.

Remarks
The name assigned to a control is not determined until the form loads. Changes to the form may change the name assigned to a given control. When you use the control getName method the name of the first control will be the same as the name of the attribute. The second instance of a control for that attribute will be "1". The pattern +N will continue for each additional control added to the form for a specific attribute. When a form displays a business process flow control in the header, additional controls will be added for each attribute that is displayed in the business process flow. These controls have a unique name like the following: header_process_.
Inherited from OptionSetControl.getName
- Defined in node_modules/@types/xrm/index.d.ts:3278

getOptions

getOptions(): Xrm.OptionSetValue[]
Returns an array of option objects representing valid options available for a control, including a blank option and excluding any options that have been removed from the control using removeOption.

Returns Xrm.OptionSetValue[]
The array of option objects representing valid options where each option object has the following attributes: text: String. Label of the option. value: Number. Enumeration value of the option.
Inherited from OptionSetControl.getOptions
- Defined in node_modules/@types/xrm/index.d.ts:3089

getOutputs

getOutputs(): {
[index: string]: FieldControlOutput;
}
Returns a dictionary of the output properties of the control.

Returns {
[index: string]: FieldControlOutput;
}
A dictionary for the output parameters from the control. For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid
- [index: string]: FieldControlOutput
Inherited from OptionSetControl.getOutputs
- Defined in node_modules/@types/xrm/index.d.ts:3359

getParent

getParent(): Xrm.Controls.Section
Gets a reference to the Section parent of the control.

Returns Xrm.Controls.Section
The parent Section.
Inherited from OptionSetControl.getParent
- Defined in node_modules/@types/xrm/index.d.ts:3284

getVisible

getVisible(): boolean
Gets the visibility state.

Returns boolean
true if the tab is visible, otherwise false.
Inherited from OptionSetControl.getVisible
- Defined in node_modules/@types/xrm/index.d.ts:3100

removeOnOutputChange

removeOnOutputChange(handler): void
Removes an event handler from the OnOutputChange event.
Parameters
- handler: Xrm.Events.ContextSensitiveHandler
  
  The function to remove from the OnOutputChange event.
Returns void
Inherited from OptionSetControl.removeOnOutputChange
- Defined in node_modules/@types/xrm/index.d.ts:3352

removeOption

removeOption(value): void
Removes the option matching the value.
Parameters
- value: number
  
  The value.
Returns void
Inherited from OptionSetControl.removeOption
- Defined in node_modules/@types/xrm/index.d.ts:3600

setDisabled

setDisabled(disabled): void
Sets the state of the control to either enabled, or disabled.
Parameters
- disabled: boolean
  
  true to disable, false to enable.
Returns void
Inherited from OptionSetControl.setDisabled
- Defined in node_modules/@types/xrm/index.d.ts:3073

setFocus

setFocus(): void
Sets focus on the element.

Returns void
Inherited from OptionSetControl.setFocus
- Defined in node_modules/@types/xrm/index.d.ts:3132

setLabel

setLabel(label): void
Sets the label.
Parameters
- label: string
  
  The label.
Returns void
Inherited from OptionSetControl.setLabel
- Defined in node_modules/@types/xrm/index.d.ts:3051

setNotification

setNotification(message, uniqueId): boolean
Sets a control-local notification message.
Parameters
- message: string
  
  The message.
- uniqueId: string
  
  Unique identifier.
Returns boolean
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.
Inherited from OptionSetControl.setNotification
- Defined in node_modules/@types/xrm/index.d.ts:3335

setVisible

setVisible(visible): void
Sets the visibility state.
Parameters
- visible: boolean
  
  true to show, false to hide.
Returns void
Inherited from OptionSetControl.setVisible
- Defined in node_modules/@types/xrm/index.d.ts:3122

Interface OptionSetControl

See

Deprecated

Hierarchy

Index

Methods

Methods

addNotification

Parameters

notification: Xrm.Controls.AddControlNotificationOptions

Returns void

addOnOutputChange

Parameters

handler: Xrm.Events.ContextSensitiveHandler

Returns void

addOption

Parameters

option: Xrm.OptionSetValue

Optional index: number

Returns void

Remarks

clearNotification

Parameters

Optional uniqueId: string

Returns boolean

Remarks

clearOptions

Returns void

getAttribute

Returns Xrm.Attributes.OptionSetAttribute<number>

getControlType

Returns string

getDisabled

Returns boolean

getLabel

Returns string

getName

Returns string

Remarks

getOptions

Returns Xrm.OptionSetValue[]

getOutputs

Returns { [index: string]: FieldControlOutput; }

[index: string]: FieldControlOutput

getParent

Returns Xrm.Controls.Section

getVisible

Returns boolean

removeOnOutputChange

Parameters

handler: Xrm.Events.ContextSensitiveHandler

Returns void

removeOption

Parameters

value: number

Returns void

setDisabled

Parameters

disabled: boolean

Returns void

setFocus

Returns void

setLabel

Parameters

label: string

Returns void

setNotification

Parameters

message: string

uniqueId: string

Returns boolean

Remarks

setVisible

Parameters

visible: boolean

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` index: number

`Optional` uniqueId: string

Returns {
[index: string]: FieldControlOutput;
}