In This Article

VectorEditBox Class

Represents a Vector edit box.

public class VectorEditBox : PartEditBoxBase<Vector?>
Inheritance:
object Visual UIElement FrameworkElement Control PartEditBoxBase<Vector?> object

Constructors

VectorEditBox()

Initializes an instance of the VectorEditBox class.

public VectorEditBox()

Properties

DefaultValue

Gets or sets the value to set when incrementing/decrementing from a null value.

public Vector DefaultValue { get; set; }

Property Value

Vector:

The value to set when incrementing/decrementing from a null value. The default value is 0.

Format

Gets or sets the number format string.

public string Format { get; set; }

Property Value

string:

The number format string. The default value is "G".

IsNaNAllowed

Gets or sets whether NaN is accepted as a component value.

public bool IsNaNAllowed { get; set; }

Property Value

bool:

true if NaN is accepted as a component value; otherwise, false. The default value is false.

IsNegativeInfinityAllowed

Gets or sets whether NegativeInfinity is accepted as a component value.

public bool IsNegativeInfinityAllowed { get; set; }

Property Value

bool:

true if NegativeInfinity is accepted as a component value; otherwise, false. The default value is false.

IsPositiveInfinityAllowed

Gets or sets whether PositiveInfinity is accepted as a component value.

public bool IsPositiveInfinityAllowed { get; set; }

Property Value

bool:

true if PositiveInfinity is accepted as a component value; otherwise, false. The default value is false.

LargeChange

Gets or sets the large change value.

public Vector LargeChange { get; set; }

Property Value

Vector:

The large change value. The default value is 5.0.

Maximum

Gets or sets the highest possible value.

public Vector Maximum { get; set; }

Property Value

Vector:

The highest possible value.

Minimum

Gets or sets the lowest possible value.

public Vector Minimum { get; set; }

Property Value

Vector:

The lowest possible value.

ResolvedFormat

Gets the resolved number format string.

public string ResolvedFormat { get; }

Property Value

string:

The resolved number format string.

RoundingDecimalPlace

Gets or sets the rounding decimal place.

public int? RoundingDecimalPlace { get; set; }

Property Value

int?:

The rounding decimal place, which is a value between 0 and 15. Pass a null value to disable rounding. The default value is 8.

SmallChange

Gets or sets the small change value.

public Vector SmallChange { get; set; }

Property Value

Vector:

The small change value. The default value is 1.0.

Methods

CoerceValidValue(Vector?)

Coerces the value to be within range.

protected override Vector? CoerceValidValue(Vector? value)
Parameter Type Description
value Vector?

The value to coerce.

Returns

Vector?:

The coerced value.

ConvertToString(Vector?)

Converts the specified value to a string representation.

protected override string ConvertToString(Vector? valueToConvert)
Parameter Type Description
valueToConvert Vector?

The value.

Returns

string:

The string representation of the specified value.

CreateIncrementalChangeRequest(IncrementalChangeRequestKind)

Creates an incremental change (spin) request.

protected override IncrementalChangeRequest<Vector?> CreateIncrementalChangeRequest(IncrementalChangeRequestKind kind)
Parameter Type Description
kind IncrementalChangeRequestKind

The kind of request.

Returns

IncrementalChangeRequest<Vector?>:

The incremental change (spin) request that was created.

GenerateParts()

Generates the parts for the edit box.

protected override IList<IPart> GenerateParts()

Returns

IList<IPart>:

The parts that were generated.

IsValidValue(Vector?)

Returns whether the specified value is valid.

protected override bool IsValidValue(Vector? value)
Parameter Type Description
value Vector?

The value to examine.

Returns

bool:

true if the value is valid; otherwise, false.

ProcessTextInput(string)

Processes typed text.

protected override bool ProcessTextInput(string text)
Parameter Type Description
text string

The typed text.

Returns

bool:

true if the typed text was handled and should not be allowed to be entered; otherwise, false.

RaiseValueChangedEvent()

Raises the ValueChanged event.

protected override void RaiseValueChangedEvent()

ResetValue()

Resets the value to a default value.

protected override void ResetValue()

TryConvertFromString(string, bool, out Vector?)

Tries to convert the specified text to a value.

protected override bool TryConvertFromString(string textToConvert, bool canCoerce, out Vector? value)
Parameter Type Description
textToConvert string

The text.

canCoerce bool

Whether the returned value should be coerced to fall within the allowed value range.

value Vector?

Returns the value for the specified text.

Returns

bool:

true if the text was converted to a value successfully; otherwise, false.

Events

ValueChanged

Occurs after the Value property value changes.

public event EventHandler ValueChanged

Event Type

EventHandler

Fields

DefaultValueProperty

Identifies the DefaultValue dependency property. This field is read-only.

public static readonly DependencyProperty DefaultValueProperty

FormatProperty

Identifies the Format dependency property. This field is read-only.

public static readonly DependencyProperty FormatProperty

IsNaNAllowedProperty

Identifies the IsNaNAllowed dependency property. This field is read-only.

public static readonly DependencyProperty IsNaNAllowedProperty

IsNegativeInfinityAllowedProperty

Identifies the IsNegativeInfinityAllowed dependency property. This field is read-only.

public static readonly DependencyProperty IsNegativeInfinityAllowedProperty

IsPositiveInfinityAllowedProperty

Identifies the IsPositiveInfinityAllowed dependency property. This field is read-only.

public static readonly DependencyProperty IsPositiveInfinityAllowedProperty

LargeChangeProperty

Identifies the LargeChange dependency property. This field is read-only.

public static readonly DependencyProperty LargeChangeProperty

MaximumProperty

Identifies the Maximum dependency property. This field is read-only.

public static readonly DependencyProperty MaximumProperty

MinimumProperty

Identifies the Minimum dependency property. This field is read-only.

public static readonly DependencyProperty MinimumProperty

ResolvedFormatProperty

Identifies the ResolvedFormat dependency property. This field is read-only.

public static readonly DependencyProperty ResolvedFormatProperty

RoundingDecimalPlaceProperty

Identifies the RoundingDecimalPlace dependency property. This field is read-only.

public static readonly DependencyProperty RoundingDecimalPlaceProperty

SmallChangeProperty

Identifies the SmallChange dependency property. This field is read-only.

public static readonly DependencyProperty SmallChangeProperty

Inherited Members