Control Properties

Properties

Note: A Name, Data Ref, or Input Data Ref can include letters and numbers. Additionally, the following characters are permitted but cannot begin the name: hyphens, underscores, and periods.

Property	Description	Fields Where Available
Name	The identifier of the control in the label template, form, or reusable object. A field name is the link between a label and data entry.	All fields
Data Ref	Data reference. The data source used to populate the field with a value. Tip: By default, Data Ref fields are case sensitive. If the label template is intended for use with an SAP BC-XOM integration or an SAP RFC integration, use only uppercase text in the Data Ref field.	All fields
Input Data Ref	The data reference for a data source, such as a Database data source, from which a Prompt field obtains data.	All fields except Button
Options Data Ref	A reference to a data map entry from which the list of options for the Drop-Down List or Radio Button Group is obtained.	Drop-Down List Radio Button Group
Entity Type	Whether this is a Device Selector, Folder Selector, Label Selector, or User Selector.	Selector
Style Data Ref	A reference to the location in the data map from which the control obtains styling. For more information, see Style a Button or Style a Check Box. Example /MyStyles Note: Styles defined by a Style Data Ref override the styles configured in the ribbon.	Button Check Box
Default Value	The default option value or content for the field. If the field is populated by a Data Ref that returns a null value A value that is unknown. A null value is different from an empty string or a zero value., then the default value is used instead. Note: For controls that have both an option name and an option value, this is the option value. Important! For a Check Box field, this value must be either true (selected) or false (cleared).	Check Box Drop-Down List Prompt Radio Button Group Text Box Prompt
Prompt	Text displayed next to or in a prompt or a drop-down list in a form.	Drop-Down List Prompt Form Prompt Text Box Prompt
Label Text	Text displayed adjacent to a check box.	Check Box
Button Label	Text displayed on button.	Button
Use Image	Image used as a button.	Button
Prompt Type	Text: Data for this prompt is text. Default. Mask Text: The information entered in the field is displayed as asterisks for concealment. Scan Only: Data for this prompt can be entered only by scanning.	Prompt
Lines	If Text is selected for Prompt Type, the number of text rows in the field. Note: If Mask Text or Scan Only is selected for Prompt Type, you cannot set the number of lines and a single line of text is displayed in the canvas.	Prompt
Chars Per Line	The maximum number of characters on a line within the field.	Prompt
Force Max Chars	Whether Data Providers are required to enter the number of characters specified by the Max Chars property. : Data Providers may enter any number of characters up to the number specified by Max Chars. : Data Providers must enter exactly the number of characters specified by Max Chars.	Prompt
Character Mask	Type of characters that are permitted in the field. None indicates that there is no masking and any characters are permitted. The following options are available: None Alpha-Numeric Alpha-Only Code 39 Code 93 Full ASCII Hexadecimal Numeric-Only GS1 GS1-128 Alpha-Numeric Uppercase Alpha-Numeric Uppercase Alpha-Only	Prompt
Entry Type	Whether a Data Provider Person or process that enters data into a form or other data entry view for a label that was configured by a Designer. A user acting as a Data Provider requires the DOCUMENT_PRINTER role or equivalent permissions. is required to provide data for this field. Optional: The field may be left empty. Mandatory: The field must have content. Must Fill: The maximum number of characters (Max Chars) for the field must be entered. This value is not available for Text Box Prompt fields.	Prompt Text Box Prompt
Read-Only	Whether a Data Provider Person or process that enters data into a form or other data entry view for a label that was configured by a Designer. A user acting as a Data Provider requires the DOCUMENT_PRINTER role or equivalent permissions. is prevented from entering data in this field. Selecting this option may be appropriate if the field is automatically populated with data from a database and should not be altered in Print or Applications . Important! If this option is selected, then Entry Type should be set to Optional unless the field is being automatically populated.	Prompt Text Box Prompt
Layout	Vertical: Display a vertical list of options. Horizontal: Display a horizontal list of options.	Radio Button Group
Lock Field	If selected, no changes can be made to the properties of the field, and the field cannot be moved or deleted. The order of the field relative to other fields in the label template can be changed regardless of whether the field is locked. Note: This feature can be used to prevent accidental changes to fields. It does not prevent other Designers from unlocking a field.	All fields
Tab Stop	Whether focus is set to the field when a Data Provider Person or process that enters data into a form or other data entry view for a label that was configured by a Designer. A user acting as a Data Provider requires the DOCUMENT_PRINTER role or equivalent permissions. uses the Tab key for navigating in a form. : Focus is set to the field according to the tab order when a Data Provider uses the Tab key for navigating. : Focus is not set to the field when a Data Provider uses the Tab key for navigating. Alternatively, you can Dynamically Manage the Tab Order of a Control, use a Focus Action, or Change the Field Tabbing Order.	All fields

Table Properties

In a label template or a form, you can configure data sources and styling for a table. For additional table properties, see Columns and Table Rules.

Property	Description	Fields Where Available
Data Ref	Data reference. The data source used to populate the field with a value. Tip: By default, Data Ref fields are case sensitive. If the label template is intended for use with an SAP BC-XOM integration or an SAP RFC integration, use only uppercase text in the Data Ref field.	Table
Input Data Ref	The data reference for a data source, such as a Database data source, from which a Prompt field obtains data.	Table
Source Data Ref	A reference to the location in the data map from which the table columns obtain data. Example /MyData	Table
Style Data Ref	A reference to the location in the data map from which the table columns obtain styling. For more information, see Style a Table. Example /MyData/Styling Note: Styles defined by a Style Data Ref override the styles configured on a column.	Table
Column Count	The number of columns to display in the table. You can set this value to 0 if you want the number of columns to be determined from the first row of data in the Source Data Ref.	Table
Row Count	The number of rows to display in the table. If a table contains more rows than the Row Count number, a scroll bar is added to the table envelope. Note: This property is available only if Auto Envelope is selected.	Table
Row Height	The vertical span of each row in pixels. Note: This property is available only if Auto Envelope is selected.	Table
Show Search	If selected, a toolbar is added to the table that allows users in Print or Applications to quickly locate rows that contain specific text or numbers in a column.	Table
Show Row Numbers	If selected, a column is added that displays the number of each row when viewing in Print or Applications .	Table
Lock Field	If selected, no changes can be made to the properties of the field, and the field cannot be moved or deleted. The order of the field relative to other fields in the label template can be changed regardless of whether the field is locked. Note: This feature can be used to prevent accidental changes to fields. It does not prevent other Designers from unlocking a field.	Table
Tab Stop	Whether focus is set to the field when a Data Provider Person or process that enters data into a form or other data entry view for a label that was configured by a Designer. A user acting as a Data Provider requires the DOCUMENT_PRINTER role or equivalent permissions. uses the Tab key for navigating in a form. : Focus is set to the field according to the tab order when a Data Provider uses the Tab key for navigating. : Focus is not set to the field when a Data Provider uses the Tab key for navigating. Alternatively, you can Dynamically Manage the Tab Order of a Control, use a Focus Action, or Change the Field Tabbing Order.	Table

Home

Font

Property	Description	Fields Where Available
Font	The set of type to use for text in the field.	All fields
Font Size	The size of type in the field in points. Note: If Dynamic Font Sizing is enabled, the size of text displayed or printed in a Text Box field may differ from the value specified by Font Size.	All fields
Font Style	Additional formatting for text in the field. Options include Bold, Italic, Underline, and Strikethrough.	All fields
Text Color	Color of characters in the field. You can select a color or enter a hexadecimal RGB color value. Note: Color printing is possible only if supported by the device and device driver.	All fields
Fill Color	The background color if the Apply Fill check box is selected. You can select a color or enter a hexadecimal RGB color value. Note: Color printing is possible only if supported by the device and device driver.	Prompt Text Box Prompt Form Prompt Button

Style

Property	Description	Fields Where Available
Line Color	The color of the line. You can select a color or enter a hexadecimal RGB color value. Note: Color printing is possible only if supported by the device and device driver.	Prompt Text Box Prompt
Fill Color	The background color if the Apply Fill check box is selected. You can select a color or enter a hexadecimal RGB color value. Note: Color printing is possible only if supported by the device and device driver.	Prompt Text Box Prompt Form Prompt Button
Border Color	The color of the line that forms the button. You can select a color or enter a hexadecimal RGB color value.	Button
Corner Radius	The radius of each corner of the button.	Button

Arrange

Arrange, Size, and Rotation

Note: Rotating a field does not change the values of these properties. For example, regardless of what the value for Rotation is, the Width refers to the distance from the left edge of the field to the right edge of the field when Rotation is set to 0.

Property	Description	Fields Where Available
Left	The distance from the left edge of the field to the left edge of the label. The value is dependent on the unit of measure for the label template.	All fields
Top	The distance from the top edge of the field to the top of the label. The value is dependent on the unit of measure for the label template.	All fields
Center X	The distance from the middle of the field to the left edge of the label. The value is dependent on the unit of measure for the label template.	All fields
Center Y	The distance from the middle of the field to the top of the label. The value is dependent on the unit of measure for the label template.	All fields
Width	The distance from the left edge of the field to the right edge of the field. The value is dependent on the unit of measure for the label template. Chars Per Line, Max Chars, and font formatting also impact this value. For some properties, this property is automatically configured and is read-only by default. For Table, this property can be manually configured if Auto Envelope is cleared.	All fields
Height	The distance from the top edge of the field to the bottom edge of the field. The value is dependent on the unit of measure for the label template. Line Spacing, # Lines, and font formatting also impact this value. For some properties, this property is automatically configured and is read-only by default. For Table, this property can be manually configured if Auto Envelope is cleared.	All fields
Rotation	The angle of the text field in relation to the printed label. The value is in degrees.	All fields

View

Option Values

Property	Description	Fields Where Available
Label	The option name displayed to Data Providers.	Drop-Down List Radio Button Group
Value	The list of options in the Drop-Down List or Radio Button Group. Only the option names are displayed to Data Providers. Tip: You can drag and drop an option to change its position in the list, and you can double-click an option to edit it.	Drop-Down List Radio Button Group

Dynamic Properties

You can use the value of a field to manage whether each dynamic property of the control is turned on or off. For example, you can use a dynamic property to manage whether the control is enabled or disabled. You can also use a dynamic property to manage whether the control is displayed or hidden and to manage whether a control field is a tab stop as well as the tab order.

Note: By default, a control with no dynamic properties is enabled and visible and is a tab stop.

: Add a property to the list.
: Delete the property.

Property	Description	Values
Property	A property of a control that can be turned on or off, such as whether the control is enabled or whether the control is displayed to a Data Provider Person or process that enters data into a form or other data entry view for a label that was configured by a Designer. A user acting as a Data Provider requires the DOCUMENT_PRINTER role or equivalent permissions. in Print or Applications .	Enabled: Whether the control can be used by a Data Provider. If a comparison between the value associated with a field and a specified value is evaluated as true, then the control is displayed and can be used. If false, the control is displayed in a disabled state and cannot be used. Visible: Whether the control is displayed to a Data Provider. If a comparison between the value associated with a field and a specified value is evaluated as true, then the control is displayed. If false, the control is not displayed. Tab Order: The order in which the control receives focus when a Data Provider uses the Tab key for navigating. The control is not a tab stop if the Tab Order value is -1.
Data Ref	The field used to manage whether the specified property is turned on or off.	The list of fields that exist in the form.
Operator	The operator used to compare the value referred to by the Data Ref to a specified value.	Equals Not Equal Equals Ignore Case Not Equal Ignore Case Less Than Greater Than Is Missing Is Not Missing Is Empty Is Not Empty
Test Value	The literal value to be compared to the Data Ref to manage whether the specified property should be applied to the control. Note: The Value property is omitted if the Operator itself provides the value.	A literal value. Tip: The Value property must not include a data ref or the name of a data map entry. If you want to use a variable to manage the control, you can accomplish this by using a business rule that includes a conditional business rule component. Configure the output of the business rule to be a value in the data map A repository for the data for use when responding to a print request. Each data map entry is composed of a name (key) and a value., and then use that value to manage the control.