BPC-Components

Home > Products > BPC PowerForms > Knowledge Base > API Reference > The RadioButtons control

The RadioButtons control


Designer Properties

Type : RadioButtons

Name

Provides a unique name for the control.

Binding

Indicates if the control is

  • Unbound
  • Bound to list column
  • Is a label for a control bound to list column

Enabled for new records

Sets if the control will be enabled or disabled when the forms handles a new record

Enabled for existing records

Sets if the control will be enabled or disabled when the forms handles an existing record

Required

Marks the cotnrol as Required.

By default, the system recognizes required fields and marks them with this flag. Additionaly, controls can be marked as required event if the bound column is not.

Enabled Formula

Set an expression then will be evaluated during run-time and enable or disable the control.

The expression must be in javascript and should return a boolean value.

Dependencies between controls are automatically identified and the expression is re-calculated every time a control affecting the formula changes.

Example :

Code

form.GetControl("c_Status").GetValue() != "Open" && form.UserInGroup("Administrators")

Visibility Formula

Define a valid formula (using javascript) that will be evaluated during runtime to show or hide the control.

The expression should return a boolean value.

For example :

Code

form.FieldValue("c_Status") != "Rejected" || form.UserID() == "1"

Value

This property defines how the control will get its value.

 

Here are the available options :

  1. The value is Static (this is the default for label controls)
  2. The value will be provided by the user (Not applicable for labels)
  3. The value will be calculated by a formula
  4. The value will be retrieved from a list query
  5. The value will be provided by a web service call
  6. The value will be provided by a SQL query
Static value

A static text must be set in the appropriate designer control.

Formula

A javascript expression must be set that will provide the value for the control.

If the formula contains references to other controls, dependencies will be automatically identifies during run-time and the value will be updated to reflect changes.

Example :

Code

form.FieldValue("c_Active") ? "Yes" : "No"

There is an additional option that instructs the form to perform calculations only for new records. Existing records will keep their original value.

List Query

A predefined list query is bound to the value of the control. So during form initialization, the specified list query is executed and if it returns any item, it selects the first one and it will apply the value to the label based on the following rule :

If a Field Name has been selected in the corresponding box, that specific column will be used from the list item to fill the control value.

If the Field Name is left blank, the first column retrieved will be used.

Web Service

The same as above, the required web service is selected and after the web service retrieves data, the first item will be used to update the control value. If no Field Name is set, the control will receive the first field of the  retrieved item.

SQL Query

Works the same way ListQueries and Web Service works.

Default Value

The default value has any effect only of the control is bound to a list column.

For unbound controls, the default value is ignored.

You may set a static value here or use a formula by starting your input with the "equals" (=) sign.

 

Layout Properties

Width

Defines the width of the control.

When the value is zero, the maximum allowed width will be used.

Height

Defines the control height.

If the value is zero, the height property will not be set. 

H.Alignment

Defines the horizontal alignment of the parent cell (values : left, right, center)

V.Alignment

Defines the vertical alignment of the parent cell (values : top, bottom, center)

Fore Color

Defines the fore color of the control

Back Color

Defines the Background color of the control.

Cell Color

Defines the color of the parent cell.

Font Size

Declares the font size of the text

Margin

Sets the margin applied to the control, that is, the spacing between the control and the cell borders.

Font Bold

Changes the weight of the font used

Italics

Changes the font style for the control text

 

Lookup Details

If the control is bound to a choice column, then the Static Values property is automatically filled with the underlying values from the column. The property is read-only as every change in the column values will be automatically reflected in the control values.

 

If the control is bound to a lookup column, then the list info should be filled in.
The Site Url, List (and/or View) properties should be defined.
The normal behavior of lookup columns is to display the Title and save the ID of the selected record.
For that reason, 2 properties can be defined in the Lookup Details tab: Display Field & Value Field.
These properties should be automatically filled when first registering PowerForms for an existing list/content type.
In order to add criteria for the list query that will provide control data, use the criteria options.

 

 

 

Extra Configuration

Columns

Splits the CheckBoxes into different columns. The property ignores the value 0 (zero) and translates it into 1 column regardless.

SaveValueFieldOnly

Set this property to TRUE to force the control to send only the Value Member value of the underlying lookup value when saving its value. Normally lookup controls that load data from other lists, use the ID;#TITLE format to save data

IncludeBlankOption

Adds an additional blank option

UniqueField

If the internal name of a column is supplied, the retrieved results will be filtered allowing unique values for that specific field

Sorted 

Defines if the results will be sorted by the Display Field

SameColumnWidth

Defines if the columns that will be created (if more that one) will all have the save width

 

Script

Sets the script that will be executed at the value-change event of the control.

Example :

Code

var value = form.GetControl("c_Title").GetValue();

if (value == "Open") form.HideSection("Details");

else form.ShowSection("Details");

 

 

Control Events

 

ItemCreated

This event will fire as soon as you perform a search, select an item and press on the OK button. You can register the event in the form's LoadCompleted event.
Example:
Show an alert message to the user, displaying the ID and Title of the selected item.

Code

var ctrl = form.GetControl("c_Control1").InputControl;
 
ctrl.ItemCreated.AddHandler(function (e4) {
   alert("Selected Item ID : " + e4.DataItem.ID + ", Selected Item Title : " +  e4.DataItem.Title);
});