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:

The index of the part that the caret is currently in.

public PartEditBoxCommitTriggers CommitTriggers { get; set; }

Property Value

PartEditBoxCommitTriggers:

A PartEditBoxCommitTriggers indicating the triggers that will force this control to commit any changes. The default value is PartEditBoxCommitTriggers.Default.

protected int CurrentSelectionLength { get; }

Property Value

int:

The current text selection length.

protected int CurrentSelectionStartOffset { get; }

Property Value

int:

The current text selection start offset.

protected string CurrentText { get; set; }

Property Value

string:

The current text value in the TextBox.

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:

The collection of inline UI element placed within the control.

public InputScopeNameValue InputScopeNameValue { get; set; }

Property Value

InputScopeNameValue:

The InputScopeNameValue to use for the editable text.

public T IntermediateValue { get; }

Property Value

T:

The current value of the control.

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 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:

The text that is displayed in the control until the value is changed by a user action or some other operation.

public Brush PopupBackground { get; set; }

Property Value

Brush:

The Brush to use for the popup background.

public Brush PopupBorderBrush { get; set; }

Property Value

Brush:

The Brush to use for the popup border.

public Style PopupPickerStyle { get; set; }

Property Value

Style:

The optional custom Style that can be applied to the picker within the popup.

public ICommand ResetValueCommand { get; }

Property Value

ICommand:

The ICommand that resets the value to a default value.

public ICommand SmallDecrementValueCommand { get; }

Property Value

ICommand:

The ICommand that can be used to decrement the value by a small amount.

public ICommand SmallIncrementValueCommand { get; }

Property Value

ICommand:

The ICommand that can be used to increment the value by a small amount.

public SpinWrapping SpinWrapping { get; set; }

Property Value

SpinWrapping:

The wrapping behavior used when spinning past a minimum or maximum value in the active part. The default value is SpinWrapping.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 SpinnerVisibility.Collapsed.

public TextAlignment TextAlignment { get; set; }

Property Value

TextAlignment:

The text alignment of the text editing area. The default value is TextAlignment.Left.

public ControlUsageContext UsageContext { get; set; }

Property Value

ControlUsageContext:

The usage context of the control, which may alter its appearance. The default value is ControlUsageContext.Default.

public T Value { get; set; }

Property Value

T:

The committed value of the control.

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 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:

An AutomationPeer instance.

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 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	The RoutedEventArgs that contains the event data.

protected override void OnLostMouseCapture(MouseEventArgs e)

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

protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)

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

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.

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

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