IncrementalVariable Interface

Represents the IncrementalVariable object. It is used to control the output for Utility.CreateIncremental.

Namespace: Woodwork.Automation
Assembly: WoodworkAutomation (in WoodworkAutomation.dll) Version: 2.1.25

Syntax

public interface IncrementalVariable

Public Interface IncrementalVariable

The IncrementalVariable type exposes the following members.

Properties

	Name	Description
	First	Gets and sets the initial value of an incremental variable.
	Force	Gets and sets the flag indicating whether the variable is forced. The default is false.
	Prefix	Gets and sets the prefix of the output value as a text string.
	Shaper	Gets and sets the Format object for the output of string.
	Step	Gets and sets the step value of an incremental variable.
	Suffix	Gets and sets the suffix of the output value as a text string.

Methods

	Name	Description
	Format	Returns the formatted text string representation of the number.
	GetCurrent	Returns the value currently stored in this variable.
	Reset	Forces the output of the formatted text string on the next call to format, overriding the rules for not outputting a value.
	SetPrefix	Overrides the prefix of the output value as a text string.
	SetSuffix	Overrides the suffix of the output value as a text string.