Widget Type:
Form Widgets
TPC Version:
  • 3.3 +
VideoLogos
The CRM Picklist widget is a dropdown list that allows you to select from a variety of options provided by the chosen CRM Entity. A good example of this would be a list of countries or provinces.

Configuration

Basic

 

  1. rom the Portal Connector widget list, click and drag the CRM Picklist widget into the body of your form.

  2. In order for the widget to work properly, you must configure the widget. Click on the edit button to display the prompt. It should look like this: 

    CRM Picklist Basic Properties 3.2

Appearance


  1. When you are finished configuring the Basic settings of the widget, click on the Appearances tab. It should look like this:  

    CRM Picklist Appearance 3.2

  2. When you are finished configuring the widget, click on the save button to save it.

Widget Properties

Basic Properties

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

CRM Field

The CRM Field drop down list allows you to change what options will appear in a particular widget. For example, in a CRM Picklist, a CRM Field of Marital Status would contain the options: Single, married, divorced, and widowed. The CRM Fields available are dependant upon which CRM Entity has been chosen. Please note that some selections have a grey backdrop. This means that the CRM Field is a read-only field. Upon selection, the Read-Only checkbox will be automatically selected.

Hide Labels

When the Render Mode of a picklist is set to a radio button list, the Hide Labels property will allow you to choose whether the labels of the radio button items are hidden or not.

Enable Accessibility Mode

The Enable Accessibility Mode advanced property will allow the widget to still function if the user's browser has JavaScript disabled. By default this is set to false.

Select a Template

The Select a Template drop down list will allow you to select a template for your product to use with the option of creating a new template. If a template is selected, you will be given the additional option of editing the selected template.

Read Only

The Read Only checkbox will not allow the user to interact with the widget when checked.

Make Required

The Make Required checkbox will not allow a user to successfully submit the form until there is data within it. Upon selecting the checkbox you will be prompted to enter an error message for invalid input.

Repeat Layout

When the Render Mode of a picklist is set to a radio button list, the Repeat Layout property is used to determine how a list of radio buttons will be formatted. Applicable options include Table, which will render all of the radio buttons in a table and Flow which will render all of the radio buttons in a single span element

Repeat Direction

When the Render Mode for a picklist is set to a radio button list, the Repeat Direction property is used to determine how the list will display. Options include Horizontal and Vertical.

Sorting Field ~ Pick List

The Sorting Field property allows you to choose how the options in a CRM Picklist are sorted. Applicable options include: None, Description, Label (Display Value), and Value. Selecting any option other than none will give you the choice of sorting the items in descending order.

Render Mode

The Render Mode property allows you to choose how a CRM Picklist displays its options. By default it is set to render the picklist options as a drop down list.

 

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

CRM Field

The CRM Field drop down list allows you to change what options will appear in a particular widget. For example, in a CRM Picklist, a CRM Field of Marital Status would contain the options: Single, married, divorced, and widowed. The CRM Fields available are dependant upon which CRM Entity has been chosen. Please note that some selections have a grey backdrop. This means that the CRM Field is a read-only field. Upon selection, the Read-Only checkbox will be automatically selected.

Hide Labels

When the Render Mode of a picklist is set to a radio button list, the Hide Labels property will allow you to choose whether the labels of the radio button items are hidden or not.

Enable Accessibility Mode

The Enable Accessibility Mode advanced property will allow the widget to still function if the user's browser has JavaScript disabled. By default this is set to false.

Select a Template

The Select a Template drop down list will allow you to select a template for your product to use with the option of creating a new template. If a template is selected, you will be given the additional option of editing the selected template.

Read Only

The Read Only checkbox will not allow the user to interact with the widget when checked.

Make Required

The Make Required checkbox will not allow a user to successfully submit the form until there is data within it. Upon selecting the checkbox you will be prompted to enter an error message for invalid input.

Repeat Layout

When the Render Mode of a picklist is set to a radio button list, the Repeat Layout property is used to determine how a list of radio buttons will be formatted. Applicable options include Table, which will render all of the radio buttons in a table and Flow which will render all of the radio buttons in a single span element

Repeat Direction

When the Render Mode for a picklist is set to a radio button list, the Repeat Direction property is used to determine how the list will display. Options include Horizontal and Vertical.

Sorting Field ~ Pick List

The Sorting Field property allows you to choose how the options in a CRM Picklist are sorted. Applicable options include: None, Description, Label (Display Value), and Value. Selecting any option other than none will give you the choice of sorting the items in descending order.

Render Mode

The Render Mode property allows you to choose how a CRM Picklist displays its options. By default it is set to render the picklist options as a drop down list.

 

API

get_cboPicklist()

Returns the RadComboBox object. 

Returns

RadComboBox 

get_lblReadOnly()

Returns the DOM element of the label if the widget is in read-only mode.

Returns

HTML Element

get_readOnly()

Returns true if the widget is in read only mode. 

Returns

Boolean

get_dataFieldName()

Returns developer name for the control. 

Returns

String

get_value()

Returns the value (GUID) of the currently selected object

Returns

String

set_value()

Sets the value of the text field control depending on Display Mode.  

Returns

none

get_selectedText()

Returns the display text of the selected record.  

Returns

String

set_selectedText()

Sets the display text of the selected record.  

Returns

none

clearSelection()

Deselects the current, chosen option of the widget.  

Returns

none

enable()

none

Returns

none

disable()

Disables the widget. 

Returns

none