Interface AutoLookupControl

Interface for Auto Lookup Control. This is not an Entity Lookup, but a control that supports AutoComplete / KeyPress Events (Text or Number)

Remarks

This interface is not supported for CRM mobile clients (phones or tablets) and the interactive service hub. It is only available for Updated entities.

See

StandardControl

Deprecated

Use AutoLookupControl instead.

Hierarchy

Methods

addNotification addOnKeyPress addOnOutputChange clearNotification fireOnKeyPress getAttribute getControlType getDisabled getLabel getName getOutputs getParent getValue getVisible hideAutoComplete removeOnKeyPress removeOnOutputChange setDisabled setFocus setLabel setNotification setVisible showAutoComplete

Methods

addNotification

addOnKeyPress

  • 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

    Returns void

    Deprecated

    Deprecated in v9.1; Use a custom control.

    See

    External Link: Deprecated Client APIs

addOnOutputChange

clearNotification

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

fireOnKeyPress

  • 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

getAttribute

getControlType

  • 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).

getDisabled

  • Gets a boolean value, indicating whether the control is disabled.

    Returns boolean

    true if it is disabled, otherwise false.

getLabel

  • Gets the label.

    Returns string

    The label.

getName

  • 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_.

getOutputs

  • 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

getParent

getValue

  • 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

getVisible

  • Gets the visibility state.

    Returns boolean

    true if the tab is visible, otherwise false.

hideAutoComplete

removeOnKeyPress

  • Use this to remove an event handler for a text or number field that you added using addOnKeyPress.

    Parameters

    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.

removeOnOutputChange

setDisabled

  • Sets the state of the control to either enabled, or disabled.

    Parameters

    • disabled: boolean

      true to disable, false to enable.

    Returns void

setFocus

  • Sets focus on the element.

    Returns void

setLabel

  • Sets the label.

    Parameters

    • label: string

      The label.

    Returns void

setNotification

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

setVisible

  • Sets the visibility state.

    Parameters

    • visible: boolean

      true to show, false to hide.

    Returns void

showAutoComplete

  • 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

    Returns void

    Deprecated

    Deprecated in v9.

    See

    External Link: Deprecated Client APIs

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc