Interface LookupControl

Interface for a Lookup control.

See

StandardControl

Hierarchy

Xrm.Controls.StandardControl
- LookupControl
  - Xrm.Page.LookupControl

Methods

addCustomFilter

addCustomFilter(filter, entityLogicalName?): void
Adds an additional custom filter to the lookup, with the "AND" filter operator. Can only be used within a "pre search" event handler
Parameters
- filter: string
  
  Specifies the filter, as a serialized FetchXML "filter" node.
- Optional entityLogicalName: string
  
  (Optional) The logical name of the entity.
Returns void
See
addPreSearch

Remarks
If entityLogicalName is not specified, the filter will be applied to all entities valid for the Lookup control.

Example
```
Example filter: <filter type="and">
                             <condition attribute="address1_city" operator="eq" value="Redmond" />
                             </filter>
```
- Defined in node_modules/@types/xrm/index.d.ts:3492

addCustomView

addCustomView(viewId, entityName, viewDisplayName, fetchXml, layoutXml, isDefault): void
Adds a custom view for the Lookup dialog.
Parameters
- viewId: string
  
  Unique identifier for the view, in Guid format.
- entityName: string
  
  Name of the entity.
- viewDisplayName: string
  
  Name of the view to display.
- fetchXml: string
  
  The FetchXML query for the view's contents, serialized as a string.
- layoutXml: string
  
  The Layout XML, serialized as a string.
- isDefault: boolean
  
  true, to treat this view as default.
Returns void
Remarks
Cannot be used on "Owner" Lookup controls. The viewId is never saved to CRM, but must be unique across available views. Generating a new value can be accomplished with a External Link: Guid generator.

Example
```
Example viewId value: "{00000000-0000-0000-0000-000000000001}"
```
See
External Link: Layout XML Reference
- Defined in node_modules/@types/xrm/index.d.ts:3508

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

addOnLookupTagClick

addOnLookupTagClick(handler): void
Adds an event handler to the "lookup tag click" event.
Parameters
- handler: LookupTagClickHandler
  
  The function to add to the OnLookupTagClick event.
Returns void
- Defined in node_modules/@types/xrm/index.d.ts:3521

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

addPreSearch

addPreSearch(handler): void
Adds a handler to the "pre search" event of the Lookup control.
Parameters
- handler: Xrm.Events.ContextSensitiveHandler
  
  The handler.
Returns void
- Defined in node_modules/@types/xrm/index.d.ts:3478

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

getAttribute

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

Returns Xrm.Attributes.LookupAttribute
The attribute.
Overrides StandardControl.getAttribute
- Defined in node_modules/@types/xrm/index.d.ts:3527

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

getDefaultView

getDefaultView(): string
Gets the unique identifier of the default view.

Returns string
The default view, in Guid format.
Example
```
Example return: "{00000000-0000-0000-0000-000000000000}"
```
- Defined in node_modules/@types/xrm/index.d.ts:3534

getDisabled

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

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

getEntityTypes

getEntityTypes(): string[]
Gets the types of entities allowed in the lookup control.

Returns string[]
- Defined in node_modules/@types/xrm/index.d.ts:3558

getLabel

getLabel(): string
Gets the label.

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

removeOnLookupTagClick

removeOnLookupTagClick(handler): void
Removes the handler from the "lookup tag click" event.
Parameters
- handler: LookupTagClickHandler
  
  The function to be removed from the OnLookupTagClick event.
Returns void
- Defined in node_modules/@types/xrm/index.d.ts:3540

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

removePreSearch

removePreSearch(handler): void
Removes the handler from the "pre search" event of the Lookup control.
Parameters
- handler: Xrm.Events.ContextSensitiveHandler
  
  The handler.
Returns void
- Defined in node_modules/@types/xrm/index.d.ts:3546

setDefaultView

setDefaultView(viewGuid): void
Sets the Lookup's default view.
Parameters
- viewGuid: string
  
  Unique identifier for the view.
Returns void
Example
```
Example viewGuid value: "{00000000-0000-0000-0000-000000000000}"
```
- Defined in node_modules/@types/xrm/index.d.ts:3553

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

setEntityTypes

setEntityTypes(entityLogicalNames): void
Sets the types of entities allowed in the lookup control.
Parameters
- entityLogicalNames: string[]
Returns void
- Defined in node_modules/@types/xrm/index.d.ts:3563

setFocus

setFocus(): void
Sets focus on the element.

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

Interface LookupControl

See

Hierarchy

Index

Methods

Methods

addCustomFilter

Parameters

filter: string

Optional entityLogicalName: string

Returns void

See

Remarks

Example

addCustomView

Parameters

viewId: string

entityName: string

viewDisplayName: string

fetchXml: string

layoutXml: string

isDefault: boolean

Returns void

Remarks

Example

See

addNotification

Parameters

notification: Xrm.Controls.AddControlNotificationOptions

Returns void

addOnLookupTagClick

Parameters

handler: LookupTagClickHandler

Returns void

addOnOutputChange

Parameters

handler: Xrm.Events.ContextSensitiveHandler

Returns void

addPreSearch

Parameters

handler: Xrm.Events.ContextSensitiveHandler

Returns void

clearNotification

Parameters

Optional uniqueId: string

Returns boolean

Remarks

getAttribute

Returns Xrm.Attributes.LookupAttribute

getControlType

Returns string

getDefaultView

Returns string

Example

getDisabled

Returns boolean

getEntityTypes

Returns string[]

getLabel

Returns string

getName

Returns string

Remarks

getOutputs

Returns { [index: string]: FieldControlOutput; }

[index: string]: FieldControlOutput

getParent

Returns Xrm.Controls.Section

getVisible

Returns boolean

removeOnLookupTagClick

Parameters

handler: LookupTagClickHandler

Returns void

removeOnOutputChange

Parameters

handler: Xrm.Events.ContextSensitiveHandler

Returns void

removePreSearch

Parameters

`Optional` entityLogicalName: string

`Optional` uniqueId: string

Returns {
[index: string]: FieldControlOutput;
}