BarTextBox Class
Represents a textbox control, for use within a ribbon or toolbar.
public class BarTextBox : TextBox, IDataContextProvider, ILogical, IThemeVariantHost, IResourceHost, IResourceNode, IStyleHost, ISetLogicalParent, ISetInheritanceParent, IStyleable, INamed, IInputElement, IDataTemplateHost, ISetterValue, ICommandSource, ISupportsStarSizing
- Inheritance:
- object AvaloniaObject Animatable StyledElement Visual Layoutable Interactive InputElement Control TemplatedControl TextBox object
- Implements:
- IDataContextProvider ILogical IThemeVariantHost IResourceHost IResourceNode IStyleHost ISetLogicalParent ISetInheritanceParent IStyleable INamed IInputElement IDataTemplateHost ISetterValue ICommandSource ISupportsStarSizing
Constructors
BarTextBox()
Initializes a new instance of the BarTextBox class.
public BarTextBox()
Properties
CanCloneToRibbonQuickAccessToolBar
Whether the control can be cloned to the ribbon quick-access toolbar.
public bool CanCloneToRibbonQuickAccessToolBar { get; set; }
Property Value
- bool:
The default value is
true
.
Command
The ICommand to execute when text is committed.
CommandParameter
The parameter to be passed to the Command.
IsStarSizingAllowed
Whether the control can star-size and fill available space when appropriate.
Key
A string that uniquely identifies the control.
KeyTipText
The key tip text used to access the control.
Label
The text label to display.
PlaceholderText
The placeholder text to display when the control is empty.
public string? PlaceholderText { get; set; }
Property Value
- string:
The placeholder text to display when the control is empty.
RequestedWidth
The requested width of the control when using Normal density.
ScreenTipFooter
The screen tip footer content.
ScreenTipHeader
The screen tip header content.
SmallIcon
The object representing a small icon, generally 16x16
size.
Title
The string title, which can override the Label when displayed in screen tips and customization UI.
ToolBarItemCollapseBehavior
The ItemCollapseBehavior for the control when in a ribbon using Simplified layout mode.
public ItemCollapseBehavior ToolBarItemCollapseBehavior { get; set; }
Property Value
- ItemCollapseBehavior:
The default value is Default.
VariantSize
The VariantSize currently assigned to the control. This property should only be manually set when the control is standalone, and not hosted by a bar control.
public VariantSize VariantSize { get; set; }
Property Value
- VariantSize:
The default value is Small.
Methods
MeasureOverride(Size)
Measures the control and its child elements as part of a layout pass.
protected override Size MeasureOverride(Size constraint)
Parameter | Type | Description |
---|---|---|
constraint | Size |
Returns
- Size:
The desired size for the control.
OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs)
Called when the styled element is added to a rooted logical tree.
protected override void OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs e)
Parameter | Type | Description |
---|---|---|
e | LogicalTreeAttachmentEventArgs | The event args. |
OnCreateAutomationPeer()
Returns a new, type-specific Avalonia.Automation.Peers.AutomationPeer implementation for the control.
protected override AutomationPeer OnCreateAutomationPeer()
Returns
- AutomationPeer:
The type-specific Avalonia.Automation.Peers.AutomationPeer implementation.
OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs)
Called when the styled element is removed from a rooted logical tree.
protected override void OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs e)
Parameter | Type | Description |
---|---|---|
e | LogicalTreeAttachmentEventArgs | The event args. |
OnGotFocus(GotFocusEventArgs)
Called before the Avalonia.Input.InputElement.GotFocus event occurs.
protected override void OnGotFocus(GotFocusEventArgs e)
Parameter | Type | Description |
---|---|---|
e | GotFocusEventArgs | The event args. |
OnKeyDown(KeyEventArgs)
Called before the Avalonia.Input.InputElement.KeyDown event occurs.
protected override void OnKeyDown(KeyEventArgs e)
Parameter | Type | Description |
---|---|---|
e | KeyEventArgs | The event args. |
OnKeyTipInvoked(KeyTipInvokedEventArgs)
Occurs when the control's key tip is invoked.
protected virtual void OnKeyTipInvoked(KeyTipInvokedEventArgs e)
Parameter | Type | Description |
---|---|---|
e | KeyTipInvokedEventArgs | The KeyTipInvokedEventArgs containing data related to this event. |
OnLostFocus(RoutedEventArgs)
Called before the Avalonia.Input.InputElement.LostFocus event occurs.
protected override void OnLostFocus(RoutedEventArgs e)
Parameter | Type | Description |
---|---|---|
e | RoutedEventArgs | The event args. |
ToString()
Returns the string representation of this object.
Fields
CanCloneToRibbonQuickAccessToolBarProperty
Defines the CanCloneToRibbonQuickAccessToolBar property.
public static readonly StyledProperty<bool> CanCloneToRibbonQuickAccessToolBarProperty
CommandParameterProperty
Defines the CommandParameter property.
public static readonly StyledProperty<object?> CommandParameterProperty
CommandProperty
Defines the Command property.
public static readonly StyledProperty<ICommand?> CommandProperty
IsStarSizingAllowedProperty
Defines the IsStarSizingAllowed property.
public static readonly StyledProperty<bool> IsStarSizingAllowedProperty
KeyProperty
Defines the Key property.
public static readonly StyledProperty<string?> KeyProperty
KeyTipTextProperty
Defines the KeyTipText property.
public static readonly StyledProperty<string?> KeyTipTextProperty
LabelProperty
Defines the Label property.
public static readonly StyledProperty<string?> LabelProperty
PlaceholderTextProperty
Defines the PlaceholderText property.
public static readonly StyledProperty<string?> PlaceholderTextProperty
RequestedWidthProperty
Defines the RequestedWidth property.
public static readonly StyledProperty<double> RequestedWidthProperty
ScreenTipFooterProperty
Defines the ScreenTipFooter property.
public static readonly StyledProperty<object?> ScreenTipFooterProperty
ScreenTipHeaderProperty
Defines the ScreenTipHeader property.
public static readonly StyledProperty<object?> ScreenTipHeaderProperty
SmallIconProperty
Defines the SmallIcon property.
public static readonly StyledProperty<object?> SmallIconProperty
TitleProperty
Defines the Title property.
public static readonly StyledProperty<string?> TitleProperty
ToolBarItemCollapseBehaviorProperty
Defines the ToolBarItemCollapseBehavior property.
public static readonly StyledProperty<ItemCollapseBehavior> ToolBarItemCollapseBehaviorProperty
VariantSizeProperty
Defines the VariantSize property.
public static readonly StyledProperty<VariantSize> VariantSizeProperty
Inherited Members
- TextBox.IsInactiveSelectionHighlightEnabledProperty
- TextBox.ClearSelectionOnLostFocusProperty
- TextBox.AcceptsReturnProperty
- TextBox.AcceptsTabProperty
- TextBox.CaretIndexProperty
- TextBox.IsReadOnlyProperty
- TextBox.PasswordCharProperty
- TextBox.SelectionBrushProperty
- TextBox.SelectionForegroundBrushProperty
- TextBox.CaretBrushProperty
- TextBox.CaretBlinkIntervalProperty
- TextBox.SelectionStartProperty
- TextBox.SelectionEndProperty
- TextBox.MaxLengthProperty
- TextBox.MaxLinesProperty
- TextBox.MinLinesProperty
- TextBox.TextProperty
- TextBox.TextAlignmentProperty
- TextBox.HorizontalContentAlignmentProperty
- TextBox.VerticalContentAlignmentProperty
- TextBox.TextWrappingProperty
- TextBox.LineHeightProperty
- TextBox.LetterSpacingProperty
- TextBox.WatermarkProperty
- TextBox.UseFloatingWatermarkProperty
- TextBox.NewLineProperty
- TextBox.InnerLeftContentProperty
- TextBox.InnerRightContentProperty
- TextBox.RevealPasswordProperty
- TextBox.CanCutProperty
- TextBox.CanCopyProperty
- TextBox.CanPasteProperty
- TextBox.IsUndoEnabledProperty
- TextBox.UndoLimitProperty
- TextBox.CanUndoProperty
- TextBox.CanRedoProperty
- TextBox.CopyingToClipboardEvent
- TextBox.CuttingToClipboardEvent
- TextBox.PastingFromClipboardEvent
- TextBox.TextChangedEvent
- TextBox.TextChangingEvent
- TextBox.CoerceText(string)
- TextBox.ClearSelection()
- TextBox.OnApplyTemplate(TemplateAppliedEventArgs)
- TextBox.OnAttachedToVisualTree(VisualTreeAttachmentEventArgs)
- TextBox.OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs)
- TextBox.OnPropertyChanged(AvaloniaPropertyChangedEventArgs)
- TextBox.OnTextInput(TextInputEventArgs)
- TextBox.Cut()
- TextBox.Copy()
- TextBox.Paste()
- TextBox.OnPointerPressed(PointerPressedEventArgs)
- TextBox.OnPointerMoved(PointerEventArgs)
- TextBox.OnPointerReleased(PointerReleasedEventArgs)
- TextBox.UpdateDataValidation(AvaloniaProperty, BindingValueType, Exception)
- TextBox.Clear()
- TextBox.ScrollToLine(int)
- TextBox.SelectAll()
- TextBox.Undo()
- TextBox.Redo()
- TextBox.CutGesture
- TextBox.CopyGesture
- TextBox.PasteGesture
- TextBox.IsInactiveSelectionHighlightEnabled
- TextBox.ClearSelectionOnLostFocus
- TextBox.AcceptsReturn
- TextBox.AcceptsTab
- TextBox.CaretIndex
- TextBox.IsReadOnly
- TextBox.PasswordChar
- TextBox.SelectionBrush
- TextBox.SelectionForegroundBrush
- TextBox.CaretBrush
- TextBox.CaretBlinkInterval
- TextBox.SelectionStart
- TextBox.SelectionEnd
- TextBox.MaxLength
- TextBox.MaxLines
- TextBox.MinLines
- TextBox.LetterSpacing
- TextBox.LineHeight
- TextBox.Text
- TextBox.SelectedText
- TextBox.HorizontalContentAlignment
- TextBox.VerticalContentAlignment
- TextBox.TextAlignment
- TextBox.Watermark
- TextBox.UseFloatingWatermark
- TextBox.InnerLeftContent
- TextBox.InnerRightContent
- TextBox.RevealPassword
- TextBox.TextWrapping
- TextBox.NewLine
- TextBox.CanCut
- TextBox.CanCopy
- TextBox.CanPaste
- TextBox.IsUndoEnabled
- TextBox.UndoLimit
- TextBox.CanUndo
- TextBox.CanRedo
- TextBox.CopyingToClipboard
- TextBox.CuttingToClipboard
- TextBox.PastingFromClipboard
- TextBox.TextChanged
- TextBox.TextChanging
- TemplatedControl.BackgroundProperty
- TemplatedControl.BackgroundSizingProperty
- TemplatedControl.BorderBrushProperty
- TemplatedControl.BorderThicknessProperty
- TemplatedControl.CornerRadiusProperty
- TemplatedControl.FontFamilyProperty
- TemplatedControl.FontFeaturesProperty
- TemplatedControl.FontSizeProperty
- TemplatedControl.FontStyleProperty
- TemplatedControl.FontWeightProperty
- TemplatedControl.FontStretchProperty
- TemplatedControl.ForegroundProperty
- TemplatedControl.PaddingProperty
- TemplatedControl.TemplateProperty
- TemplatedControl.IsTemplateFocusTargetProperty
- TemplatedControl.TemplateAppliedEvent
- TemplatedControl.GetIsTemplateFocusTarget(Control)
- TemplatedControl.SetIsTemplateFocusTarget(Control, bool)
- TemplatedControl.ApplyTemplate()
- TemplatedControl.GetTemplateFocusTarget()
- TemplatedControl.OnTemplateChanged(AvaloniaPropertyChangedEventArgs)
- TemplatedControl.Background
- TemplatedControl.BackgroundSizing
- TemplatedControl.BorderBrush
- TemplatedControl.BorderThickness
- TemplatedControl.CornerRadius
- TemplatedControl.FontFamily
- TemplatedControl.FontFeatures
- TemplatedControl.FontSize
- TemplatedControl.FontStyle
- TemplatedControl.FontWeight
- TemplatedControl.FontStretch
- TemplatedControl.Foreground
- TemplatedControl.Padding
- TemplatedControl.Template
- TemplatedControl.TemplateApplied
- Control.FocusAdornerProperty
- Control.TagProperty
- Control.ContextMenuProperty
- Control.ContextFlyoutProperty
- Control.RequestBringIntoViewEvent
- Control.ContextRequestedEvent
- Control.LoadedEvent
- Control.UnloadedEvent
- Control.SizeChangedEvent
- Control.OnLoaded(RoutedEventArgs)
- Control.OnUnloaded(RoutedEventArgs)
- Control.OnSizeChanged(SizeChangedEventArgs)
- Control.OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs)
- Control.OnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs)
- Control.OnKeyUp(KeyEventArgs)
- Control.FocusAdorner
- Control.DataTemplates
- Control.ContextMenu
- Control.ContextFlyout
- Control.IsLoaded
- Control.Tag
- Control.ContextRequested
- Control.Loaded
- Control.Unloaded
- Control.SizeChanged
- InputElement.FocusableProperty
- InputElement.IsEnabledProperty
- InputElement.IsEffectivelyEnabledProperty
- InputElement.CursorProperty
- InputElement.IsKeyboardFocusWithinProperty
- InputElement.IsFocusedProperty
- InputElement.IsHitTestVisibleProperty
- InputElement.IsPointerOverProperty
- InputElement.IsTabStopProperty
- InputElement.GotFocusEvent
- InputElement.LostFocusEvent
- InputElement.KeyDownEvent
- InputElement.KeyUpEvent
- InputElement.TabIndexProperty
- InputElement.TextInputEvent
- InputElement.TextInputMethodClientRequestedEvent
- InputElement.PointerEnteredEvent
- InputElement.PointerExitedEvent
- InputElement.PointerMovedEvent
- InputElement.PointerPressedEvent
- InputElement.PointerReleasedEvent
- InputElement.PointerCaptureLostEvent
- InputElement.PointerWheelChangedEvent
- InputElement.TappedEvent
- InputElement.HoldingEvent
- InputElement.DoubleTappedEvent
- InputElement.Focus(NavigationMethod, KeyModifiers)
- InputElement.OnPointerEntered(PointerEventArgs)
- InputElement.OnPointerExited(PointerEventArgs)
- InputElement.OnPointerCaptureLost(PointerCaptureLostEventArgs)
- InputElement.OnPointerWheelChanged(PointerWheelEventArgs)
- InputElement.UpdateIsEffectivelyEnabled()
- InputElement.Focusable
- InputElement.IsEnabled
- InputElement.Cursor
- InputElement.IsKeyboardFocusWithin
- InputElement.IsFocused
- InputElement.IsHitTestVisible
- InputElement.IsPointerOver
- InputElement.IsTabStop
- InputElement.IsEffectivelyEnabled
- InputElement.TabIndex
- InputElement.KeyBindings
- InputElement.IsEnabledCore
- InputElement.GestureRecognizers
- InputElement.GotFocus
- InputElement.LostFocus
- InputElement.KeyDown
- InputElement.KeyUp
- InputElement.TextInput
- InputElement.TextInputMethodClientRequested
- InputElement.PointerEntered
- InputElement.PointerExited
- InputElement.PointerMoved
- InputElement.PointerPressed
- InputElement.PointerReleased
- InputElement.PointerCaptureLost
- InputElement.PointerWheelChanged
- InputElement.Tapped
- InputElement.Holding
- InputElement.DoubleTapped
- Interactive.AddHandler(RoutedEvent, Delegate, RoutingStrategies, bool)
- Interactive.AddHandler<TEventArgs>(RoutedEvent<TEventArgs>, EventHandler<TEventArgs>, RoutingStrategies, bool)
- Interactive.RemoveHandler(RoutedEvent, Delegate)
- Interactive.RemoveHandler<TEventArgs>(RoutedEvent<TEventArgs>, EventHandler<TEventArgs>)
- Interactive.RaiseEvent(RoutedEventArgs)
- Interactive.BuildEventRoute(RoutedEvent)
- Layoutable.DesiredSizeProperty
- Layoutable.WidthProperty
- Layoutable.HeightProperty
- Layoutable.MinWidthProperty
- Layoutable.MaxWidthProperty
- Layoutable.MinHeightProperty
- Layoutable.MaxHeightProperty
- Layoutable.MarginProperty
- Layoutable.HorizontalAlignmentProperty
- Layoutable.VerticalAlignmentProperty
- Layoutable.UseLayoutRoundingProperty
- Layoutable.UpdateLayout()
- Layoutable.Measure(Size)
- Layoutable.Arrange(Rect)
- Layoutable.InvalidateMeasure()
- Layoutable.InvalidateArrange()
- Layoutable.AffectsMeasure<T>(params AvaloniaProperty[])
- Layoutable.AffectsArrange<T>(params AvaloniaProperty[])
- Layoutable.MeasureCore(Size)
- Layoutable.ArrangeCore(Rect)
- Layoutable.ArrangeOverride(Size)
- Layoutable.OnMeasureInvalidated()
- Layoutable.OnVisualParentChanged(Visual, Visual)
- Layoutable.Width
- Layoutable.Height
- Layoutable.MinWidth
- Layoutable.MaxWidth
- Layoutable.MinHeight
- Layoutable.MaxHeight
- Layoutable.Margin
- Layoutable.HorizontalAlignment
- Layoutable.VerticalAlignment
- Layoutable.DesiredSize
- Layoutable.IsMeasureValid
- Layoutable.IsArrangeValid
- Layoutable.UseLayoutRounding
- Layoutable.EffectiveViewportChanged
- Layoutable.LayoutUpdated
- Visual.BoundsProperty
- Visual.ClipToBoundsProperty
- Visual.ClipProperty
- Visual.IsVisibleProperty
- Visual.OpacityProperty
- Visual.OpacityMaskProperty
- Visual.EffectProperty
- Visual.HasMirrorTransformProperty
- Visual.RenderTransformProperty
- Visual.RenderTransformOriginProperty
- Visual.FlowDirectionProperty
- Visual.VisualParentProperty
- Visual.ZIndexProperty
- Visual.GetFlowDirection(Visual)
- Visual.SetFlowDirection(Visual, FlowDirection)
- Visual.InvalidateVisual()
- Visual.Render(DrawingContext)
- Visual.AffectsRender<T>(params AvaloniaProperty[])
- Visual.LogicalChildrenCollectionChanged(object, NotifyCollectionChangedEventArgs)
- Visual.InvalidateMirrorTransform()
- Visual.Bounds
- Visual.ClipToBounds
- Visual.Clip
- Visual.IsEffectivelyVisible
- Visual.IsVisible
- Visual.Opacity
- Visual.OpacityMask
- Visual.Effect
- Visual.HasMirrorTransform
- Visual.RenderTransform
- Visual.RenderTransformOrigin
- Visual.FlowDirection
- Visual.ZIndex
- Visual.VisualChildren
- Visual.VisualRoot
- Visual.BypassFlowDirectionPolicies
- Visual.AttachedToVisualTree
- Visual.DetachedFromVisualTree
- StyledElement.DataContextProperty
- StyledElement.NameProperty
- StyledElement.ParentProperty
- StyledElement.TemplatedParentProperty
- StyledElement.ThemeProperty
- StyledElement.BeginInit()
- StyledElement.EndInit()
- StyledElement.ApplyStyling()
- StyledElement.InitializeIfNeeded()
- StyledElement.TryGetResource(object, ThemeVariant, out object)
- StyledElement.OnDataContextChanged(EventArgs)
- StyledElement.OnDataContextBeginUpdate()
- StyledElement.OnDataContextEndUpdate()
- StyledElement.OnInitialized()
- StyledElement.Name
- StyledElement.Classes
- StyledElement.DataContext
- StyledElement.IsInitialized
- StyledElement.Styles
- StyledElement.StyleKey
- StyledElement.Resources
- StyledElement.TemplatedParent
- StyledElement.Theme
- StyledElement.LogicalChildren
- StyledElement.PseudoClasses
- StyledElement.StyleKeyOverride
- StyledElement.Parent
- StyledElement.ActualThemeVariant
- StyledElement.AttachedToLogicalTree
- StyledElement.DetachedFromLogicalTree
- StyledElement.DataContextChanged
- StyledElement.Initialized
- StyledElement.ResourcesChanged
- StyledElement.ActualThemeVariantChanged
- Animatable.TransitionsProperty
- Animatable.OnPropertyChangedCore(AvaloniaPropertyChangedEventArgs)
- Animatable.Transitions
- AvaloniaObject.CheckAccess()
- AvaloniaObject.VerifyAccess()
- AvaloniaObject.ClearValue(AvaloniaProperty)
- AvaloniaObject.ClearValue<T>(AvaloniaProperty<T>)
- AvaloniaObject.ClearValue<T>(StyledProperty<T>)
- AvaloniaObject.ClearValue<T>(DirectPropertyBase<T>)
- AvaloniaObject.Equals(object)
- AvaloniaObject.GetHashCode()
- AvaloniaObject.GetValue(AvaloniaProperty)
- AvaloniaObject.GetValue<T>(StyledProperty<T>)
- AvaloniaObject.GetValue<T>(DirectPropertyBase<T>)
- AvaloniaObject.GetBaseValue<T>(StyledProperty<T>)
- AvaloniaObject.IsAnimating(AvaloniaProperty)
- AvaloniaObject.IsSet(AvaloniaProperty)
- AvaloniaObject.SetValue(AvaloniaProperty, object, BindingPriority)
- AvaloniaObject.SetValue<T>(StyledProperty<T>, T, BindingPriority)
- AvaloniaObject.SetValue<T>(DirectPropertyBase<T>, T)
- AvaloniaObject.SetCurrentValue(AvaloniaProperty, object)
- AvaloniaObject.SetCurrentValue<T>(StyledProperty<T>, T)
- AvaloniaObject.Bind(AvaloniaProperty, IBinding)
- AvaloniaObject.Bind(AvaloniaProperty, IObservable<object>, BindingPriority)
- AvaloniaObject.Bind<T>(StyledProperty<T>, IObservable<object>, BindingPriority)
- AvaloniaObject.Bind<T>(StyledProperty<T>, IObservable<T>, BindingPriority)
- AvaloniaObject.Bind<T>(StyledProperty<T>, IObservable<BindingValue<T>>, BindingPriority)
- AvaloniaObject.Bind<T>(DirectPropertyBase<T>, IObservable<object>)
- AvaloniaObject.Bind<T>(DirectPropertyBase<T>, IObservable<T>)
- AvaloniaObject.Bind<T>(DirectPropertyBase<T>, IObservable<BindingValue<T>>)
- AvaloniaObject.CoerceValue(AvaloniaProperty)
- AvaloniaObject.RaisePropertyChanged<T>(DirectPropertyBase<T>, T, T)
- AvaloniaObject.SetAndRaise<T>(DirectPropertyBase<T>, ref T, T)
- AvaloniaObject.InheritanceParent
- AvaloniaObject.this[AvaloniaProperty]
- AvaloniaObject.this[IndexerDescriptor]
- AvaloniaObject.PropertyChanged
- object.GetType()
- object.MemberwiseClone()
- object.Equals(object, object)
- object.ReferenceEquals(object, object)