The PeoplePicker control
The PeoplePicker control is used to load users and groups from two different sources. It can access data from sharepoint or from Active Directory.
The users and groups are not loaded during form startup so this control is the most suitable to display large amount of users and groups.
It allows users to search for the required value using a popup search form, activated by the "Browse" button.
The value of the control is in the following format (when accessed from script using the GetValue() method) :
// Bound to lookup entity
Type : PeoplePicker
Provides a unique name for the control.
Indicates if the control is
- 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
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.
Set an expression then will be evaluated during run-time and enable or disable the control.
Dependencies between controls are automatically identified and the expression is re-calculated every time a control affecting the formula changes.
form.GetControl("c_Status").GetValue() != "Open" && form.UserInGroup("Administrators")
The expression should return a boolean value.
For example :
form.FieldValue("c_Status") != "Rejected" || form.UserID() == "1"
This property defines how the control will get its value.
Here are the available options :
- The value is Static (this is the default for label controls)
- The value will be provided by the user (Not applicable for labels)
- The value will be calculated by a formula
- The value will be retrieved from a list query
- The value will be provided by a web service call
- The value will be provided by a SQL query
A static text must be set in the appropriate designer 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.
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.
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.
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.
Works the same way ListQueries and Web Service works.
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.
Defines the color of the parent cell.
Declares the font size of the text
Sets the margin applied to the control, that is, the spacing between the control and the cell borders.
Changes the weight of the font used
Changes the font style for the control text
This control belongs in the People controls which have only one method enabled.
The method enabled is :
This is the default method if the underlying column is a people column.
The property indicates that only users (not Groups) will be included in the retrieved lookup records
Cannot be set in People Combo box. In People Picker and MultiPeople Picker if this property is checked,
the records will be loaded automatically when opening the search popup dialog.
Users can select one or more SharePoint groups to restrict results loading users only from the specified groups.
This options is available only when the "People Only" property is selected.
When this property is set to True, the control searches Active Directory users also the same way that SharePoint does in People Pickers and requires the user to provide a search filter. If set to False, it retrieves users and groups from SharePoint groups.
Allows the user to input a free-text user name/email into the people picker textbox. Useful in custom claims provider cases where out of the box user search and validation does not work.
Sets the script that will be executed at the value-change event of the control.
var value = form.GetControl("c_Title").GetValue();
if (value == "Open") form.HideSection("Details");