Dropdown Object Class

This object is derived from the ContentObject class. This object represents a Content Object of the DropDown type. It contains a list of name/value pairs which can fill a DropDown on a Form.

Properties

PROPERTY NAME

 DATA TYPE

DESCRIPTION

Values

 List Object

The list of name/value pairs for the dropdown as a List<DropDownValue> class

DDID

 String

The DropDown ID of the DropDown Content Object (same as ID property)

Methods

Link

This API will return a DropDownObject which corresponds to the ID you pass it.

Parameters

BP: The Process Director BP Object.

DDID: The ID of the Dropdown Object to retrieve

Returns

DropDownObject: An instance of the DropDownObject, or null if no DropDown could be found.

Example

var cDD = CurrentForm.FormControl("DropDownPick").Value;
// if "DropDownPick" is a ContentPicker on a Form
var dd = DropDownObject.GetDropDownByDDID(bp, cDD);
// Now we can use dd for our DropDownObject
bp.log0("Number of entries in the DropDown: " + dd.Values.Count);

Link

This API sets the list of DropDown name/value pairs.

Parameters

Values: The list of name/value pairs for the DropDown as a List<DropDownValue> (or other IEnumerable) class.

Returns

Boolean: Whether or not the call could set the DropDownObject's values.

Example

var ddvlist = new List<DropDownValue>();
ddvlist.Add(new DropDownValue("[Select a State]", ""));
ddvlist.Add(new DropDownValue("California", "CA"));
ddvlist.Add(new DropDownValue("Texas", "TX"));
var cDD = CurrentForm.FormControl("DropDownPick").Value;
// If "DropDownPick" is a ContentPicker on a Form
var dd = DropDownObject.GetDropDownByDDID(bp, cDD);
dd.SetDropDownValues(ddvlist);
// Will set DropDown to contain:
// "[Select a State]:''",
// "California:CA",
// "Texas:TX"