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	Example Return Value
Background Color	ControlName.BackgroundColor	White or #ffffff
Border Style	ControlName.BorderStyle	Inset3D
Caption	ControlName.Caption	The caption of the named control
Caption Color	ControlName.CaptionColor	White or #ffffff
Caption Font	ControlName.CaptionFont	font-family: Microsoft Sans Serif; font-size: 12pt; font-weight: bold; text-decoration:
Caption Horizontal Alignment	ControlName.CaptionHorizontalAlignment	Left
Check Alignment	ControlName.CheckAlignment	Left
Column Width	ControlName.ColumnWidth	200
Font	ControlName.Font	font-family: Microsoft Sans Serif; font-size: 12pt; font-weight: bold; text-decoration:
Header Color	ControlName.HeaderColor	White or #ffffff
Header Font	ControlName.HeaderFont	font-family: Microsoft Sans Serif; font-size: 12pt; font-weight: bold; text-decoration:
Hide Characters	ControlName.HideCharacters	True
Hover Color	ControlName.HoverColor	White or #ffffff
Hover Underline	ControlName.HoverUnderline	True
Input Background Color	ControlName.InputBackgroundColor	White or #ffffff
List Item Color	ControlName.ListItemColor	White or #ffffff
List Item Font	ControlName.ListItemFont	font-family: Microsoft Sans Serif; font-size: 12pt; font-weight: bold; text-decoration:
Multiline	ControlName.Multiline	True
Name Column Visible	ControlName.NameColumnVisible	True
Number of Rows	ControlName.NumberofRows	5
Option Alignment	ControlName.OptionAlignment	Left
Option Item Color	ControlName.OptionItemColor	White or #ffffff
Option Item Font	ControlName.OptionItemFont	font-family: Microsoft Sans Serif; font-size: 12pt; font-weight: bold; text-decoration:
Option Text Horizontal Alignment	ControlName.OptionTextHorizontalAlignment	Left
Orientation	ControlName.Orientation	Horizontal
Picture	ControlName.PictureDefault	Images\CompanyLogo.jpg
Picture (Checked)	ControlName.PictureChecked	Images\CompanyLogo.jpg
Picture (Hover)	ControlName.PictureHover	Images\CompanyLogo.jpg
Picture (Pressed)	ControlName.PicturePressed	Images\CompanyLogo.jpg
Picture (Selected)	ControlName.PictureSelected	Images\CompanyLogo.jpg
Picture Size Mode	ControlName.PictureSizeMode	StretchImage
Picture Style	ControlName.PictureStyle	TextAndPicture
Reverse Direction	ControlName.ReverseDirection	True
Show Border	ControlName.ShowBorder	True
Show Check	ControlName.ShowCheck	True
Show Limits	ControlName.ShowLimits	True
Show Option	ControlName.ShowOption	True
Size Mode	ControlName.SizeMode	StretchImage
State Column Visible	ControlName.StateColumnVisible	True
Text	ControlName.Text
Text Color	ControlName.TextColor	White or #ffffff
Text Horizontal Alignment	ControlName.TextHorizontalAlignment	Left
Text Underline	ControlName.TextUnderline	True
Thumb Image	ControlName.ThumbImage	Images\arrow.png
Track Color	ControlName.TrackColor	#e7eaea
Type Column Visible	ControlName.TypeColumnVisible	True
Unit Color	ControlName.UnitColor	White or #ffffff
Unit Font	ControlName.UnitFont	font-family: Microsoft Sans Serif; font-size: 12pt; font-weight: bold; text-decoration:
Word Wrap	ControlName.WordWrap	False

Behavior Properties

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

General Properties

Property Name	Hierarchical Reference	Example Return Value
(Name)	No hierarchical reference available.To determine the name of the control consider using the function MyName	The name given to the control
(Tag)	ControlName.Tag	The tag applied to the control
Tooltip Duration	ControlName.TooltipDuration	5
Tooltip Text	ControlName.TooltipText	Please enter the length

Layout Properties

Property Name	Hierarchical Reference	Example Return Value
Caption Width	ControlName.CaptionWidth
Height	ControlName.Height	100
Left	ControlName.Left	24
Top	ControlName.Top	50
Width	ControlName.Width	350

Knowledge Base Article Ref:	KB16010601

DriveWorks Solo 24 How To: Reference Control Properties (KB16010601)