In This Article

IncrementalChangeRequest<T> Class

Represents a request for an incremental (spin) change to a value.

public class IncrementalChangeRequest<T>
Type Parameters:
T -

The part value type.

Inheritance:
object object

Constructors

IncrementalChangeRequest()

Initializes an instance of the class.

public IncrementalChangeRequest()

Properties

CanSnapToChangePrecision

Indicates whether the value should be snapped to the precision of the incremental change value prior to applying the increment.

public bool CanSnapToChangePrecision { get; set; }

Property Value

bool:

true if the value should be snapped to the precision of the incremental change value prior to applying the increment; otherwise, false.

Remarks

When true, a value of 1.24 with change value 0.1 would result in 1.3. When false, a value of 1.24 with change value 0.1 would result in 1.34.

Kind

The kind of request.

public IncrementalChangeRequestKind Kind { get; set; }

Property Value

IncrementalChangeRequestKind

LargeChange

The large change value.

public T? LargeChange { get; set; }

Property Value

T

Maximum

The highest possible value.

public T? Maximum { get; set; }

Property Value

T

Minimum

The lowest possible value.

public T? Minimum { get; set; }

Property Value

T

RoundingDecimalPlace

The rounding decimal place, which is typically a value between 0 and 15, but might be more restrictive for some value types.

public int? RoundingDecimalPlace { get; set; }

Property Value

int?:

Pass null or a negative value to disable rounding.

SmallChange

The small change value.

public T? SmallChange { get; set; }

Property Value

T

SpinWrapping

The wrapping behavior used when spinning past a minimum or maximum value.

public SpinWrapping SpinWrapping { get; set; }

Property Value

SpinWrapping:

The default value is NoWrap.

Value

The base value upon which to apply the incremental change.

public T? Value { get; set; }

Property Value

T

Inherited Members

Extension Methods