Loading...

Picklist

Properties API Related

Widget Type:
Form Widgets
TPC Version:
  • 4.0
picklistlogos
The Picklist allows you to view or modify an Option Set in CRM. It picks up the CRM labels associated with a particular field and displays their string value.

A pick list can be configured to appear in a variety of ways, including a dropdown list or a group of radio buttons.

Here are two examples of some of the fields and appearances that a Picklist can be configured to:

PicklistExample

Configuration

Basic

Make sure you have a CRM Form Configuration and a TPC Form Layout already attached and configured. This would reveal the Attributes available to the Entity Selected in the Form Configuration. 

Drag and drop the Pick List from The Portal Connector tools into the TPC Form Layout and click edit to display the properties prompt.

The Title will allow you to set the label for the control. By default it is set to the whichever attribute you choose but it can be freely modified.

The Attribute dropdown list allows you to select an attribute for the widget to submit data to. The pick list will be populated by the options associated with the attribute.

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

The Hidden option will hide the widget from the form when checked.

The Required option will not allow the user to submit the form until they've populated the widget with data.

pick-list-instructions-2

Appearance

The Input Mode dropdown list allows you to specify an appearance for the pick list to take. Available options include: Dropdown list and radio button group.

The Sorting Field dropdown list allows you to sort your pick list. You may sort your pick list values by no criteria, the label, or the value. Once you've selected a sorting criteria, you will be given a Sorting Descending checkbox to determine if the items will be sorted in descending order. By default, the items will be assorted in ascending order.

pick-list-instructions-1

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.

Attribute

The Attribute drop down list will allow you to change the data field that this widget will save the user’s input to (For example, a CRM Text Field with an Attribute of Account Name will save its input to the Account Name data field).

Read Only

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

Hidden

The Hidden checkbox will hide the widget from the page when checked.

Required Field

The Required Field 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.

ClientSideRequired

Allows you to enable or disable "required" from client side  

Input Mode

The Input Mode dropdown list allows you to specify an appearance for a widget. Applicable options are dependent on the widget. For example, the Picklist widget includes: Radio button group and dropdown list. The Yes/No widget includes: Radio button group, dropdown list, checkbox, and mobile switch. The textfield widget includes: Text (single line), multiline, HTML, numeric, and currency.

Each view would contain the Input Labels associated with the values inside CRM in the case of the Picklist and Yes/No widgets..

This option is overridden if Read Only is selected.

Sorting Field

Specifies the sorting field either by Label or Value.

Tool Tip

The Tool Tip allows you to add a description or Hint to your widget.

ToolTipPosition

This property determines the position of the tool tip. By default this property is set to "Auto". You can change this to Left , Right , Top , Bottom. 

Filter Picklist Choices

Enable filtering pick list choices on the pick list 

Options to Remove

When "Filter Pick list Choices" property enable you can select what options you would like to remove from the pick list choices 

Hide Title

You can hide the title by setting the property value to true

RequiredIndicationLabel

The label text that appears next to the widget when marked as required.

NoDefaultOption

Allows you add a Default value to the selection by setting this property to True 

IsMultiSelect

Allows you to select more than one option from the selection.

IncludeNullValue

Allows you to include the null value to the list of values

IncludeNullValue

The IncludeNullValue advanced property determines whether a null value can be selected. Typically, this is represented as a blank selection on a dropdown list. By default this is set to 'true'.

LabelPosition

The LabelPosition advanced property specifies where the label of a widget will appear. By default, the label will appear on top of the widget. Applicable options include: Top and left. The content of the label is controlled by the Title property. The default value for this is 'Top'.

Sorting Descending

This option appears if Sorting Field is selected. If selected sorting will be in descending order (Z-A) instead of ascending order (A-Z).

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.

Attribute

The Attribute drop down list will allow you to change the data field that this widget will save the user’s input to (For example, a CRM Text Field with an Attribute of Account Name will save its input to the Account Name data field).

Read Only

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

Hidden

The Hidden checkbox will hide the widget from the page when checked.

Required Field

The Required Field 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.

ClientSideRequired

Allows you to enable or disable "required" from client side  

Input Mode

The Input Mode dropdown list allows you to specify an appearance for a widget. Applicable options are dependent on the widget. For example, the Picklist widget includes: Radio button group and dropdown list. The Yes/No widget includes: Radio button group, dropdown list, checkbox, and mobile switch. The textfield widget includes: Text (single line), multiline, HTML, numeric, and currency.

Each view would contain the Input Labels associated with the values inside CRM in the case of the Picklist and Yes/No widgets..

This option is overridden if Read Only is selected.

Sorting Field

Specifies the sorting field either by Label or Value.

Tool Tip

The Tool Tip allows you to add a description or Hint to your widget.

ToolTipPosition

This property determines the position of the tool tip. By default this property is set to "Auto". You can change this to Left , Right , Top , Bottom. 

Filter Picklist Choices

Enable filtering pick list choices on the pick list 

Options to Remove

When "Filter Pick list Choices" property enable you can select what options you would like to remove from the pick list choices 

Hide Title

You can hide the title by setting the property value to true

RequiredIndicationLabel

The label text that appears next to the widget when marked as required.

NoDefaultOption

Allows you add a Default value to the selection by setting this property to True 

IsMultiSelect

Allows you to select more than one option from the selection.

IncludeNullValue

Allows you to include the null value to the list of values

IncludeNullValue

The IncludeNullValue advanced property determines whether a null value can be selected. Typically, this is represented as a blank selection on a dropdown list. By default this is set to 'true'.

LabelPosition

The LabelPosition advanced property specifies where the label of a widget will appear. By default, the label will appear on top of the widget. Applicable options include: Top and left. The content of the label is controlled by the Title property. The default value for this is 'Top'.

Sorting Descending

This option appears if Sorting Field is selected. If selected sorting will be in descending order (Z-A) instead of ascending order (A-Z).

API

enable()

Enables the widget on the form.

Returns

None

get_type()

Returns the widget type.

Returns

None

get_kendoInput()

Returns the Kendo DropDownList Object associated with the widget.

Returns

Kendo Object: Kendo.ui.DropDownList Object

required()

Enables or disables client side validation.

Returns

None

get_displayInput()

Returns the picklist display associated with the widget.

Returns

jQuery Object

get_element()

Returns the element of the widget.

Returns

jQuery Object

clear()

Clears the value of the widget.

Returns

None

disable()

Disables the widget on the form.

Returns

None

get_model()

Returns the model object of the widget, which contains a number of useful properties related to the widget.

Returns

Object

get_input()

Returns the input element associated with the widget.     

Returns

jQuery Object

get_container()

Returns the container element associated with the widget.

Returns

jQuery Object

hide()

Hides the widget from the form.

Returns

None

show()

Shows the widget on the form.

Returns

None

set_value()

Sets the value of the widget.

Returns

None

get_value()

Returns the currently selected value of the widget.

Returns

String

get_textValue()

Returns the text label of the currently selected item on the widget.

Returns

String

set_textValue()

Sets the value of the widget according to a text label.

Returns

None

add_valueChanged()

Fired when the value of the widget is changed by the user.
The event handler function context (available via the this keyword) will be set to the widget instance.

Returns

None     

remove_valueChanged()

Removes any delegate hooked up to the add_valueChanged() event.

Returns

None

toggle()

Toggles the visibility of the widget.

Returns

None

readonly()

Sets the widget state to read only.

Returns

None

Full API With Examples