PartEditBoxBase<T> Class

[TemplatePart(Name = "PART_InlinePanel", Type = typeof(PartEditBoxInlinePanel))]
[TemplatePart(Name = "PART_Popup", Type = typeof(Popup))]
[TemplatePart(Name = "PART_TextBox", Type = typeof(EmbeddedTextBox))]
[TemplateVisualState(Name = "Normal", GroupName = "CommonStates")]
[TemplateVisualState(Name = "PointerOver", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Focused", GroupName = "CommonStates")]
[TemplateVisualState(Name = "FocusedNonEditable", GroupName = "CommonStates")]
[TemplateVisualState(Name = "FocusedPopup", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Disabled", GroupName = "CommonStates")]
public abstract class PartEditBoxBase<T> : Control

protected PartEditBoxBase()

public int ActivePartIndex { get; }

Property Value

int

public PartEditBoxCommitTriggers CommitTriggers { get; set; }

Property Value

PartEditBoxCommitTriggers:

The default value is Default>.

protected int CurrentSelectionLength { get; }

Property Value

int

protected int CurrentSelectionStartOffset { get; }

Property Value

int

protected string CurrentText { get; set; }

Property Value

string

public bool HasPopup { get; set; }

Property Value

bool:

true if the control has a popup available; otherwise false. The default value is true.

protected virtual bool HasPopupButtonWhenReadOnly { get; }

Property Value

bool:

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

public PartEditBoxInlineCollection? Inlines { get; set; }

Property Value

PartEditBoxInlineCollection

public InputScopeNameValue InputScopeNameValue { get; set; }

Property Value

InputScopeNameValue

public T? IntermediateValue { get; }

Property Value

T

public bool IsArrowKeyPartNavigationEnabled { get; set; }

Property Value

bool:

true if the left/right arrow keys can be used to move between and select editable parts; otherwise false. The default value is true.

public bool IsEditable { get; set; }

Property Value

bool:

true if the edit box's text area is editable; otherwise false. The default value is true.

Remarks

When false, the edit box behaves more like a ComboBox.

public bool IsInputFilteringEnabled { get; set; }

Property Value

bool:

true if only allowed characters can be input into the edit box; otherwise, false to allow all characters to be input. The default value is false.

Remarks

This property has no effect if the edit box is not configured with allowable characters.

public bool IsNonDefaultUsageContext { get; }

Property Value

bool:

true if a non-default UsageContext is currently in effect; otherwise, false. The default value is false.

public bool IsNullAllowed { get; set; }

Property Value

bool:

true if null values are allowed to be entered by the user; otherwise false. The default value is false.

public bool IsPopupButtonVisible { get; }

Property Value

bool:

true if the toggle popup button is visible; otherwise false. The default value is false.

Remarks

The HasPopup and HasPopupButtonWhenReadOnly properties, and other state-related info determines whether the toggle popup button is visible.

public bool IsPopupOpen { get; set; }

Property Value

bool:

true if the popup is open; otherwise, false.

public bool IsReadOnly { get; set; }

Property Value

bool:

true if the edit box is read-only; otherwise false. The default value is false.

public bool IsSpinnerVisible { get; }

Property Value

bool:

true if the spinner is visible; otherwise false. The default value is false.

Remarks

The SpinnerVisibility property and other state-related info determines whether the spinner is visible.

public bool IsUndoEnabled { get; set; }

Property Value

bool:

true if undo/redo support is enabled for the text-editing portion of the control. The default value is true.

public IList<IPart> Parts { get; }

Property Value

IList<IPart>:

The collection of parts.

public string PlaceholderText { get; set; }

Property Value

string

public Brush? PopupBackground { get; set; }

Property Value

Brush

public Brush? PopupBorderBrush { get; set; }

Property Value

Brush

public Style? PopupPickerStyle { get; set; }

Property Value

Style

public ICommand ResetValueCommand { get; }

Property Value

ICommand

public ICommand SmallDecrementValueCommand { get; }

Property Value

ICommand

public ICommand SmallIncrementValueCommand { get; }

Property Value

ICommand

public SpinWrapping SpinWrapping { get; set; }

Property Value

SpinWrapping:

The default value is NoWrap.

public SpinnerVisibility SpinnerVisibility { get; set; }

Property Value

SpinnerVisibility:

A value indicating if and when the control has a spinner available. The default value is Collapsed.

public TextAlignment TextAlignment { get; set; }

Property Value

TextAlignment:

The default value is TextAlignment.Left.

public ControlUsageContext UsageContext { get; set; }

Property Value

ControlUsageContext:

The default value is Default.

public T? Value { get; set; }

Property Value

T

protected virtual T? CoerceValidValue(T? value)

Parameter	Type	Description
value	T	The value to coerce.

Returns

T:

The coerced value.

public bool Commit()

Returns

bool:

true if the value has been updated; otherwise, false.

public bool Commit(bool allowTextUpdate)

Parameter	Type	Description
allowTextUpdate	bool	Whether to allow the text to be updated if a valid value is parsed.

Returns

bool:

true if the value has been updated; otherwise, false.

protected abstract string? ConvertToString(T? valueToConvert)

Parameter	Type	Description
valueToConvert	T	The value.

Returns

string:

The string representation of the specified value.

protected abstract IncrementalChangeRequest<T>? CreateIncrementalChangeRequest(IncrementalChangeRequestKind kind)

Parameter	Type	Description
kind	IncrementalChangeRequestKind	The kind of request.

Returns

IncrementalChangeRequest<T>:

The incremental change (spin) request that was created.

protected abstract IList<IPart> GenerateParts()

Returns

IList<IPart>:

The parts that were generated.

protected void InvalidateParts()

protected virtual bool IsTextInputAllowed(string text)

Parameter	Type	Description
text	string	The text to examine.

Returns

bool:

true if the text input is allowed; otherwise, false.

See Also

• IsInputFilteringEnabled

protected abstract bool IsValidValue(T? value)

Parameter	Type	Description
value	T	The value to examine.

Returns

bool:

true if the value is valid; otherwise, false.

public override void OnApplyTemplate()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

The type-specific AutomationPeer implementation.

protected override void OnGotFocus(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	The RoutedEventArgs that contains the event data.

protected virtual void OnIntermediateValueChanged(T? oldValue, T? newValue)

Parameter	Type	Description
oldValue	T	The old value of the property.
newValue	T	The new value of the property.

protected override void OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs e)

Parameter	Type	Description
e	DependencyPropertyChangedEventArgs	A System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

protected virtual void OnIsNullAllowedChanged(bool oldValue, bool newValue)

Parameter	Type	Description
oldValue	bool	The old value of the property.
newValue	bool	The new value of the property.

protected override void OnKeyDown(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	The KeyEventArgs that contains the event data.

protected override void OnLostFocus(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	A RoutedEventArgs that contains event data. This event data must contain the identifier for the LostFocus event.

protected override void OnLostMouseCapture(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	The MouseEventArgs that contains event data.

protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Parameter	Type	Description
e	MouseButtonEventArgs	The MouseButtonEventArgs that contains the event data. The event data reports that the left mouse button was pressed.

protected virtual void OnPopupOpened()

Remarks

The default method implementation focuses the first popup descendant control with a tab stop.

protected override void OnPreviewMouseUp(MouseButtonEventArgs e)

Parameter	Type	Description
e	MouseButtonEventArgs	The MouseButtonEventArgs that contains the event data. The event data reports that one or more mouse buttons were released.

protected override void OnPreviewTextInput(TextCompositionEventArgs e)

Parameter	Type	Description
e	TextCompositionEventArgs	The TextCompositionEventArgs that contains the event data.

protected virtual void OnValueChanged(T? oldValue, T? newValue)

Parameter	Type	Description
oldValue	T	The old value of the property.
newValue	T	The new value of the property.

protected virtual 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.

protected abstract void ResetValue()

public void SelectAll()

protected abstract bool TryConvertFromString(string? textToConvert, bool canCoerce, out T? 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	T	Returns the value for the specified text.

Returns

bool:

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

protected bool UpdateIntermediateValueAndTextFromValue()

Returns

bool:

true if the CurrentText property was changed; otherwise, false.

public event EventHandler? ValueChanged

Event Type

EventHandler

public static readonly DependencyProperty ActivePartIndexProperty

public static readonly DependencyProperty CommitTriggersProperty

public static readonly DependencyProperty HasPopupProperty

public static readonly DependencyProperty InlinesProperty

public static readonly DependencyProperty InputScopeNameValueProperty

public static readonly DependencyProperty IntermediateValueProperty

public static readonly DependencyProperty IsArrowKeyPartNavigationEnabledProperty

public static readonly DependencyProperty IsEditableProperty

public static readonly DependencyProperty IsInputFilteringEnabledProperty

public static readonly DependencyProperty IsNonDefaultUsageContextProperty

public static readonly DependencyProperty IsNullAllowedProperty

public static readonly DependencyProperty IsPopupButtonVisibleProperty

public static readonly DependencyProperty IsPopupOpenProperty

public static readonly DependencyProperty IsReadOnlyProperty

public static readonly DependencyProperty IsSpinnerVisibleProperty

public static readonly DependencyProperty IsUndoEnabledProperty

public static readonly DependencyProperty PlaceholderTextProperty

public static readonly DependencyProperty PopupBackgroundProperty

public static readonly DependencyProperty PopupBorderBrushProperty

public static readonly DependencyProperty PopupPickerStyleProperty

public static readonly DependencyProperty SpinWrappingProperty

public static readonly DependencyProperty SpinnerVisibilityProperty

public static readonly DependencyProperty TextAlignmentProperty

public static readonly DependencyProperty UsageContextProperty

public static readonly DependencyProperty ValueProperty