Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

EnumEditBox Class

Namespace:
ActiproSoftware.Windows.Controls.Editors
Assembly:
ActiproSoftware.Editors.Wpf.dll

Represents an Enum edit box.

public class EnumEditBox : PartEditBoxBase<object>
Inheritance:
object Visual UIElement FrameworkElement Control PartEditBoxBase<object> object

Constructors

EnumEditBox()

Initializes an instance of the EnumEditBox class.

public EnumEditBox()

Properties

EnumSortComparer

Gets or sets the IComparer<T> used to sort the enumeration values.

public IComparer<Enum> EnumSortComparer { get; set; }

Property Value

IComparer<Enum>:

The IComparer<T> used to sort the enumeration values; otherwise null to use default sorting. By default, enumeration values are sorted by the order in which the values are defined. When UseDisplayAttributes is true, the DisplayAttribute.Order, if any, will be preferred over the definition order.

EnumType

Gets or sets the enumeration type.

public Type EnumType { get; set; }

Property Value

Type:

The enumeration type.

HasPopupButtonWhenReadOnly

Gets whether the control should display the popup button when the control is read-only.

protected override bool HasPopupButtonWhenReadOnly { get; }

Property Value

bool:

true if the control should display the popup button when the control is read-only; otherwise, false.

NullValueText

Gets or sets the text to display for a null value item when IsNullAllowed is true.

public string NullValueText { get; set; }

Property Value

string:

The text to display for a null value item.

UseDisplayAttributes

Gets or sets a value indicating whether enumeration values should be displayed using an associated DisplayAttribute, if any.

public bool UseDisplayAttributes { get; set; }

Property Value

bool:

true if enumeration values should be displayed using an associated DisplayAttribute, if any; otherwise false. The default value is false.

Methods

ConvertToString(object)

Converts the specified value to a string representation.

protected override string ConvertToString(object valueToConvert)
Parameter Type Description
valueToConvert object

The value.

Returns

string:

The string representation of the specified value.

CreateIncrementalChangeRequest(IncrementalChangeRequestKind)

Creates an incremental change (spin) request.

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

The kind of request.

Returns

IncrementalChangeRequest<object>:

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(object)

Returns whether the specified value is valid.

protected override bool IsValidValue(object value)
Parameter Type Description
value object

The value to examine.

Returns

bool:

true if the value is valid; otherwise, false.

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Invoked whenever the effective value of any dependency property on this FrameworkElement has been updated. The specific dependency property that changed is reported in the arguments parameter. Overrides System.Windows.DependencyObject.OnPropertyChanged(System.Windows.DependencyPropertyChangedEventArgs).

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameter Type Description
e DependencyPropertyChangedEventArgs

The event data that describes the property that changed, as well as old and new values.

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 object)

Tries to convert the specified text to a value.

protected override bool TryConvertFromString(string textToConvert, bool canCoerce, out object 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 object

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

EnumSortComparerProperty

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

public static readonly DependencyProperty EnumSortComparerProperty

EnumTypeProperty

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

public static readonly DependencyProperty EnumTypeProperty

NullValueTextProperty

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

public static readonly DependencyProperty NullValueTextProperty

UseDisplayAttributesProperty

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

public static readonly DependencyProperty UseDisplayAttributesProperty

Inherited Members