 | Incremental |
Represents an incremental variable in the woodwork automation system.
An incremental variable is an auto-incrementing output control that automatically advances by a step value
on each format call, useful for generating sequential numbering (line numbers, operation counts, etc.) in NC output files.
Incremental variables maintain state between calls and can be forced to output on demand, enabling precise
sequencing control with automatic increment progression throughout NC file generation.
Namespace: Woodwork.Automation
Assembly: WoodworkAutomation (in WoodworkAutomation.dll) Version: 10.2.1+e3fd5885edfa7211ba46258e0eed5ac221a54381
SyntaxThe IncrementalVariable type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | First | Gets and sets the initial value of the incremental variable. This is the value output on the first format call before any increment steps are applied. |
| 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 has not changed; when false (default), output occurs only when the value changes. Force enables unconditional sequential number generation. |
| Prefix | Gets and sets the prefix text string prepended to the formatted output value. |
| Shaper | Gets and sets the Format object that defines how the current value is formatted for output. |
| Step | Gets and sets the step increment value applied to the variable on each format call. |
| Suffix | Gets and sets the suffix text string appended to the formatted output value. |
Methods| Name | Description | |
|---|---|---|
 | Format | Formats and returns the current incremented value, then advances to the next value for the next call. Each successive call outputs the value increased by the step increment. |
| GetCurrent | Returns the formatted text string representation of the current value without incrementing. This allows inspecting the current value without advancing the sequence. |
| Reset | Resets the variable to force output on the next format call, overriding normal output rules. This ensures the next format call produces output regardless of value changes or force settings. |
| SetPrefix | Temporarily overrides the prefix text string for subsequent output operations. |
| SetSuffix | Temporarily overrides the suffix text string for subsequent output operations. |
See Also