Class LookupField

Interface a Lookup attribute.

See

Attribute

Hierarchy

Field
- LookupField

Implements

Xrm.Attributes.LookupAttribute

Constructors

constructor

new LookupField(attribute): LookupField
Parameters
- attribute: string
Returns LookupField
Overrides Field.constructor
- Defined in src/XrmEx.ts:1424

Properties

`Readonly` Name

Name: string

`Protected` _attribute

_attribute: Xrm.Attributes.LookupAttribute

`Protected` _customFilters

_customFilters: any = []

`Private` viewId

viewId: `${string}-${string}-${string}-${string}-${string}` = ...

Accessors

Attribute

get Attribute(): Xrm.Attributes.LookupAttribute
Returns Xrm.Attributes.LookupAttribute
Overrides Field.Attribute
- Defined in src/XrmEx.ts:1430

EntityType

get EntityType(): string
Gets the entityType of the first lookup value

Returns string
- Defined in src/XrmEx.ts:1445

FormattedValue

get FormattedValue(): string
Gets the formatted value of the first lookup value

Returns string
- Defined in src/XrmEx.ts:1451

Id

get Id(): string
Gets the id of the first lookup value

Returns string
- Defined in src/XrmEx.ts:1439

Value

get Value(): Xrm.LookupValue[]
Gets the value.

Returns Xrm.LookupValue[]
The value.
Overrides Field.Value
- Defined in src/XrmEx.ts:1454
set Value(value): void
Parameters
- value: Xrm.LookupValue[]
Returns void
Overrides Field.Value
- Defined in src/XrmEx.ts:1457

controls

get controls(): ItemCollection<Xrm.Controls.LookupControl>
A collection of all the controls on the form that interface with this attribute.

Returns ItemCollection<Xrm.Controls.LookupControl>

See
External Link: Collections (Client API reference)
Implementation of LookupAttribute.controls

Overrides Field.controls
- Defined in src/XrmEx.ts:1435

Methods

addCustomView

addCustomView(fetchXml): LookupField
Adds a custom view to filter the lookup using FetchXML Only works for one table at a time, cannot add views for multiple tables at the same time
Parameters
- fetchXml: string
  
  The complete FetchXML query including filtering conditions
Returns LookupField
The LookupField instance for method chaining
- Defined in src/XrmEx.ts:1647

addNotification

addNotification(message, notificationLevel, uniqueId, actions?): LookupField
Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.
Parameters
- message: string
- notificationLevel: "ERROR" | "RECOMMENDATION"
- uniqueId: string
- Optional actions: Xrm.Controls.ControlNotificationAction[]
Returns LookupField
Inherited from Field.addNotification
- Defined in src/XrmEx.ts:1195

addOnChange

addOnChange(handlers): LookupField
Adds a handler or an array of handlers to be called when the attribute's value is changed.
Parameters
- handlers: Xrm.Events.ContextSensitiveHandler | Xrm.Events.ContextSensitiveHandler[]
  
  The function reference or an array of function references.
Returns LookupField
Implementation of LookupAttribute.addOnChange

Inherited from Field.addOnChange
- Defined in src/XrmEx.ts:1165

addPreFilterToLookup

addPreFilterToLookup(filterXml, entityLogicalName?): LookupField
Adds an additional custom filter to the lookup, with the "AND" filter operator.
Parameters
- filterXml: string
- Optional entityLogicalName: string
  
  (Optional) The logical name of the entity.
Returns LookupField
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 src/XrmEx.ts:1568

addPreFilterToLookupAdvanced

addPreFilterToLookupAdvanced(entityLogicalName, primaryAttributeIdName, fetchXml): Promise<void>
Parameters
- entityLogicalName: string
  
  (Optional) The logical name of the entity.
- primaryAttributeIdName: string
  
  (Optional) The logical name of the primary key.
- fetchXml: string
  
  Specifies the FetchXML used to filter.
Returns Promise<void>
Deprecated
Use addCustomView instead, which provides more flexible filtering capabilities and better performance Adds an additional custom filter to the lookup, with the "AND" filter operator.

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

Example
```
Example fetchXml: <fetch>
                             <entity name="contact">
                                 <filter>
                                 <condition attribute="address1_city" operator="eq" value="Redmond" />
                                 </filter>
                             </entity>
                             </fetch>
```
- Defined in src/XrmEx.ts:1607

clearPreFilterFromLookup

clearPreFilterFromLookup(): LookupField
Removes all filters set on the current lookup attribute by using addPreFilterToLookup or addPreFilterToLookupAdvanced

Returns LookupField
- Defined in src/XrmEx.ts:1725

`Private` extractEntityFromFetchXml

extractEntityFromFetchXml(fetchXml): string
Extracts entity name from fetchXml
Parameters
- fetchXml: string
Returns string
- Defined in src/XrmEx.ts:1676

fireOnChange

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

Returns LookupField
Implementation of LookupAttribute.fireOnChange

Inherited from Field.fireOnChange
- Defined in src/XrmEx.ts:1150

`Private` generateLayoutXml

generateLayoutXml(fetchXml): string
Generates layoutXml based on fetchXml attributes
Parameters
- fetchXml: string
Returns string
- Defined in src/XrmEx.ts:1687

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
Implementation of LookupAttribute.getAttributeType

Inherited from Field.getAttributeType
- Defined in src/XrmEx.ts:1003

getFormat

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

Returns Xrm.Attributes.AttributeFormat
The format of the attribute.

Values returned are:
- date (datetime)
- datetime (datetime)
- duration (integer)
- email (string)
- language (optionset)
- none (integer)
- phone (string)
- text (string)
- textarea (string)
- tickersymbol (string)
- timezone (optionset)
- url (string)
See
getAttributeType
Implementation of LookupAttribute.getFormat

Inherited from Field.getFormat
- Defined in src/XrmEx.ts:1006

getIsDirty

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

Returns boolean
true if there are unsaved changes, otherwise false.
Implementation of LookupAttribute.getIsDirty

Inherited from Field.getIsDirty
- Defined in src/XrmEx.ts:1009

getIsPartyList

getIsPartyList(): boolean
Gets a boolean value indicating whether the Lookup is a multi-value PartyList.

Returns boolean
true the attribute is a PartyList, otherwise false.
Implementation of LookupAttribute.getIsPartyList
- Defined in src/XrmEx.ts:1427

getName

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

Returns string
The logical name.
Implementation of LookupAttribute.getName

Inherited from Field.getName
- Defined in src/XrmEx.ts:1012

getParent

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

Returns Xrm.Entity
The parent record context.
Implementation of LookupAttribute.getParent

Inherited from Field.getParent
- Defined in src/XrmEx.ts:1015

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"
Implementation of LookupAttribute.getRequiredLevel

Inherited from Field.getRequiredLevel
- Defined in src/XrmEx.ts:1018

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"
Implementation of LookupAttribute.getSubmitMode

Inherited from Field.getSubmitMode
- Defined in src/XrmEx.ts:1021

getUserPrivilege

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

Returns Xrm.Privilege
The user privileges.
Implementation of LookupAttribute.getUserPrivilege

Inherited from Field.getUserPrivilege
- Defined in src/XrmEx.ts:1024

getValue

getValue(): any
Gets the value.

Returns any
The value.
Implementation of LookupAttribute.getValue

Inherited from Field.getValue
- Defined in src/XrmEx.ts:1033

removeNotification

removeNotification(uniqueId): LookupField
Clears the notification identified by uniqueId.
Parameters
- uniqueId: string
  
  (Optional) Unique identifier.
Returns LookupField
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 Field.removeNotification
- Defined in src/XrmEx.ts:1228

removeOnChange

removeOnChange(handler): void
Removes the handler from the "on change" event.
Parameters
- handler: ChangeEventHandler
  
  The handler.
Returns void
Implementation of LookupAttribute.removeOnChange

Inherited from Field.removeOnChange
- Defined in src/XrmEx.ts:1027

retrieve

retrieve(options): Promise<any>
Retrieves an entity record.
Parameters
- options: string
  (Optional) OData system query options, $select and $expand, to retrieve your data.
  - Use the $select system query option to limit the properties returned by including a comma-separated list of property names. This is an important performance best practice. If properties aren’t specified using $select, all properties will be returned.
  - Use the $expand system query option to control what data from related entities is returned. If you just include the name of the navigation property, you’ll receive all the properties for related records. You can limit the properties returned for related records using the $select system query option in parentheses after the navigation property name. Use this for both single-valued and collection-valued navigation properties.
  - You can also specify multiple query options by using & to separate the query options.
Returns Promise<any>
On success, returns a promise containing a JSON object with the retrieved attributes and their values.
Example
options example:
```
options: $select=name&$expand=primarycontactid($select=contactid,fullname)
```
See
External Link: retrieveRecord (Client API reference)
- Defined in src/XrmEx.ts:1543

setDisabled

setDisabled(disabled): LookupField
Sets the state of the control to either enabled, or disabled.
Parameters
- disabled: boolean
  
  true to disable, false to enable.
Returns LookupField
Inherited from Field.setDisabled
- Defined in src/XrmEx.ts:1106

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)
Implementation of LookupAttribute.setIsValid

Inherited from Field.setIsValid
- Defined in src/XrmEx.ts:1036

setLookupFromRetrieve

setLookupFromRetrieve(selectName, retrievedRecord): void

Sets a lookup with a lookup from the retrieved record.

Parameters

selectName: string
retrievedRecord: {
[x: string]: any;
}
- [x: string]: any

Returns void

Example

var contact = await fields.Contact.retrieve('?$select=_parentcustomerid_value');
fields.Account.setLookupFromRetrieve('_parentcustomerid_value', contact);
//Alternate
fields.Account.setLookupFromRetrieve('parentcustomerid', contact);

setLookupValue

setLookupValue(id, entityType, name, append?): LookupField
Sets the value of a lookup
Parameters
- id: string
  
  Guid of the record
- entityType: any
  
  logicalname of the entity
- name: any
  
  formatted value
- append: boolean = false
  
  if true, adds value to the array instead of replacing it
Returns LookupField
- Defined in src/XrmEx.ts:1467

setNotification

setNotification(message, uniqueId): LookupField
Sets a control-local notification message.
Parameters
- message: string
  
  The message.
- uniqueId: string
  
  Unique identifier.
Returns LookupField
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 Field.setNotification
- Defined in src/XrmEx.ts:1072

setRequired

setRequired(required): LookupField
Sets the required level.
Parameters
- required: boolean
  
  The requirement level, as either false for "none" or true for "required"
Returns LookupField
Inherited from Field.setRequired
- Defined in src/XrmEx.ts:1138

setRequiredLevel

setRequiredLevel(requirementLevel): LookupField
Sets the required level.
Parameters
- requirementLevel: Xrm.Attributes.RequirementLevel
  
  The requirement level, as either "none", "required", or "recommended"
Returns LookupField
Implementation of LookupAttribute.setRequiredLevel

Inherited from Field.setRequiredLevel
- Defined in src/XrmEx.ts:1121

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
Implementation of LookupAttribute.setSubmitMode

Inherited from Field.setSubmitMode
- Defined in src/XrmEx.ts:1030

setValue

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

Remarks
Attributes on Quick Create Forms will not save values set with this method.
Implementation of LookupAttribute.setValue

Inherited from Field.setValue
- Defined in src/XrmEx.ts:1000

setVisible

setVisible(visible): LookupField
Sets the visibility state.
Parameters
- visible: boolean
  
  true to show, false to hide.
Returns LookupField
Inherited from Field.setVisible
- Defined in src/XrmEx.ts:1091

Class LookupField

See

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

attribute: string

Returns LookupField

Properties

Readonly Name

Protected _attribute

Protected _customFilters

Private viewId

Accessors

Attribute

Returns Xrm.Attributes.LookupAttribute

EntityType

Returns string

FormattedValue

Returns string

Id

Returns string

Value

Returns Xrm.LookupValue[]

Parameters

value: Xrm.LookupValue[]

Returns void

controls

Returns ItemCollection<Xrm.Controls.LookupControl>

See

Methods

addCustomView

Parameters

fetchXml: string

Returns LookupField

addNotification

Parameters

message: string

notificationLevel: "ERROR" | "RECOMMENDATION"

uniqueId: string

Optional actions: Xrm.Controls.ControlNotificationAction[]

Returns LookupField

addOnChange

Parameters

handlers: Xrm.Events.ContextSensitiveHandler | Xrm.Events.ContextSensitiveHandler[]

Returns LookupField

addPreFilterToLookup

Parameters

filterXml: string

Optional entityLogicalName: string

Returns LookupField

Remarks

Example

addPreFilterToLookupAdvanced

Parameters

entityLogicalName: string

primaryAttributeIdName: string

fetchXml: string

Returns Promise<void>

Deprecated

Remarks

Example

clearPreFilterFromLookup

Returns LookupField

Private extractEntityFromFetchXml

Parameters

fetchXml: string

Returns string

fireOnChange

Returns LookupField

Private generateLayoutXml

Parameters

fetchXml: string

Returns string

`Readonly` Name

`Protected` _attribute

`Protected` _customFilters

`Private` viewId

`Optional` actions: Xrm.Controls.ControlNotificationAction[]

`Optional` entityLogicalName: string

`Private` extractEntityFromFetchXml

`Private` generateLayoutXml

`Optional` message: string

retrievedRecord: {
[x: string]: any;
}