How To: Reference Control Properties (KB16010601) (DriveWorks Documentation)

How To: Reference Control Properties

There are two types of control property. These can be categorized into how the property is referenced (when used in a rule).

Direct Reference
Hierarchical Reference

The difference between the two is in how the property is referenced.

Applying the MyName() function directly on these properties will return the property reference.

Direct Referencing

The control properties that are most commonly used in rules can be referenced directly from the rules builder.

When the property is selected the control name is given a prefix that corresponds to the property.

The table below shows the available direct referenced properties and their prefixes:

Property Reference	Type	Example Return Value
ControlNameEnabled	Boolean	True
ControlNameError	Numeric	4
ControlNameListData	String	Option A\|Option B\|Option C
ControlNameMax	Numeric	32500
ControlNameMin	Numeric	17500
ControlNameReturn	By control type	Returns the current value of the control as entered on the user form
ControlNameVisible	Boolean	True

Hierarchical Referencing

For all other control properties a hierarchical reference is used when the property value is required in a rule.

These properties can be selected from the rules builder intellisense or typed into the rule editor.

Hierarchical properties require a point separator between the control name and the property, for example:

ControlName.PropertyName

For example, to obtain the value of the height property of a control named ProductOptions, the reference used in the rule would be:

ProductOptions.height

Property References By Category

The following tables list the references available for each property.

Appearance Properties

Property Name	Hierarchical Reference	Available for Form Controls	Example Return Value
Background Color	ControlName.BackgroundColor	All Controls	White or #ffffff
Border Style	ControlName.BorderStyle	Picture Box, 3D Preview Box	Inset3D
Caption	ControlName.Caption	Checkbox, Combo Box, Date Picker, List Box, Numeric Text Box, Option Button, Spin Button, Text Box, Child Specification List, Data Grid, Item List, Measurement Text Box, Option Group	The caption of the named control
Caption Color	ControlName.CaptionColor	Checkbox, Combo Box, Date Picker, List Box, Numeric Text Box, Option Button, Spin Button, Text Box, Child Specification List, Data Grid, Item List, Measurement Text Box, Option Group	White or #ffffff
Caption Font	ControlName.CaptionFont	Checkbox, Combo Box, Date Picker, List Box, Numeric Text Box, Option Button, Spin Button, Text Box, Child Specification List, Data Grid, Item List, Measurement Text Box, Option Group	font-family: Microsoft Sans Serif; font-size: 12pt; font-weight: bold; text-decoration:
Caption Horizontal Alignment	ControlName.CaptionHorizontalAlignment	Checkbox, Combo Box, Date Picker, List Box, Numeric Text Box, Option Button, Spin Button, Text Box, Child Specification List, Data Grid, Item List, Measurement Text Box, Option Group	Left
Check Alignment	ControlName.CheckAlignment	Checkbox	Left
Column Width	ControlName.ColumnWidth	Data Table, Child Specification List, Item List	200
Font	ControlName.Font	Data Table, Date Picker, Hyperlink, Label, Numeric Text Box, Slider, Spin Button, Text Box, Dialog Button, Macro Button, Measurement Text Box, Upload Control	font-family: Microsoft Sans Serif; font-size: 12pt; font-weight: bold; text-decoration:
Header Background Color	ControlName.HeaderBackgroundColor	Data Table	White or #ffffff
Header Font	ControlName.HeaderFont	Data Table, Child Specification List, Item List	font-family: Microsoft Sans Serif; font-size: 12pt; font-weight: bold; text-decoration:
Header Text Color	ControlName.HeaderTextColor	Data Table, Child Specification List, Item List	White or #ffffff
Header Text Horizontal Alignment	ControlName.HeaderTextHorizontalAlignment	Data Table	Left
Header Text Vertical Alignment	ControlName.HeaderTextVerticalAlignment	Data Table	Center
Hide Characters	ControlName.HideCharacters	Text Box	True
Hover Color	ControlName.HoverColor	Hyperlink	White or #ffffff
Hover Underline	ControlName.HoverUnderline	Hyperlink	True
Input Background Color	ControlName.InputBackgroundColor	Numeric Text Box, Text Box	White or #ffffff
List Item Color	ControlName.ListItemColor	Combo Box, List Box, Child Specification List, Item List	White or #ffffff
List Item Font	ControlName.ListItemFont	Combo Box, List Box, Child Specification List, Item List	font-family: Microsoft Sans Serif; font-size: 12pt; font-weight: bold; text-decoration:
Multiline	ControlName.Multiline	Text Box	True
Name Column Visible	ControlName.NameColumnVisible	Child Specification List, Item List	True
Number of Rows	ControlName.NumberofRows	Option Group	5
Option Alignment	ControlName.OptionAlignment	Option Button, Option Group	Left
Option Item Color	ControlName.OptionItemColor	Option Group	White or #ffffff
Option Item Font	ControlName.OptionItemFont	Option Group	font-family: Microsoft Sans Serif; font-size: 12pt; font-weight: bold; text-decoration:
Option Text Horizontal Alignment	ControlName.OptionTextHorizontalAlignment	Option Group	Left
Orientation	ControlName.Orientation	Slider	Horizontal
Picture	ControlName.PictureDefault	Checkbox, Hyperlink, Option Button, Dialog Button, Macro Button, Option Group, Upload Control	Images\CompanyLogo.jpg
Picture (Checked)	ControlName.PictureChecked	Checkbox	Images\CompanyLogo.jpg
Picture (Hover)	ControlName.PictureHover	Hyperlink, Dialog Button, Macro Button, Upload Control	Images\CompanyLogo.jpg
Picture (Pressed)	ControlName.PicturePressed	Dialog Button, Macro Button, Upload Control	Images\CompanyLogo.jpg
Picture (Selected)	ControlName.PictureSelected	Option Group	Images\CompanyLogo.jpg
Picture Size Mode	ControlName.PictureSizeMode	Checkbox, Hyperlink, Option Button, Dialog Button, Macro Button, Option Group, Upload Control	StretchImage
Picture Style	ControlName.PictureStyle	Checkbox, Hyperlink, Option Button, Dialog Button, Macro Button, Option Group, Upload Control	TextAndPicture
Reverse Direction	ControlName.ReverseDirection	Slider	True
Row Background Color	ControlName.RowBackgroundColor	Data Table	White or #ffffff
Row Height	ControlName.RowHeight	Data Table	30
Row Hover Background Color	ControlName.RowHoverBackgroundColor	Data Table	White or #ffffff
Row Hover Text Color	ControlName.RowHoverTextColor	Data Table	White or #ffffff
Row Text Horizontal Alignment	ControlName.RowTextHorizontalAlignment	Data Table	Left
Row Text Vertical Alignment	ControlName.RowTextVerticalAlignment	Data Table	Center
Selected Row Background Color	ControlName.SelectedRowBackgroundColor	Data Table	DodgerBlue
Selected Row Font	ControlName.SelectedRowFont	Data Table	font-family: Microsoft Sans Serif; font-size: 12pt; font-weight: bold; text-decoration:
Selected Row Text Color	ControlName.SelectedRowTextColor	Data Table	White
Show Border	ControlName.ShowBorder	Numeric Text Box, Text Box, Option Group	True
Show Check	ControlName.ShowCheck	Checkbox	True
Show Grid Lines	ControlName.ShowGridLines	Data Table	True
Show Limits	ControlName.ShowLimits	Slider	True
Show Option	ControlName.ShowOption	Option Button, Option Group	True
Size Mode	ControlName.SizeMode	Picture Box	StretchImage
State Column Visible	ControlName.StateColumnVisible	Child Specification List	True
Text	ControlName.Text	Slider, Dialog Button, Macro Button, Upload Control
Text Color	ControlName.TextColor	Date Picker, Hyperlink, Label, Numeric Text Box, Slider, Spin Button, Text Box, Dialog Button, Macro Button, Measurement Text Box, Upload Control	White or #ffffff
Text Horizontal Alignment	ControlName.TextHorizontalAlignment	Date Picker, Hyperlink, Label, Numeric Text Box, Spin Button, Text Box, Dialog Button, Macro Button, Measurement Text Box, Upload Control	Left
Text Underline	ControlName.TextUnderline	Hyperlink	True
Thumb Image	ControlName.ThumbImage	Slider	Images\arrow.png
Track Color	ControlName.TrackColor	Slider	#e7eaea
Type Column Visible	ControlName.TypeColumnVisible	Child Specification List, Item List	True
Unit Color	ControlName.UnitColor	Measurement Text Box	White or #ffffff
Unit Font	ControlName.UnitFont	Measurement Text Box	font-family: Microsoft Sans Serif; font-size: 12pt; font-weight: bold; text-decoration:
Word Wrap	ControlName.WordWrap	Text Box	False

Autopilot Mode Properties (3D Preview Control)

Property Name	Hierarchical Reference	Available for Form Controls	Example Return Value
Generation Method	ControlName.GenerationMethod	3D Preview Control	OnDemand
Tags	ControlName.Tags	3D Preview Control	High Priority
Timeout	ControlName.Timeout	3D Preview Control	2
Use Relative Path Rules	ControlName.UseRelativePathRules	3D Preview Control	True
Use SOLIDWORKS Extension Suffix	ControlName.UseSWExtensionSuffix	3D Preview Control	False

Behavior Properties

Property Name	Hierarchical Reference	Available for Form Controls	Example Return Value
Behavior	ControlName.Behavior	Child Specification List	MultipleChildren
Character Limit	ControlName.CharacterLimit	Text Box	0
Checked	ControlNameReturn (Direct Reference)	Checkbox	False
Checked (Override Rule)	ControlNameReturn (Direct Reference)	Checkbox	False
Clear Selection Allowed	ControlName.ClearSelectionAllowed	Combo Box, List Box, Option Button, Option Group	True
Database - Please refer to the topic Data Grid for more information.	ControlName.Database	Data Grid
Date	ControlNameReturn (Direct Reference)	Date Picker	08/01/2016
Date (Override Rule)	ControlNameReturn (Direct Reference)	Date Picker	08/01/2016
Date Format	ControlNameDefault	Date Picker	dd/MM/yyyy
Decimal Places	ControlName.DecimalPlaces	Numeric Text Box, Spin Button, Measurement Text Box	-1
Default File Name	ControlNameDefault (Direct Reference)	Upload Control	\\DriveWorks\ProjectName\Images\OriginalName.jpg
Default Rotation-Zoom	ControlName.DefaultRotationZoomValue	3D Preview Box	90\|45\|50
Default Row Identity	ControlName.DefaultRowIdentity	Data Table	Acme Co.
Default Row Index	ControlName.DefaultRowIndex	Data Table	3
Default Value	ControlName.DefaultValue	Checkbox, Combo Box, Date Picker, List Box, Numeric Text Box, Slider, Spin Button, Text Box, Option Group	True
Dialog Name	ControlNameReturn (Direct Reference)	Dialog Button	Details
Disply Units	ControlName.DisplyUnits	Measurement Text Box	Millimeters
Display Value	ControlNameReturn (Direct Reference)	Numeric Text Box, Measurement Text Box	2575
Duplicate File Behavior	ControlName.DuplicateFileBehavior	Upload Control	Overwrite
Enable Animations	ControlName.EnableMenu	3D Preview Box	True
Enable Image Mode	ControlName.EnableImageMode	3D Preview Box	True
Enabled	ControlNameEnabled (Direct Reference)	All Controls	true
Error Result	ControlNameError (Direct Reference)	All Controls	2
Field Names - Please refer to the topic Data Grid for more information.	ControlName.FieldNames	Data Grid
File Filter	ControlName.FileFilter	Upload Control	Image File:png,jpg\|Word File:doc,docx\|Excel File:xls
File Name	ControlName.FileName	Picture Box, 3D Preview Box	MyAssy.drive3d
File Size Limit	ControlName.FileSizeLimit	Upload Control	2Mb
Form Name	ControlName.FormName	Frame Control	Design Info
Group Name	ControlName.GroupName	Option Button	Options
Hidden Fields	ControlName.HiddenFields	Data Table	ID\|Name\|Type
Hidden Item Values	ControlName.HiddenItemValues	Item List	ServicePlan\|Spares
Hidden Result Columns	ControlName.HiddenResultColumns	Child Specification List	Cost\|Margin
Horizontal Scroll Visibility	ControlName.HorizontalScrollVisibility	Frame Control	Hidden
Hyperlink	ControlNameReturn (Direct Reference)	Hyperlink	www.driveworks.co.uk
Identity Fields	ControlName.IdentityFields	Data Table	Customer
Increment	ControlName.Increment	Slider, Spin Button	10
Input Values	ControlName.InputValues	Specification Host	{"Name","Value";"Check","TRUE";"Slider","50"}
Items. See Items (Data Table) for the Data Table control	ControlNameListData (Direct Reference)	Combo Box, Data Table, List Box, Item List, Option Group	Item A\|Item B\|Item C\|Item D\|Item E\|Item F
Lighting	ControlName.Lighting	3D Preview Box	Hard Lighting
Link Behavior	ControlName.LinkBehavior	Hyperlink	CurrentWindow
Macro Argument	ControlName.MacroArgument	Macro Button	1
Macro Name	ControlNameReturn (Direct Reference)	Macro Button	Cancel
Maximum	ControlNameMax (Direct Reference)	Date Picker, Numeric Text Box, Slider, Spin Button, Text Box, Measurement Text Box	3500
Minimum	ControlNameMin (Direct Reference)	Date Picker, Numeric Text Box, Slider, Spin Button, Text Box, Measurement Text Box	1200
Native Units	ControlName.NativeUnits	Measurement Text Box	Millimeters
On Upload Complete Macro	ControlName.OnUploadCompleteMacro	Upload Control	DriveValue
Password - Please refer to the topic Data Grid for more information.	ControlName.Password	Data Grid
Preview Document Name	ControlName.PreviewDocumentName	3D Preview Box	My3DFile
Preview Engine	ControlName.PreviewEngine	3D Preview Box
Projects	No hierarchical reference available.	Child Specification List
Read Only	ControlName.ReadOnly	Text Box	False
Selected Item	ControlNameReturn (Direct Reference)	Combo Box, List Box, Option Group	Type A
Selected Item (Override Rule)	ControlNameReturn (Direct Reference)	Combo Box, List Box, Option Group	Type A
Selected Item Removed Behavior	ControlName.SelectedItemRemovedBehavior	Combo Box, List Box, Option Group	SelectFirst
Selected Option	ControlNameReturn (Direct Reference)	Option Button	Type A
Selected Option (Override Rule)	ControlNameReturn (Direct Reference)	Option Button	Type A
Selected Row Index	ControlNameReturn (Direct Reference)	Data Table	4
Tab Index	ControlName.TabIndex	All Controls	3
Table Name - Please refer to the topic Data Grid for more information.	ControlName.TableName	Data Grid
Task List Enabled	ControlName.TaskList	Dialog Button, Item List	False
Text. See Text (Label Control) for the Label control	ControlNameReturn (Direct Reference)	Hyperlink, Label, Text Box	DriveWorks
Text (Override Rule)	ControlNameReturn (Direct Reference)	Text Box	DriveWorks
URL	ControlName.URL	Web Frame Control	http://www.driveworks.co.uk
User Name - Please refer to the topic Data Grid for more information.	ControlName.UserName	Data Grid
Value	ControlNameReturn (Direct Reference)	Slider, Spin Button	200
Value (override Rule)	ControlNameReturn (Direct Reference)	Slider, Spin Button	200
Vertical Scroll Visibility	ControlName.VerticalScrollVisibility	Frame Control	Hidden
Visible	ControlNameVisible (Direct Reference)	All Controls	True
Where Clause - Please refer to the topic Data Grid for more information.	ControlName.WhereClause	Data Grid

Events Properties

Property Name	Hierarchical Reference	Available for Form Controls	Example Return Value
On Autopilot Preview Requested Macro	ControlName.AutopilotPreviewRequestedMacroName	3D Preview Box	MyMacro
On Background Clicked Macro	ControlName.BackgroundClickedMacroName	3D Preview Box	MyMacro
On Model Clicked Macro	ControlName.ClickedMacroName	3D Preview Box	MyMacro
On Preview Complete Macro	ControlName.PreviewFinishedMacroName	3D Preview Box	MyMacro

General Properties

Property Name	Hierarchical Reference	Available for Form Controls	Example Return Value
(Name)	No hierarchical reference available.To determine the name of the control consider using the function MyName	All Controls	The name given to the control
(Tag)	ControlName.Tag	All Controls	The tag applied to the control
Tooltip Duration	ControlName.TooltipDuration	Checkbox, Combo Box, Data Table, Date Picker, Hyperlink, Label, List Box, Numeric Text Box, Option Button, Picture Box, Slider, Spin Button, Text Box, 3D Preview Box, Child Specification List, Data Grid, Dialog Button, Frame Control, Item List, Macro Button, Measurement Text Box, Option Group	5
Tooltip Text	ControlName.TooltipText	Checkbox, Combo Box, Data Table, Date Picker, Hyperlink, Label, List Box, Numeric Text Box, Option Button, Picture Box, Slider, Spin Button, Text Box, 3D Preview Box, Child Specification List, Data Grid, Dialog Button, Frame Control, Item List, Macro Button, Measurement Text Box, Option Group	Please enter the length

Layout Properties

Property Name	Hierarchical Reference	Available for Form Controls	Example Return Value
Caption Width	ControlName.CaptionWidth	Combo Box, Date Picker, List Box, Numeric Text Box, Spin Button, Text Box, Measurement Text Box
Height	ControlName.Height	All Controls	100
Left	ControlName.Left	All Controls	24
Top	ControlName.Top	All Controls	50
Width	ControlName.Width	All Controls	350

Knowledge Base Article Ref:	KB16010601

DriveWorks Pro 22 How To: Reference Control Properties (KB16010601)