Loading...

Status Field

Properties API Related

Widget Type:
Form Widgets
TPC Version:
  • 4.0
statuslogo
The Status Field widget will allow you to toggle a records' status (active vs inactive) on Form Submission. Inactive records are read-only while active records can be changed.

Configuration

From the Portal Connector widget list, click and drag the Status Field widget into the body of your form. Click on the edit button to display the prompt. 

The Title will allow you to set the label for the control.

The Entity State Filter allows you to determine what choices are available to a user, including Active states, Inactive states, or both.

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.
status-value-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.

Entity State Filter

The Entity State Filter drop down will allow to select: Active, Inactive or All States

Inactive records are static and cannot be edited while active records may be edited.

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. 

ClientSideRequired

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

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

Hide Title

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

ShowBadges

Show badges view when this property set to true. 

RequiredIndicationLabel

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

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.

Entity State Filter

The Entity State Filter drop down will allow to select: Active, Inactive or All States

Inactive records are static and cannot be edited while active records may be edited.

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. 

ClientSideRequired

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

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

Hide Title

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

ShowBadges

Show badges view when this property set to true. 

RequiredIndicationLabel

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

API

enable()

Enables the widget on the page.

Returns

None

get_type()

Returns the widget type.

Returns

String

clear()

Clears the value of the widget.

Returns

None

disable()

Disables the widget on the page.

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     

get_container()

Returns the container element of the widget.

Returns

jQuery Object     

get_element()

Returns the element of the widget.

Returns

jQuery Object

get_fetchValue()

Returns the value of the widget that is compatible with FetchXML filtering.

Returns

String

get_input()

Returns the input element of the widget.

Returns

jQuery Object

get_selectedText()

Returns the text label of the selected value of the widget.

Returns

String

get_value()

Returns the value of the widget.

Returns

String

set_selectedText()

Sets the value of the widget by its text label.

Returns

None

set_value()

Sets the value of the widget.

Returns

None

hide()

Hides the widget from the form.

Returns

None

show()

Shows 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.
In the case of the CRM Status widget, these returned properties and their types are:

  • IsHidden: Boolean
  • LabelPosition: Integer
  • Options: Array
  • ReadOnly: Boolean

Returns

Object

remove_valueChanged()

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

Returns

None     

toggle()

toggles the visibility of the widget.

Returns

None

readonly()

 set the widget state to read only

Returns

None

Full API With Examples

Examples of Status Field Configuration