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:
- System.Object Object
Constructors
IncrementalChangeRequest()
public IncrementalChangeRequest()
Properties
CanSnapToChangePrecision
Gets or sets 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
- System.Boolean:
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
Gets or sets the kind of request.
public IncrementalChangeRequestKind Kind { get; set; }
Property Value
- IncrementalChangeRequestKind:
An IncrementalChangeRequestKind that specifies the kind of request.
LargeChange
Gets or sets the large change value.
public T LargeChange { get; set; }
Property Value
- T:
The large change value.
Maximum
Gets or sets the highest possible value.
public T Maximum { get; set; }
Property Value
- T:
The highest possible value.
Minimum
Gets or sets the lowest possible value.
public T Minimum { get; set; }
Property Value
- T:
The lowest possible value.
RoundingDecimalPlace
Gets or sets the rounding decimal place.
public int? RoundingDecimalPlace { get; set; }
Property Value
- System.Nullable<System.Int32>:
The rounding decimal place, which is a value between
0
and15
. Pass a null value to disable rounding.
SmallChange
Gets or sets the small change value.
public T SmallChange { get; set; }
Property Value
- T:
The small change value.
SpinWrapping
Gets or sets the wrapping behavior used when spinning past a minimum or maximum value.
public SpinWrapping SpinWrapping { get; set; }
Property Value
- SpinWrapping:
The wrapping behavior used when spinning past a minimum or maximum value. The default value is
SpinBehavior.NoWrap
.
Value
Gets or sets the base value upon which to apply the incremental change.
public T Value { get; set; }
Property Value
- T:
The base value upon which to apply the incremental change.
Inherited Members
- System.Object.ToString()
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object, System.Object)
- System.Object.ReferenceEquals(System.Object, System.Object)
- System.Object.GetHashCode()
- System.Object.GetType()
- System.Object.MemberwiseClone()