 | Reference |
Represents a reference variable in the woodwork automation system.
A reference variable is a conditional output control that outputs a value only when it differs from a reference value
beyond a specified tolerance threshold. Reference variables optimize NC file size by suppressing output for values within
acceptable tolerance of a reference, enabling efficient handling of precision limits (e.g., arc center points, interpolation tolerances).
Variables can be enabled/disabled and forced to output on demand for flexible output control.
Namespace: Woodwork.Automation
Assembly: WoodworkAutomation (in WoodworkAutomation.dll) Version: 10.2.1+e3fd5885edfa7211ba46258e0eed5ac221a54381
SyntaxThe ReferenceVariable type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Force | Gets and sets a value indicating whether the variable forces output on every format call. When true, the formatted value is output even if it is within tolerance of the reference value; when false (default), output occurs only when the value differs from the reference beyond tolerance. |
| Prefix | Gets and sets the prefix text string prepended to the formatted output value. |
| Shaper | Gets and sets the Format(Double, Double) object that defines how numeric values are formatted for output. |
| Suffix | Gets and sets the suffix text string appended to the formatted output value. |
Methods| Name | Description | |
|---|---|---|
 | Disable | Disables this variable from producing any output. When disabled, the Format method returns an empty string regardless of value comparison results. |
| Enable | Enables this variable for output (default condition when variable is created). When enabled, the variable resumes normal output behavior based on reference comparison. |
| Format | Formats the specified numeric value compared against a reference value and returns the formatted text string. Output is produced only when the value differs from the reference value beyond the format's tolerance threshold (determined by decimal precision and trim settings), or when Force is true. |
| IsEnable | Gets a value indicating whether the variable is currently enabled for output. |
| SetPrefix | Temporarily overrides the prefix text string for subsequent output operations. |
| SetSuffix | Temporarily overrides the suffix text string for subsequent output operations. |
See Also