Loading...

CRM Yes/No

Properties API

Widget Type:
Form Widgets
TPC Version:
  • 3.3 +
yesnologo
The CRM Yes/No widget allows you to add yes or no questions to your form that are associated with the chosen CRM Entity. A good example of this would be a client registration form wherein the user could use this widget to request that they not be given emails. The widget can be configured to have a variety of appearances.

Configuration

  1. From the Portal Connector widget list, click and drag the CRM Yes/No Widget into the body of your form.

  2. In order for the widget to function properly, there are a variety of options for you to configure. Click on the edit button to display the prompt. It should look like this: 

    CRM Yes No Properties

  3. When you are finished configuring the CRM Yes/No widget, click on the save button to save the widget.

Widget Properties

Basic Properties

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.

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.

Display Type

The Display Type drop down list will allow you to alter the appearance of a widget. For example, you can configure a CRM Yes/No widget to appear as a pair of radio buttons, a horizontal slider, or even as a checkbox. Additionally, you can configure a numeric CRM Text Field to display a number as a currency or percentage.

Show Labels

The Show Labels advanced property will show labels based on the CRM Yes/No label text for AODA compliance. This property is only enabled when the widget is in radio button mode.

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.

Default Value

The Default Value advanced property will allow you to set a default state for the CRM Yes/No widget to use. If there is no default value set it will default to CRM's default value. If neither are set, it will default to false.

TrueText

The TrueText advanced property will allow you to set the text of the 'Yes' selection of a CRM Yes/No widget to whatever you'd like.

FalseText

The FalseText advanced property will allow you to set the text of the 'No' selection of a CRM Yes/No widget to whatever you'd like.

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.

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.

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.

Display Type

The Display Type drop down list will allow you to alter the appearance of a widget. For example, you can configure a CRM Yes/No widget to appear as a pair of radio buttons, a horizontal slider, or even as a checkbox. Additionally, you can configure a numeric CRM Text Field to display a number as a currency or percentage.

Show Labels

The Show Labels advanced property will show labels based on the CRM Yes/No label text for AODA compliance. This property is only enabled when the widget is in radio button mode.

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.

Default Value

The Default Value advanced property will allow you to set a default state for the CRM Yes/No widget to use. If there is no default value set it will default to CRM's default value. If neither are set, it will default to false.

TrueText

The TrueText advanced property will allow you to set the text of the 'Yes' selection of a CRM Yes/No widget to whatever you'd like.

FalseText

The FalseText advanced property will allow you to set the text of the 'No' selection of a CRM Yes/No widget to whatever you'd like.

API

get_trueControl()

Returns the selected display type for the widgets' true choice as an object. 

Returns

RadComboBox, RadButton, RadSlider depending on configuration. 

get_falseControl()

Returns the selected display type for the widgets' false choice as an object. 

Returns

RadComboBox, RadButton, RadSlider depending on configuration.  

get_sliderParent()

Returns the parent div element if the widget is configured to be a slider. 

Returns

HTML Element 

get_dataFieldName()

Returns the developer name for the control. 

Returns

String

get_value()

Returns true or false based on the selection. 

Returns

Boolean

set_value()

Sets the selection of the widget. 

Returns

none

enable()

Enables the widget. 

Returns

none

disable()

Disables the widget. 

Returns

none

get_boolText()

Returns the value of the widget as a string.

Returns

String

set_boolText()

Sets the value of the boolean text. 

Returns

none

get_type ()

Returns the selected display's object as a string.

Returns

String

Full API With Examples

How to's

Examples of CRM Yes/No Configuration