Related Topics
Form Controls
This section outlines the various Process Director controls that can be placed onto Forms. These controls are used to create and enhance Forms in addition to “normal” ASP.NET controls (such as TextBox, DropDownList, etc). The properties can be set in the actual <bpx>
control tag, or can be set via normal C# properties.


This Form control will create a button a user can click to add row(s) to an array.
Properties
PROPERTY NAME |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|
ArrayName |
The name of the array this button is attached to. |
|
At |
The location to add the new row(s). |
0 (end of array). |
ConfirmText |
Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take. |
|
ImageURL |
Sets an optional image for the button. |
|
OnClientClick |
Used to execute client-side JavaScript or call client JavaScript functions. To prevent the button from causing a Post-back, place a return false; at the end of the JavaScript string. |
|
Rows |
The number of Rows to add. |
1 |
Text |
Sets the optional button text. |
|
Example
<bpx:AddRow runat="server" ArrayName="MyArray"/>


This Form control places a repeating template section on a Form. To default the array to a number of rows simply go to the Form properties page and click on the edit link next to the array control that is in the list of controls. Select Value à Number from the Default Value dropdown and enter the number to default the number of rows to.
Properties
None
Example
<table>
<tbody>
<tr>
<th>City</th>
<th>State</th>
</tr>
<bpx:Array ID="ArrayTest" runat="server">
<ItemTemplate>
<tr>
<td><bpx:bpTextBox ID="Text1" runat="server" /></td>
<td><bpx:bpTextBox ID="Text2" runat="server" /></td>
</tr>
</ItemTemplate>
</bpx:Array>
</tbody>
</table>


This Form control will create a button a user can click to remove a specific row from an array. You should place this control directly in an array, so that the button is displayed on each row.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
ConfirmText |
Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take. |
ImageURL |
Sets an optional image for the button. |
OnClientClick |
Used to execute client-side JavaScript or call client JavaScript functions. To prevent the button from causing a Post-back, place a return false; at the end of the JavaScript string. |
Text |
Sets the optional button text. |
Example
<bpx:ArrayRemoveRow runat="server"/>


This Form control will create a button a user can click to move a Row up in the array.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
ConfirmText |
Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take. |
ImageURL |
Sets an optional image for the button. |
OnClientClick |
Used to execute client-side JavaScript or call client JavaScript functions. To prevent the button from causing a Post-back, place a return false; at the end of the JavaScript string. |
Text |
Sets the optional button text. |
Example
<bpx:ArrayMoveUp runat="server"/>


This Form control will create a button a user can click to move a Row down in the array.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
ConfirmText |
Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take. |
ImageURL |
Sets an optional image for the button. |
OnClientClick |
Used to execute client-side JavaScript or call client JavaScript functions. To prevent the button from causing a Post-back, place a return false; at the end of the JavaScript string. |
Text |
Sets the optional button text. |
Example
<bpx:ArrayMoveDown runat="server"/>


This Form control will display a button to allow the user to attach files to the form.
Properties
PROPERTY NAME |
PROPERTY ATTRIBUTES |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|---|
AttachType |
Form Workflow Timeline Process |
Attach object(s) directly to Form, Attach object(s) to the current Workflow instance as a Workflow reference. Attach object(s) to the current timeline instance as a Timeline reference. Attach object(s) to the current Workflow or timeline instance. |
Process |
ClipboardImageName |
|
The optional name to use for the attached images. This parameter can use SysVars to make the name dynamic. If the items on the clipboard are files, the actual file name will be used as the new attachment name. |
|
ConfirmText |
|
Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take. |
|
GroupName |
|
Optional name of the group to place the attachment(s) into. |
|
ImageURL |
|
Sets an optional image for the button. |
|
ObjectType |
Document Clipboard |
Allow user to upload document Allow the user to use an item from the clipboard |
Document |
OnClientClick |
|
Used to execute client-side JavaScript or call client JavaScript functions. To prevent the button from causing a Post-back, place a return false; at the end of the JavaScript string. |
|
SingleFileUpload | When set to "true", restricts the upload to a single file. | false | |
Text |
|
Sets the optional button text. |
|
Example
<bpx:Attach ID="ControlName" runat="server" GroupName="Group"/>


This control enables the user to attach an object to a Form instance by browsing for the object using a Knowledge View.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
AttachToParent=[1|0] |
If set to 1, this object will be attached to the parent of this Form instance |
AttachType |
Form – attach object(s) directly to Form Workflow - attach object(s) to the current Workflow instance as a Workflow reference Process Timeline - attach object(s) to the current Process Timeline instance as an Process Timeline reference Process - attach object(s) to the current Workflow or Process Timeline instance |
CopyObject=[1|0] |
If set to 1, this object will be copied to the new location (leaving the old object alone) |
GroupName |
Only display objects from the specified group |
MoveObject=[1|0] |
If set to 1, this object will be moved to a new location (removing the object in its old location) |
QS |
A querystring to send data to the Knowledge View |
Text |
Text displayed on the Form button |
Example
{AttachKVIew:ControlName, AttachType=Form, GroupName=Group,
Text=Text to Display, MoveObject=0}


This Form control is used to place a button on a Form. The button will typically be used when hooking up to a Custom Task, or when writing custom C#.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
ConfirmText |
Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take. |
OnClientClick |
Used to execute client-side JavaScript or call client JavaScript functions. To prevent the button from causing a Post-back, place a return false; at the end of the JavaScript string. |
StartingCategory |
Sets an optional image for the button. |
Text |
Sets the optional button text. |
Example
This example will cause a Post-back to the server to process the event.
<bpx:bpButton ID="ControlName" Text="Text to Display" runat="server" />
This example will execute client JavaScript, and prevent a Post-back.
<bpx:bpButton ID="ControlName" Text="Text to Display"
OnClientClick="MyFunc();return false;" runat="server" />


This Form control places a two-state (checked - true/unchecked - false) checkbox on the Form. Useful for yes/no data and enabling/disabling sections on a Form.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
CssClass |
To set the CSS class name for this control. |
Text |
(optional) Accompanying label text for the check box |
Example
<bpx:bpCheckBox ID="ControlName" runat="server" Text="Text to Display" />


This Form control places a configurable image control on the Form. The ImageURL property is required, but all other properties are optional.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
ImageURL |
The fully qualified URL of the source image's location. |
Height |
Height of the image in pixels/percent. |
Width | Width of the image in pixels/percent. |
URL | The fully qualified URL of an asset to display when the image is clicked, i.e., to make the image a hyperlink. |
Target | The hyperlink target type, e.g. "_blank" for the image hyperlink. |
Style | Any CSS styles to apply to the image |
CssClass |
To set the CSS class name for this control. |
Alt | The alt text for the image. |
Example
<bpx:bpImage ImageURL="imgURL" Height="XX" Width="XXX" URL="HyperlinkTargetURL" Target="HyperlinkTarget"
Style="CSSStyles" CssClass="ClassName" Alt="Alt Image Text" />


This Form control will simply display Text. This can be used, for instance, when you'd like to conditionally show text. You can associate rules with this control to affect the visibility. You'll use C# to get/set the actual Text contents.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
CssClass |
To set the CSS class name for this control. |
Example
<bpx:bpLabel runat="server" ID="ControlName"/>


This Form control will display Text from a localized resource file. You can create custom localized strings in the strings.resx files to easily display strings in different languages on forms. You can associate rules with this control to affect the visibility.
Properties
PROPERTY NAME |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|
CssClass |
To set the CSS class name for this control. |
|
DefaultString |
String display while editing form definition in Design mode using VS plugin |
|
ResourceID |
Name of resource in strings.resx or resource.resx |
|
ResourceType |
Does string exist in strings.resx (Custom) or resource.resx (Internal) |
Custom |
Example
<bpx:bpString runat="server" DefaultString="StringValue"
ResourceID="ResIDString" />


This Form control puts a space for a user to enter text on a Form.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
Columns |
To set the number of columns the control will use. |
CssClass |
To set the CSS class name for this control. |
Rows |
To set the number of rows the control will use. |
TextMode |
SingleLine, Multiline, or Password |
Example
This example will cause a Post-back to the server
<bpx:bpTextBox ID="ControlName" runat="server" Columns="NN"/>


This Form control is used to control where the complete buttons for the Form are placed. Complete buttons are buttons such as OK, Cancel, Approve, Reject etc. The actual buttons that are placed in this area are dependent on the current Timeline Activity, if any. If this control isn't present on a Form, then the buttons are added to the bottom of the form.
Properties
PROPERTY NAME |
PROPERTY ATTRIBUTES |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|---|
CancelConfirmText |
|
Pops up a confirmation box when a user clicks the Cancel button with the specified text, allowing a user to return to the form or cancelling out of the form. |
|
CancelImageURL |
|
Optional path to the image used for the Cancel button on a Form |
|
CancelShow |
True |
Enables the form to show or hide the Cancel button. |
True |
CancelText |
|
Sets the text for the Cancel button |
Cancel |
CompleteConfirmText |
|
Pops up a confirmation box when a user clicks the Complete button with the specified text, allowing a user to cancel the Complete or continue to submit the form. |
|
CompleteShow |
True False |
Enables the form to show or hide the Complete button. |
True |
OKConfirmText |
|
Pops up a confirmation box when a user clicks the OK button with the specified text, allowing a user to cancel the OK or continue submitting the form. |
|
OKImageURL |
|
Optional path to the image used for the OK button on a Form |
|
OKShow |
True |
Enables the form to show or hide the OK button. |
True |
OKText |
|
Sets the text for the OK button |
OK |
Example
This example controls the location of the complete buttons, and changes the default text of the OK and Cancel buttons.
<bpx:ButtonArea runat="server" OKText="OK Text"
CancelText="Cancel Text"/>


This Form control calculates an expression and places the result as text on a Form.
Properties
PROPERTY NAME |
PROPERTY ATTRIBUTES |
DESCRIPTION |
---|---|---|
FormatString |
|
(optional) The format in which to display the result of the Formula (Defaults to "{0:0.00}") - See Microsoft's documentation on string formatting |
Formula |
|
Expression to calculate a numerical value (can accept System Variables) |
Example
<bpx:Calculate ID="ControlName" runat="server"
Formula="{#FORM:Field1} * {#FORM:Field2}"
FormatString="{0:0.0}" />


This Form control will place a button on a Form which will cancel or delete the current Form or Process Timeline.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
CancelProject |
This enables you to cancel the associated timeline. |
CancelWorkflow |
This enables you to cancel the associated Workflow. |
ConfirmText |
Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take. |
DeleteForm |
This enables you to delete the form. |
DeleteProject |
This enables you to delete the timeline. |
DeleteWorkflow |
This enables you to delete the Workflow. |
ImageURL |
Sets an optional image for the button. |
Text |
Sets the optional button text. |
Examples
To cancel associated Process Timeline:
<bpx:Cancel runat="server" CancelProject ="true"
Text="Text to Display">
</bpx:Cancel>
To just delete this form:
<bpx:Cancel runat="server" DeleteForm="true"
Text="Text to Display">
</bpx:Cancel>
To delete the Process Timeline and Form:
<bpx:Cancel runat="server" DeleteProject ="true"
DeleteForm="true" Text="Text to Display">
</bpx:Cancel>


This Form control will create a picker control to allow users to pick meta data categories.
Properties
PROPERTY NAME |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|
Multiple |
Enables you to select multiple categories from the picker. |
"false" |
StartingCategory |
Sets the initial category to display. |
|
Text |
Sets the optional button text. |
|
Example
<bpx:CategoryPicker runat="server"/>


This Form control enables a user to place a Comment Log on a Form.
Properties
PROPERTY NAME |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|
Columns |
(Optional) The number of columns to display while prompting for a comment |
70 |
ControlName |
(Optional) The name of the comment log section. Use this property if you have multiple comment logs on a Form |
|
Rows |
(Optional) The number of rows to display while prompting for a comment |
4 |
Text |
(Optional) The text for the button used to add a comment |
Add Comment |
Width |
(Optional) Width of the displayed comments |
100% |
Example
<bpx:CommentLog runat="server" ControlName=”ControlName” Width="50%"/>


This Form control enables a user to choose an object in the content list.
Properties
PROPERTY NAME |
PROPERTY ATTRIBUTES |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|---|
DocExtension |
|
(Optional) Limits the user to choose only documents of the specified extension (Type of "Document" only) |
|
StartingFolder |
|
(Optional) The path to a folder, limiting a user to choose only objects in that folder and its subfolders |
|
Type |
|
(Optional) The type of object (Folder, ContentObject, Script, etc.) to pick. |
Folder |
Example
<bpx:ContentPicker ID="ControName" runat="server"
Type="Document" DocExtension="pdf" />


This Form control will display a dropdown of all controls on this page.
Properties
PROPERTY NAME |
PROPERTY ATTRIBUTES |
DESCRIPTION |
---|---|---|
ControlType |
Input, Textarea, Date, Button, Dropdown, Password, Array, Section, Radio, CheckBox, Custom, CustomTaskConfigSection, CustomTaskRunSection, UserPicker, GroupPicker, Attach, ShowAttach, Label. |
Limits the type of control to show in the dropdown. |
DropdownPrompt |
|
Optional text to show on the dropdown if no user is selected |
Style |
To set the style (using any CSS style). |
|
Example
<bpx:ControlPicker ID="ControlName"
DropdownPrompt="Prompt Text"
runat="server" />


This Form control is a date/time combination picker control.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
EndTime |
(Optional) Sets the maximum time (of day) for the pre-selected picker values. Must exceed the StartTime value. |
Interval |
(Optional) The amount of time (in minutes) between pre-selected picker values. |
StartTime |
(Optional) Sets the beginning time (of day) for the pre-selected values available for the picker. |
Example
<bpx:DateTimePicker ID="ControlName" runat="server" />


This Form control is used to calculate the difference between 2 dates.
Properties
PROPERTY NAME |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|
Date1 |
The first date or date / time |
|
Date2 |
The second date or date / time |
|
Type |
(Optional) The type of the difference Years Months Days BusinessDays Hours BusinessHours Minutes Seconds |
Days |
Example
<bpx:DateDiff ID="ControlName" Date1="1/1/2000" Date2="{form:my_date2}"
runat="server"/>


This Form control will display a Database Connector Picker on the form.
Properties
PROPERTY NAME |
PROPERTY ATTRIBUTES |
DESCRIPTION |
---|---|---|
DropdownPrompt |
|
Optional text to show on the dropdown if no connector is selected |
Example
<bpx:DBConnectorPicker ID="ControlName" DropdownPrompt="Prompt Text"
runat="server" />


This Form control puts a dropdown control on the form.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
CssClass |
To set the CSS class name for this control. |
Mode |
Used to turn on type-ahead functionality for controls that use Business Values as their data source, by setting the mode to "AutoComplete", e.g.
|
Example
Dropdown with input items manually configured.
<bpx:DropDown ID="ControlName" runat="server" >
<asp:ListItem Text="DisplayText1" Value="Value1" />
<asp:ListItem Text="DisplayText2" Value="Value2" />
</bpx:DropDown>
Dropdown configured for use as a type-ahead dropdown for use with a Business Value.
<bpx:DropDown ID="ControlName" Mode="AutoComplete" runat="server" ></bpx:DropDown>


This Form control will display a Group Picker on the form.
Properties
PROPERTY NAME |
PROPERTY ATTRIBUTES |
DESCRIPTION |
---|---|---|
DropdownPrompt |
|
Optional text to show on the dropdown if no user is selected |
Height |
|
For ListBox PickerType only; sets the height of the ListBox control |
Multiple |
True |
Allow multiple users to be selected. |
PickerType |
Dropdown ListBox |
Dropdown – use a dropdown control ListBox – use a ListBox control. |
Width |
|
For ListBox PickerType only; sets the width of the ListBox control |
Example
<bpx:GroupPicker ID="ControlName" DropdownPrompt="Prompt Text"
PickerType="Popup" runat="server" Multiple="false" />


This Form control is used to create a group or section of controls and text on a Form. This section is used to tell the Form processor to ignore the controls inside this section. This can be used, for example, to surround custom controls so that the Form processor doesn't attempt to process the internal form fields.
Properties
None
Example
<bpx:IgnoreSection runat="server">
<!--Items in this section are ignored by the Form processor-->
</bpx:IgnoreSection>


This Form control is used to place a Knowledge View on the Form. You can use a button to open a Knowledge View or you can view a Knowledge View inline on the form.
Properties
PROPERTY NAME |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|
Height |
Only for iframe – The height of the iframe. |
300px |
QS |
Optional list of QueryString parameters to pass to the KView. The KView can, for example, use these QueryString parameters in its filters. Ensure that you've created a filter corresponding to each QS filter. You must use the QueryString type on the right side in the Knowledge View filter. |
|
Text |
Only for Popup – The text on the button. |
View Knowledge View |
Type |
Iframe – Displays the KView in an inline IFRAME on the form. Popup – A button will be shown on the form. When clicked, a pop window showing the KView will be launched |
Iframe |
Width |
Only for iframe – The width of the iframe |
100% |
Example
{KView:ControlName, Text="Text to Display", Type=Popup, QS="Query String 1",
QS="Query String 2"}
The syntax for the Form Builder is:
store={form: store}
appname={form: appname}


This Form control is used to place a List Box control on a Form, allowing a user to select more than one entry in the list. This ListBox control can be populated via Custom Tasks, scripts, or with the asp:ListItem tag. Note that commas in a ListBox item value aren't valid. For any ListBox item with a comma in the value, the comma will become a semi-colon upon ListBox creation (this doesn't apply when programmatically adding items).
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
Height |
(optional) The height of the ListBox control (e.g., 100px, 15ex, 25%, etc.) |
Items |
The collection of items in the ListBox - See ASP ListControlItems property for usage examples. |
SelectedValues |
A list of selected values in the Items collection |
SelectedValuesString |
A comma-separated string representation of the list of selected values in the Items collection |
Width |
(optional) The width of the ListBox control (e.g., 200px, 20em, 30%, etc.) |
Example
<bpx:ListBox ID="ControlName" runat="server">
<asp:ListItem Value="Value1" Text="DisplayText1" />
<asp:ListItem Value="Value2" Text="DisplayText2" />
<asp:ListItem Value="Value3" Text="DisplayText3" />
</bpx:ListBox>


This Form control puts a single print button control on the form.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
ConfirmText |
Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take. |
ImageURL |
Sets an optional image for the button. |
Style |
To set the style for this control. |
Text |
Displays the label of the button. |
Example
<bpx:Print ID="ControlName" Text="Text to Display" runat=”server” />


This Form control puts a Radio Group control on the form.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
CssClass |
To set the CSS class name for this control. |
Example
<bpx:Radio ID="ControlName" runat="server" CssClass="MyClass">
<asp:ListItem Text="DisplayText1" Value="Value1" />
<asp:ListItem Text="DisplayText2" Value="Value2" />
</bpx:Radio>


This Form control puts a Rating control on the Form.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
ItemCount |
The integer number of stars to display for the rating, up to a maximum of ten. |
Precision | Determines whether or not the rating consists of whole stars or some other increment. |
Example
<bpx:Rating runat="server" ID="ControlName" ItemCount="<int>" Precision="Item|Half|Exact" />


This Form control will create a button a user can click to remove row(s) to an array.
Properties
PROPERTY NAME |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|
ArrayName |
The name of the array this button is attached to. |
|
At |
The location to remove the new row(s). |
0 (end of array). |
ConfirmText |
Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take. |
|
ImageURL |
Sets an optional image for the button. |
|
OnClientClick |
Used to execute client-side JavaScript or call client JavaScript functions. To prevent the button from causing a Post-back, place a return false; at the end of the JavaScript string. |
|
Rows |
The number of Rows to remove. |
1 |
Text |
Sets the optional button text. |
|
Example
<bpx:RemoveRow runat="server" ArrayName="MyArray"/>


This Form control places a rich text editor on a Form. This enables a user to enter text as well as format it and place links and other rich text controls within the Form control.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
Height |
(optional) The height of the ListBox control (e.g., 100px) |
Width |
(optional) The width of the ListBox control (e.g., 200px) |
Example
This example will cause a Post-back to the server.
<bpx:RichText ID="ControlName" runat="server" Height="NNNpx" Width="NNNpx" />


Display the routing slip for the Process Timeline package on the form.
Properties
PROPERTY NAME |
DESCRIPTION |
PROPERTY ATTRIBUTES |
DEFAULT VALUE |
---|---|---|---|
ActiveActivityOnly |
Should the routing slip only display the active activity? |
True False |
False |
ActiveStepOnly |
Should the routing slip only display the active step? |
True False |
False |
ActivityName |
An optional comma-separated list of activities to display the routing slip in |
|
|
MostRecentInstance |
Should the routing slip display only the most recent step instance? If this is false, then the routing slip will show the users every time a step ran. |
True False |
False |
ShowCancelled |
Should routing slip display users that have been canceled? |
True False |
True |
ShowComments |
Should Routing Slip display the comments? |
True False |
True |
ShowCompleted |
Should routing slip display users that have completed the step? |
True False |
True |
ShowCompletedOn |
Shows the date the task was completed for each participant in the routing slip. |
True False |
False |
ShowHeader |
Should Routing Slip display the header. |
True False |
True |
ShowInitiator |
Should the process initiator be displayed? |
True False |
false |
ShowParticipants |
Shows the name of each participant. You can use this, for example, to hide the names of the participants, and only show the signature image. |
True False |
True |
ShowPending |
Should routing slip display users that have not began? |
True False |
False |
ShowReassigned |
Should routing slip display users that have been reassigned? |
True False |
True |
ShowResult |
Shows the Result column in the routing slip. |
True False |
True |
ShowRunning |
Should routing slip display users currently running? |
True False |
True |
ShowSignatures |
Should routing slip display user’s signatures? |
True False |
True |
ShowStatus |
Shows the Status column in the routing slip. |
True False |
True |
ShowStep |
Groups the users in the routing slip according to the step they ran in. |
True False |
True |
ShowTimedOut |
Should routing slip display users that have timed out? |
True False |
True |
StepName |
An optional comma-separated list of steps to display the routing slip in. |
|
|
TimelineName |
A partial match for a timeline definition name, restricting the routing slip to be displayed in the matching Timelines. |
|
|
UseDateTime |
Optionally shows Date and Time if true |
True False |
False |
WorkflowName |
A partial match for a Workflow definition name, restricting the routing slip to be displayed in the matching Workflows. |
|
|
Example
This example will show the routing slip for a single step
<bpx:RoutingSlip runat="server" StepName="Step Name"/>
This example will show the routing slip for the active step and only show the active users.
<bpx:RoutingSlip runat="server" ActiveStepOnly="true"
ShowRunning="true" ShowCompleted="false"
ShowCancelled="false" ShowTimedOut="false"/>


The “save” (close=false) will only appear when the user is viewing the form in a process task. The “save and close” (close=true) will always appear. The “save and close” will add an entry to the users task list.
Properties
PROPERTY NAME |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|
Close |
The Close parameter can be set to true or false. |
True |
ConfirmText |
Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take. |
|
ImageURL |
Sets an optional image for the button. |
|
Text |
Sets the optional button text. |
|
Example
This example will cause a Post-back to the server to save the form contents.
<bpx:Save ID="ControlName" runat="server" Text="Text to Display"
Close="true"/>


This Form control is used to create a group or section of controls and text on a Form. This section can be used to apply formatting, required setting, enabling, or visibility rules to all elements in a section.
Properties
PROPERTY NAME |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|
BodyCssClass |
To set the CSS class name for the body of the section. |
|
BodyStyle |
To set the style (using any CSS style) for the body of the section. |
|
CanCollapse |
Set this property to “true” males this section a collapsible section. |
False |
CollapseImageURL |
Optional URL to image to use for Collapse |
|
Expanded |
Set to true to have the control viewed in the Expanded state initially. Set to false to have the control viewed collapsed initially. |
True |
ExpandImageURL |
Optional URL to image to use for Expand |
|
HeaderCssClass |
To set the CSS class name for the header. |
|
HeaderStyle |
To set the style (using any CSS style) for the header. |
|
Text |
The text for the “header” of the CollapseSection |
|
WrapperTag |
The section can optionally be enclosed with an HTML element such as a div or span. A div uses “block” formatting in HTML (so that the section appears on the next line), where the span uses “inline” formatting. |
Div |
Example
This sample will create a section on a form to collect addresses. The section will be surrounded with an HTML DIV block.
<bpx:Section runat="server" ID="ControlName">
<!--Some Form controls-->
</bpx:Section>
This sample will create a section that flows “inline” with the surround HTML.
<bpx:Section runat="server" ID="ControlName" WrapperTag="span">
<!--Some more Form controls and HTML-->
</bpx:Section>


This Form control will display a table showing the attachments that match the desired criteria.
Properties
PROPERTY NAME |
PROPERTY ATTRIBUTES |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|---|
AttachType |
Form Workflow Project Process |
Attach object(s) directly to Form Attach object(s) to the current Workflow instance as an Workflow reference Attach object(s) to the current timeline instance Attach object(s) to the current Workflow or timeline instance |
Process |
GroupName |
|
Optional filter of the group that attachments must belong to. |
|
NameAsView |
True False |
Enables the attachment name to be a hot link. Same fucntionality as the ShowView property. |
False |
ObjectType |
Document Form NotSet |
Only shows documents. Only shows form instances Shows all types of objects |
NotSet |
ShowDate |
True |
Show the date for each attachment? |
True |
ShowDownload |
True |
Show the Download link for each document attachment? |
True |
ShowEdit |
True |
Show the Edit link for each document attachment? |
False |
ShowRemove |
True |
Show the Remove link for each attachment? |
True |
ShowUser |
True |
Show the user for each attachment? |
True |
ShowView |
True |
Show the View link for each attachment? |
True |
Text |
|
Sets the optional text to display above attachments. |
|
ViewInline |
True |
Enables the user to select a document to view inline on the Form in an IFRAME. |
False |
ViewInlineHeight |
|
Optional parameter to set the height of the IFRAME for the selected document. Use any HTML compatible string such as 300px. |
200px |
Example
<bpx:ShowAttach ID="ControlName" runat="server" GroupName="Group"/>


This Form control will add an Iframe to the Form showing a Knowledge View of attached objects.
Properties
PROPERTY NAME |
PROPERTY ATTRIBUTES |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|---|
AttachType |
Form Workflow Process Timeline Process |
show object(s) attached to Form show object(s) attached to the current Workflow instance as a Workflow reference show object(s) attached to the current Process Timeline instance as a Process Timeline reference show object(s) attached to the current Workflow or Process Timeline instance |
Process |
GroupName |
|
Specifies to which group objects shown on the Knowledge View should be restricted. |
|
Height |
|
Height of the Iframe in pixels. |
|
ShowParents |
|
If set the 1, the Knowledge View will show the parents of the object. |
Null (parent isn't shown) |
Width |
|
Width of the Iframe in pixels. |
|
Example
<bpx:ShowAttachKView ID="ControlName", Height="NNN", Width="NNN" />


This Form control will add a viewer to a Form to display a Report object in the Form.
Properties
PROPERTY NAME |
PROPERTY ATTRIBUTES |
DESCRIPTION |
---|---|---|
Height |
The height, in pixels, of the Report's display on the Form. | |
ID |
|
The Control's ID. |
ImageOnly |
Boolean | Display an image only for the Report |
ImageURL |
The IRL of an image to display for the Report. | |
QS |
The query string to use for the report's parameters, if any. | |
RID |
The Report's ID. | |
SmallImage |
Boolean | Display the image in a small format. |
Text |
Text to display as the Report's Title. | |
Type |
IFrame |
The display type for the control to display on the form. |
Width |
The Width, in pixels, of the Report's display on the Form. |
Example
<bpx:ShowReport ID="ControlName" runat="server" RID="ReportID" Height="NNN" Width="NNN"
Text="Text to Display" ImageURL="ImgURL" ImageOnly="true" SmallImage="True" Type="IFrame"
QS="Query String">
</bpx:ShowReport>


This Form control will display a textbox on the form to enter Workflow comments.
Properties
PROPERTY NAME |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|
Columns |
Sets the width of the textbox. |
70 |
Rows |
Sets the height of the textbox. |
4 |
Style |
To set the style for this control. |
|
Text |
Sets the optional default text in the textbox. |
|
Example
<bpx:SignatureComments id="ControlName" runat="server"
Text="Text to Display"/>


This Form control will display Slider control on the Form to set a value between 0 and 100.
Properties
PROPERTY NAME |
DESCRIPTION |
DEFAULT VALUE |
---|---|---|
TrackPosition |
The visual position of the track indicator. |
BottomRight |
Height |
Sets the height of the control. (Optional) |
|
Width |
Sets the width of the control. (Optional) |
|
ShowDecreaseHandler |
Displays the icon to decrease the slider value. (Optional) |
True |
ShowIncreaseHandle | Displays the icon to increase the slider value. (Optional) | True |
WrapperTag | The outer HTML tag, e.g. "DIV" to use as a container for the control, if any. (Optional) | |
Alt | The Alt Text to use for accessibility. |
Example
<bpx:Slider runat="server" TrackPosition="BottomRight|Center|TopLeft" ID="ControlName"
Style="CSSStyles" CssClass="ClassName" Height="<int>" Width="<int>"
ShowDecreaseHandler="true|false" ShowIncreaseHandle="true|false"
WrapperTag="HTMLTag" Alt="Alt Text" />


This Form control will place a button on a Form which will sort an array.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
ArrayName |
Specify the name of the array to sort. |
Descending |
Specify true to sort in descending order. |
ImageURL |
Sets an optional image for the button. |
Primary |
Specify the column name of the primary sort key. |
Secondary |
Specify the column name of the optional secondary sort key. |
Tertiary |
Specify the column name of the optional tertiary sort key. |
Text |
Sets the optional button text. |
Examples
<bpx:Sort runat="server" ID="ControlName" Text="Text to Display"
ArrayName="MyArray" Primary="ColumnName" />


This Form control is used to evaluate and display a System Variable. You can pass an entire System Variable string in the SysVarString property, or you can break apart the System Variable into individual properties.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
|
-Or- |
Encode |
Optionally set the encoding type. |
IfNull |
Optionally set the “If sysvar is null” string. |
Post |
Optionally set the “postfix” string. |
Pre |
Optionally set the “prefix” string. |
SysVarName |
Set the system Variable name. |
SysVarNamedParms |
Optionally sets the System Variable named parameters. Multiple parameters can be passed separated by a comma. |
SysVarParms |
Optionally sets the System Variable parameters. Multiple parameters can be passed separated by a colon. |
SysVarString |
Set this property to pass an entire System Variable in one string. |
Example
<bpx:SysVar ID="ControlName" runat="server" SysVarName="SYSVAR_NAME"
SysVarNamedParms="SysVarParam1:SysvarParam2"/>
Use Case Examples
This example displays the date 1 week from now.
<bpx:SysVar ID="SysVar1" runat="server" SysVarName="CURR_DATE"
SysVarNamedParms="Days=7"/>
This example displays the current user’s ID on the form. Notice the ! to HTML-encode the string.
<bpx:SysVar ID="SysVar2" runat="server" SysVarString="{!CURR_USER }"/>


This control is used to identify each tab in a tab strip. The value of the TabStrip will be the selected Tab.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
PageViewID |
The ID of the related TabContent control |
Text |
Optional text for the actual Tab |
Value |
Optional value for the control if this tab is selected |
See the TabContent control below for an extended code sample.


This Form control contains the actual content for a single tab. You can place any number of Form controls inside a TabContent section.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
ID |
The ID of the content for the tab strip |
Example
<bpx:TabStrip runat="server" ID="MyTabStrip"
MultiPageID="MyTabStrip_Content">
<Tabs>
<bpx:Tab runat="server" PageViewID="tab1" />
<bpx:Tab runat="server" PageViewID="tab2" />
</Tabs>
</bpx:TabStrip>
<bpx:TabStripContent runat="server" ID="MyTabStrip_Content">
<bpx:TabContent ID="tab1" runat="server">
<!--Form data inside tab 1. This can include any form control-->
</bpx:TabContent>
<bpx:TabContent ID="tab2" runat="server">
<!--Form data inside tab 2-->
</bpx:TabContent>
</bpx:TabStripContent>


This Form control creates a tab strip section.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
ID |
Optional ID if the value of the selected tab should be maintained |
MultiPageID |
The ID of the related TabStripContent control |
See the TabContent control above for an extended code sample.


This control identifies the actual contents of the various tabs.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
ID |
The ID of the content for the tab strip |
See the TabContent control above for an extended code sample.


This Form control places a picker for selecting time values on a Form.
Properties
PROPERTY NAME |
DESCRIPTION |
---|---|
EndTime |
(Optional) Sets the maximum time (of day) for the pre-selected picker values. Must exceed the StartTime value. |
Interval |
(Optional) The amount of time (in minutes) between pre-selected picker values. |
StartTime |
(Optional) Sets the beginning time (of day) for the pre-selected values available for the picker. |
Example
<bpx:TimePicker ID="ControlName" runat="server" StartTime="11AM"
EndTime="3:45pm" Interval="15" />


This Form control will display a User Picker on the form.
Properties
PROPERTY NAME |
PROPERTY ATTRIBUTES |
DESCRIPTION |
---|---|---|
DropdownPrompt |
|
Optional text to show on the dropdown if no user is selected |
Height |
|
For ListBox PickerType only; sets the height of the ListBox control |
InGroup |
|
Optional filter to only show users that are members of the specified group. |
Multiple |
True |
Allow multiple users to be selected. |
PickerType |
Dropdown ListBox |
Dropdown – use a dropdown control |
Width |
|
For ListBox PickerType only; sets the width of the ListBox control |
Example
<bpx:UserPicker ID="ControlName" DropdownPrompt="Prompt Text"
PickerType="Popup" runat="server"
Multiple="true" InGroup="GroupName" />
Form Controls and JavaScript
You can use JavaScript to access the actual HTML controls for BP Logix controls and bind JavaScript events to them. For example, the JavaScript:
CurrentForm.FormControls["YOUR_CONTROL"]
returns the HTML object in JavaScript. Therefore, you could use:
CurrentForm.FormControls["BpTextBox1"].onkeypress = BpTextBox2_Keypressed;
to bind to the onkeypress event.
Note that if you want this event to fire even after a postback (such as a button event), you should place this into a bpUserJavaScript function on your page. This function will be called after the initial page load, AND after each postback. For example, place this on your ASCX page:
function bpUserJavaScript()
{
CurrentForm.FormControls["ControlName"].onkeypress = BpTextBox2_Keypressed;
}
In addition, you can simply use the native ASP.NET textbox, checkbox, radio button, or dropdown controls and their corresponding server tags, and use standard JavaScript for those controls. Other native ASP.NET controls aren't supported for this functionality.
Documentation Feedback and Questions
If you notice some way that this document can be improved, we're happy to hear your suggestions. Similarly, if you can't find an answer you're looking for, ask it via feedback. Simply click on the button below to provide us with your feedback or ask a question. Please remember, though, that not every issue can be addressed through documentation. So, if you have a specific technical issue with Process Director, please open a support ticket.