Interface StringControl

Interface for a String control.

See

StandardControl

Hierarchy

Xrm.Controls.AutoLookupControl
- StringControl
  - Xrm.Page.StringControl

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

addOnKeyPress

addOnKeyPress(handler): void
Use this to add a function as an event handler for the keypress event so that the function is called when you type a character in the specific text or number field. For a sample JavaScript code that uses the addOnKeyPress method to configure the auto-completion experience, see Sample: Auto-complete in CRM controls.
Parameters
- handler: Xrm.Events.ContextSensitiveHandler
  
  The function reference.
Returns void

Deprecated
Deprecated in v9.1; Use a custom control.

See
External Link: Deprecated Client APIs
Inherited from AutoLookupControl.addOnKeyPress
- Defined in node_modules/@types/xrm/index.d.ts:3147

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

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

fireOnKeyPress

fireOnKeyPress(): void
Use this to manually fire an event handler that you created for a specific text or number field to be executed on the keypress event.

Returns void

Deprecated
Deprecated in v9.1; Use a custom control.

See
External Link: Deprecated Client APIs
Inherited from AutoLookupControl.fireOnKeyPress
- Defined in node_modules/@types/xrm/index.d.ts:3154

getAttribute

getAttribute(): Xrm.Attributes.StringAttribute
Gets the control's bound attribute.

Returns Xrm.Attributes.StringAttribute
The attribute.
Overrides AutoLookupControl.getAttribute
- Defined in node_modules/@types/xrm/index.d.ts:3430

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

getLabel

getLabel(): string
Gets the label.

Returns string
The label.
Inherited from AutoLookupControl.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 AutoLookupControl.getName
- Defined in node_modules/@types/xrm/index.d.ts:3278

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

getValue

getValue(): string
Gets the latest value in a control as the user types characters in a specific text or number field. This method helps you to build interactive experiences by validating data and alerting users as they type characters in a control. The getValue method is different from the attribute getValue method because the control method retrieves the value from the control as the user is typing in the control as opposed to the attribute getValue method that retrieves the value after the user commits (saves) the field.

Returns string
Inherited from AutoLookupControl.getValue
- Defined in node_modules/@types/xrm/index.d.ts:3390

getVisible

getVisible(): boolean
Gets the visibility state.

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

hideAutoComplete

hideAutoComplete(): void
Hides the auto-completion drop-down list configured for a specific text field

Returns void

Deprecated
Deprecated in v9.

See
External Link: Deprecated Client APIs
Inherited from AutoLookupControl.hideAutoComplete
- Defined in node_modules/@types/xrm/index.d.ts:3397

removeOnKeyPress

removeOnKeyPress(handler): void
Use this to remove an event handler for a text or number field that you added using addOnKeyPress.
Parameters
- handler: Xrm.Events.ContextSensitiveHandler
  
  The function reference.
Returns void

Deprecated
Deprecated in v9.1; Use a custom control.

See
External Link: Deprecated Client APIs Remarks: If an anonymous function is set using addOnKeyPress, it can’t be removed using this method.
Inherited from AutoLookupControl.removeOnKeyPress
- Defined in node_modules/@types/xrm/index.d.ts:3163

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

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

setFocus

setFocus(): void
Sets focus on the element.

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

showAutoComplete

showAutoComplete(resultSet): void
Shows upt to 10 matching strings in a drop-down list as users press keys to type charactrer in a specific text field. On selecting an item in the drop-down list, the value in the text field changes to the selected item, the drop-down list disappears, and the OnChange event for the text field is invoked
Parameters
- resultSet: Xrm.Controls.AutoCompleteResultSet
  
  The results to show
Returns void

Deprecated
Deprecated in v9.

See
External Link: Deprecated Client APIs
Inherited from AutoLookupControl.showAutoComplete
- Defined in node_modules/@types/xrm/index.d.ts:3406

Interface StringControl

See

Hierarchy

Index

Methods

Methods

addNotification

Parameters

notification: Xrm.Controls.AddControlNotificationOptions

Returns void

addOnKeyPress

Parameters

handler: Xrm.Events.ContextSensitiveHandler

Returns void

Deprecated

See

addOnOutputChange

Parameters

handler: Xrm.Events.ContextSensitiveHandler

Returns void

clearNotification

Parameters

Optional uniqueId: string

Returns boolean

Remarks

fireOnKeyPress

Returns void

Deprecated

See

getAttribute

Returns Xrm.Attributes.StringAttribute

getControlType

Returns string

getDisabled

Returns boolean

getLabel

Returns string

getName

Returns string

Remarks

getOutputs

Returns { [index: string]: FieldControlOutput; }

[index: string]: FieldControlOutput

getParent

Returns Xrm.Controls.Section

getValue

Returns string

getVisible

Returns boolean

hideAutoComplete

Returns void

Deprecated

See

removeOnKeyPress

Parameters

handler: Xrm.Events.ContextSensitiveHandler

Returns void

Deprecated

See

removeOnOutputChange

Parameters

handler: Xrm.Events.ContextSensitiveHandler

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

`Optional` uniqueId: string

Returns {
[index: string]: FieldControlOutput;
}