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 | 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 Color | ControlName.HeaderColor | Child Specification List, Item List | White or #ffffff |
| Header Font | ControlName.HeaderFont | Child Specification List, Item List | font-family: Microsoft Sans Serif; font-size: 12pt; font-weight: bold; text-decoration: |
| 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 |
| Show Border | ControlName.ShowBorder | Numeric Text Box, Text Box, Option Group | True |
| Show Check | ControlName.ShowCheck | Checkbox | 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 |
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 |
| 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 | ControlName.SelectedRowIndex | 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 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 |
|---|
- Welcome
- What's New
- DriveWorks 22
- Older Versions
- DriveWorks 21
- DriveWorks 20
- DriveWorks 19
- DriveWorks 18
- DriveWorks 17
- DriveWorks 16
- DriveWorks 15
- DriveWorks 14
- DriveWorks 12
- What's New DriveWorks 12
- Form Design
- Rule Builder
- Model Rules
- DriveWorks Add-in for SOLIDWORKS
- SP1
- SP2
- DriveWorks 11
- Welcome to DriveWorks Solo 11 What's New
- Capturing
- Project Designer
- Installation
- Licensing
- SP1
- SP1.1
- SP2
- SP3
- V10
- V9
- V8
- SP0
- SP1
- SP2
- SP3
- V7
- Before You Begin
- Using DriveWorks Solo
- DriveWorks Solo Inside SOLIDWORKS
- Enabling the DriveWorks Solo Add-ins in SOLIDWORKS
- Project Wizard
- Capturing Models
- Captured Models
- Part Mode
- Assembly Mode
- Drawing Mode
- Run
- Run (Layout Mode)
- Project Designer
- Project Designer
- Stage 1: User Interface
- Stage 2: Data and Rules
- Stage 3: Output Rules
- Writing Rules
- Writing Rules
- Rules Builder
- Extract Variable
- Edit Variable
- Rule Builder Settings
- Document Rules
- Model Rules
- Model Rules Overview
- Parts and Assemblies
- File Name
- Relative Path
- Configuration
- Feature
- Dimension
- Tolerances
- Custom Property
- Instance
- File Formats
- Advanced Feature Parameter Rules
- Model Rules Advanced Feature Parameter Rules - Overview
- Boss/Base Features
- Boss/Base Thin
- Break Corner
- Chamfer
- Circular Component Pattern
- Circular Pattern
- Coordinate System
- Cosmetic Thread Features
- Curve
- Curve Driven Pattern
- Curve Through XYZ Points
- Cut Features
- Distance Mate Features
- Draft
- Edge Flange
- Features
- Fillet
- Hole Wizard Features
- Linear Component Pattern
- Circular Pattern
- Linear Pattern
- Lofted Bend
- Mates
- Mold Features
- Offset Surface
- Pattern Driven Component Pattern (Derived)
- Patterns with Advanced Feature Parameters
- Revolved Boss/Base
- Revolved Boss/Base Thin
- Rib
- Ruled Surface
- Sheet Metal Features
- Simple Hole
- Sketch Driven Pattern
- Slot Mate
- Surface Features
- Sweep Thread
- Table Driven Pattern
- Var Fillet
- Weldment Features
- Wrap
- Drawings
- Functions
- Functions
- Conversion
- Cryptography
- Date and Time
- File System
- Helper
- Lambda
- List
- Logical
- Math
- Specification
- Table
- CountIF
- CSVFromTable
- Dcount
- DMax
- DMin
- DWHLookup
- DWVLookup
- GetTableValue
- HLookup
- ListAll
- ListAllConditional
- ListAllConditionalDistinct
- ListAllDistinct
- SumTableColumn
- TableAppendColumns
- TableAppendRow
- TableAppendRows
- TableAverage
- TableBreak
- TableColumn
- TableColumnLookup
- TableCombine
- TableDistinct
- TableDistinctSum
- TableFilter
- TableFilterAll
- TableFilterByList
- TableFormat
- TableFromCsv
- TableGetColumnCount
- TableGetColumnIndexByName
- TableGetDataRows
- TableGetHeaderRow
- TableGetRowCount
- TableGetRows
- TableGetValue
- TableJoin
- TableMax
- TableMaxValue
- TableMin
- TableMinValue
- TableRemoveBlankColumns
- TableRemoveBlankRows
- TableRemoveRow
- TableReplaceHeaderRow
- TableReplaceHeaders
- TableReplaceRow
- TableReverse
- TableRow
- TableSelectColumns
- TableSequence
- TableSkipRows
- TableSort
- TableSortByDate
- TableSortByList
- TableSubstitute
- TableSum
- TableTakeRows
- TableTranspose
- TableWithSequence
- VLookup
- General
- Text
- Validation
- Variables
- Knowledge Base
- Concept
- How To
- How To: SolidWorks Best Practices
- SOLIDWORKS Best Practices (KB13103019)
- SOLIDWORKS Features
- How To: Correctly Format Text
- How To: Backup a Project (KB13022601)
- How To: Change A Static Property To A Dynamic Property (KB13111201)
- How To: Create A Cut Down Project (KB17092602)
- How to: Create and Install Project Templates
- How To: Determine the Version of DriveWorks Solo
- How To: Diagnose Project Issues
- How To: Diagnose Project Issues Using On Demand Generation Report
- How To: Diagnose Project Issues Using The Form Designer
- How To: Diagnose Project Issues Using The Rules Builder
- How To: Diagnose Project Issues Using SOLIDWORKS
- How To: Drive the Color of a Part
- How To: Drive the Material of a Part
- How To: Drive the Texture of a Part
- How To: Find DriveWorks Solo License Keys
- How To: Implementation Guide
- How To: Reference Control Properties (KB16010601)
- How To: Rename a Project
- How To: Replace a Component With a Static or Driven Replacement Model
- How To: Replace An Instance With A Driven Replacement Model
- How To: Maintain Rules For An Existing Model When It Becomes A Child Of A Parent Assembly
- SOLIDWORKS Best Practices (KB13103019)
- How To: Troubleshoot Licensing
- How To: Work With Arrays
- How To: Use Filters (KB15111101)
- Info
- Form Control Properties
- Color
- Border Style
- Border Width
- Button Layout
- Caption, Text (Appearance Property)
- Caption Horizontal Alignment
- Button and Caption Width
- Character Limit
- Check Alignment, Option Alignment
- Checked
- Check Size, Radio Size, Button Icon Size, Toggle Size
- Clear Selection Allowed
- Decimal Places
- Default Value
- Display Value
- Enabled
- Error result
- File Name
- Font
- Height
- Hide Characters
- Hover, Text Underline
- Hyperlink
- Button Icon Style
- Increment
- Input Spacing
- Items
- Left
- Link Behavior
- Maximum
- (Metadata)
- Minimum
- Multiline
- Name
- Number Of Rows
- Opacity (Disabled)
- Orientation
- Override Rule
- Padding, Input Padding, Unit Padding
- Picture
- Picture (Checked), (Hover), (Selected), (Pressed)
- Picture Size Mode
- Picture Style
- Placeholder Text
- Border Radius
- Read Only
- Reverse Direction
- Selected Item
- Selected Item Removed Behavior
- Show Border
- Show Check, Show Option
- Show Limits
- Show Toggle Indicators
- Size Mode
- Tab Index
- Tag
- Text Horizontal Alignment, Toggle Alignment
- Text (Label Control)
- Text, Value (Behavior Property)
- Text, Vertical Alignment
- Thumb Image
- Tooltip Duration
- Tooltip Text
- Top
- Track Color
- Visible
- Width
- Word Wrap
- File and Template Locations
- Info: DriveWorks File Extensions (KB13022602)
- Info: File and Template Locations (KB13103001)
- Template Files
- Lists and Preferences
- Reporting
- Help File
- General Information
- Info: Dangling Dimensions
- Info: Distributing A Solo Project
- Info: DriveWorks Solo Limits
- Info: Instant3D
- Info: Keyboard Shortcuts (KB13103004)
- Info: Known Issues (KB13103005)
- Info: Legal Notices
- Info: Microsoft .NET September 2022 Update Crash (KB22101401)
- Info: Mirrored Components
- Info: SOLIDWORKS System Options (KB12121012)
- Info: Special Variables
- Info: Supported DriveWorks Versions (KB13103006)
- Info: Third Party Information And Downloads
- Info: Microsoft Windows Support
- Info: Working With SOLIDWORKS Enterprise PDM
- Glossary