Loading...

Party List

Properties API

Widget Type:
Form Widgets
TPC Version:
  • 5.1
VideoLogos
Party list widget will allows you to select multiple records from Lead , Account, Contact or System use entities to associate to activities in CRM.

Configuration

Basic

Drag and drop the Party List widget 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 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 have populated the widget with data.

Data

The data tab is used for defining FetchXML, which will determine what sorts of records the party list will  fetch. Party list allows you to select Lead, Account, Contacts or System users from  entities as your fetch.

The FetchXML text area determines what sort of data a widget will be populated with. Clicking the Load Default Fetch option will populate the FetchXML area with a default fetch based on the CRM Entity chosen. Clicking the Build button FetchXML builder window will open. 

For more information on how to use the fetch builder, please see the FetchXML Builder How-To.

Appearance

After configuring the basic widget settings, click on the Appearance tab. This section allows you to determine how a party list should appear. The Empty Place Holder text field allows you to set some transparent text that will appear in the text field when it is empty.The Tool Tip allows you to add a description or Hint to your widget

Filters

The Filters tab contains a myriad of options to filter the records that the widget fetches. For example, you can filter records by the logged-in contacts' ID or by a query string value. For more information, please see the Filtering Records How-To.

Widget Properties

Basic Properties

CacheData

This property enables/disables CRM data caching. Defaults to false.

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. 

Read Only

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

IsHidden

Allows you to hide the widget when this property is set to true

Hide Title

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

EscapeCrmData

Converts a data string into an HTML-encoded string.

FetchXML

The FetchXML text area determines what sort of data a widget will be populated with. Clicking the Load Default Fetch option will populate the FetchXML area with a default fetch based on the CRM Entity chosen.  By clicking the Build button, we will be sent to another page in order to determine what the widget will look up. For more information on how to use the FetchXML function, please see the FetchXML Builder How-To.

EncryptGuids

The EncryptGuids advanced properties determines whether Guids should be encrypted or not. By default this is set to true.

ClientSideRequired

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

Title

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

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.

CacheData

This property enables/disables CRM data caching. Defaults to false.

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. 

Read Only

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

IsHidden

Allows you to hide the widget when this property is set to true

Hide Title

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

EscapeCrmData

Converts a data string into an HTML-encoded string.

FetchXML

The FetchXML text area determines what sort of data a widget will be populated with. Clicking the Load Default Fetch option will populate the FetchXML area with a default fetch based on the CRM Entity chosen.  By clicking the Build button, we will be sent to another page in order to determine what the widget will look up. For more information on how to use the FetchXML function, please see the FetchXML Builder How-To.

EncryptGuids

The EncryptGuids advanced properties determines whether Guids should be encrypted or not. By default this is set to true.

ClientSideRequired

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

Title

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

API

get_displayInput()

Returns the display input associated with the widget.

Returns

jQuery Object

get_kendoInput()

Returns the Kendo DropDownList Object associated with the widget.

Returns

Kendo Object: Kendo.ui.DropDownList

get_model()

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

Returns

Object

clear()

Clears the value of the widget.

Returns

None

get_partyTypeSelector()

Returns the party type selector.

Returns

jQuery Object

toggle()

Toggles the visibility of the widget.

Returns

None

get_element()

Returns the element associated with the widget.

Returns

jQuery Object

get_container()

Returns the container element of the widget.

Returns

jQuery Object

readonly()

Sets the widget state to read only.

Returns

None

get_partySelector()

Returns the Kendo DropDownList Object of the party selector input.

Returns

Kendo Object: kendo.ui.DropDownList

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

Function

show()

Shows the widget on the form.

Returns

None

get_partyDialog()

Returns the Kendo Dialog Object associated with the widget.

Returns

Kendo Object: kendo.ui.Dialog

get_input()

Returns the input element of the widget.

Returns

jQuery Object

set_value()

Sets the value of the widget.

Returns

None

disable()

Disables the widget on the form.

Returns

None

required()

Enables or disables client side validation.

Returns

get_type()

Returns the widget type.

Returns

String

get_addPartyButton()

Returns the add button element associated with the widget.     

Returns

jQuery Object     

get_value()

Returns the value of the widget.

Returns

String

remove_valueChanged()

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

Returns

None

enable()

Enables the widget on the form.

Returns

None

hide()

Hides the widget from the form.

Returns

None

Full API With Examples

How to's

Examples of Party List Configuration