Loading...

Yes/No Field

Properties API Related

Widget Type:
Form Widgets
TPC Version:
  • 4.0
yesnologo
The Yes/No Field allows you to view or modify a simple Boolean CRM field. It picks up the CRM labels associated with a particular field and displays their string value. For example True/False, Male/Female, or Allow/Do Not Allow. 

The Input Mode dropdown list allows you to specify an appearance for the widget to take. By default it is set to dropdown list.

YesNoExample

Configuration

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 CRM Yes/No widget from The Portal Connector tools into the body of your form 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 Input Mode will allow you to specify the appearance.  By default it is set to dropdown list. Available options include: Dropdown list, Checkbox, Radio Button Group, and Switch.

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


yes-no--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).

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.

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

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. 

FalseLabelOverride

The FalseLabelOverride advanced property allows you to change the 'false' label. By default this is left blank.

TrueLabelOverride

The TrueLabelOverride advanced property allows you to change the 'true' label. By default this is left blank.

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

PlaceholderText

The Placeholder Text  will ‘fill’ the text box with whatever you enter here. This can be used to help guide user input or to give an example of proper input.

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

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.

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

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. 

FalseLabelOverride

The FalseLabelOverride advanced property allows you to change the 'false' label. By default this is left blank.

TrueLabelOverride

The TrueLabelOverride advanced property allows you to change the 'true' label. By default this is left blank.

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

PlaceholderText

The Placeholder Text  will ‘fill’ the text box with whatever you enter here. This can be used to help guide user input or to give an example of proper input.

API

get_type()

Returns the widget type.

Returns

String

clear()

Clears the value of the widget.

Returns

None

enable()

Enables the widget on the page.

Returns

None

disable()

Disables the widget on the page.

Returns

None

get_input()

Returns the input element of the widget.     

Returns

jQuery Object

get_element()

Returns the element of the widget.

Returns

jQuery Object

get_container()

Returns the container element of the widget.

Returns

jQuery Object

hide()

Hides the widget from the form.

Returns

None

show()

Shows the widget on the form.

Returns

None

get_value()

Returns the value of the widget.

Returns

Boolean

set_value()

Sets the value of the widget.

Returns

None

get_textValue()

Returns the text value of the widget.

Returns

String

set_textValue()

Sets the value of the widget by a text label.

Returns

None

get_kendoInput()

Returns the Kendo Object associated with the widget.

Returns

Kendo Object:
Kendo.ui.DropDownList Object if DropDownList
Kendo.mobile.ui.Switch Object if Mobile Switch
Null if RadioButton or Checkbox

get_displayInput()

Returns the boolean display associated with the widget.

Returns

jQuery Object

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

get_model()

Returns the model object of the widget, which contains a number of useful properties related to the widget.
In the case of the Yes/No Field widget, these returned properties and their types are:

  • BooleanLabels: Array
  • InputMode: Integer
  • ReadOnly: Boolean

Returns

Object     

toggle()

Toggles the visibility of the widget.

Returns

None

readonly()

 Sets the widget state to read only.

Returns

None

Full API With Examples

Examples of Yes/No Field Configuration