TabControl Class

Summary

A tab control that displays a tab strip along with the content of the selected tab.
Namespace
Avalonia.Controls
Interfaces
Base Types
graph BT Type-->Base0["SelectingItemsControl"] click Base0 "/api/Avalonia.Controls.Primitives/SelectingItemsControl" Base0-->Base1["ItemsControl"] click Base1 "/api/Avalonia.Controls/ItemsControl" Base1-->Base2["TemplatedControl"] click Base2 "/api/Avalonia.Controls.Primitives/TemplatedControl" Base2-->Base3["Control"] click Base3 "/api/Avalonia.Controls/Control" Base3-->Base4["InputElement"] click Base4 "/api/Avalonia.Input/InputElement" Base4-->Base5["Interactive"] click Base5 "/api/Avalonia.Interactivity/Interactive" Base5-->Base6["Layoutable"] click Base6 "/api/Avalonia.Layout/Layoutable" Base6-->Base7["Visual"] click Base7 "/api/Avalonia/Visual" Base7-->Base8["StyledElement"] click Base8 "/api/Avalonia/StyledElement" Base8-->Base9["Animatable"] click Base9 "/api/Avalonia.Animation/Animatable" Base9-->Base10["AvaloniaObject"] click Base10 "/api/Avalonia/AvaloniaObject" Base10-->Base11["object"] Type-.->Interface0["IAvaloniaObjectDebug"] click Interface0 "/api/Avalonia.Diagnostics/IAvaloniaObjectDebug" Type-.->Interface1["INotifyPropertyChanged"] Type-.->Interface2["IValueSink"] Type-.->Interface3["ISetLogicalParent"] click Interface3 "/api/Avalonia.Controls/ISetLogicalParent" Type-.->Interface4["ISetInheritanceParent"] click Interface4 "/api/Avalonia.Controls/ISetInheritanceParent" Type-.->Interface5["IControl"] click Interface5 "/api/Avalonia.Controls/IControl" Type-.->Interface6["IDataTemplateHost"] click Interface6 "/api/Avalonia.Controls.Templates/IDataTemplateHost" Type-.->Interface7["ILayoutable"] click Interface7 "/api/Avalonia.Layout/ILayoutable" Type-.->Interface8["IInputElement"] click Interface8 "/api/Avalonia.Input/IInputElement" Type-.->Interface9["IInteractive"] click Interface9 "/api/Avalonia.Interactivity/IInteractive" Type-.->Interface10["IVisual"] click Interface10 "/api/Avalonia.VisualTree/IVisual" Type-.->Interface11["IStyledElement"] click Interface11 "/api/Avalonia/IStyledElement" Type-.->Interface12["IStyleable"] click Interface12 "/api/Avalonia.Styling/IStyleable" Type-.->Interface13["IStyleHost"] click Interface13 "/api/Avalonia.Styling/IStyleHost" Type-.->Interface14["ILogical"] click Interface14 "/api/Avalonia.LogicalTree/ILogical" Type-.->Interface15["IResourceHost"] click Interface15 "/api/Avalonia.Controls/IResourceHost" Type-.->Interface16["IResourceNode"] click Interface16 "/api/Avalonia.Controls/IResourceNode" Type-.->Interface17["IDataContextProvider"] click Interface17 "/api/Avalonia/IDataContextProvider" Type-.->Interface18["ISupportInitialize"] Type-.->Interface19["INamed"] click Interface19 "/api/Avalonia/INamed" Type-.->Interface20["IVisualBrushInitialize"] click Interface20 "/api/Avalonia.Rendering/IVisualBrushInitialize" Type-.->Interface21["ISetterValue"] click Interface21 "/api/Avalonia.Styling/ISetterValue" Type-.->Interface22["IItemsPresenterHost"] click Interface22 "/api/Avalonia.Controls.Presenters/IItemsPresenterHost" Type-.->Interface23["ICollectionChangedListener"] Type-.->Interface24["IContentPresenterHost"] click Interface24 "/api/Avalonia.Controls.Presenters/IContentPresenterHost" Type-.->Interface25["ITemplatedControl"] click Interface25 "/api/Avalonia.Styling/ITemplatedControl" Type-.->Interface26["IAvaloniaObject"] click Interface26 "/api/Avalonia/IAvaloniaObject" Type["TabControl"] class Type type-node

Syntax

public class TabControl : SelectingItemsControl, IAvaloniaObjectDebug, INotifyPropertyChanged, 
    IValueSink, ISetLogicalParent, ISetInheritanceParent, IControl, IDataTemplateHost, ILayoutable, 
    IInputElement, IInteractive, IVisual, IStyledElement, IStyleable, IStyleHost, ILogical, 
    IResourceHost, IResourceNode, IDataContextProvider, ISupportInitialize, INamed, 
    IVisualBrushInitialize, ISetterValue, IItemsPresenterHost, ICollectionChangedListener, 
    IContentPresenterHost, ITemplatedControl, IAvaloniaObject

Events

Name Type Summary
AttachedToLogicalTree EventHandler<LogicalTreeAttachmentEventArgs>?
Raised when the styled element is attached to a rooted logical tree.
Inherited from StyledElement
AttachedToVisualTree EventHandler<VisualTreeAttachmentEventArgs>
Raised when the control is attached to a rooted visual tree.
Inherited from Visual
DataContextChanged EventHandler?
Occurs when the DataContext property changes.
Inherited from StyledElement
DetachedFromLogicalTree EventHandler<LogicalTreeAttachmentEventArgs>?
Raised when the styled element is detached from a rooted logical tree.
Inherited from StyledElement
DetachedFromVisualTree EventHandler<VisualTreeAttachmentEventArgs>
Raised when the control is detached from a rooted visual tree.
Inherited from Visual
DoubleTapped EventHandler<RoutedEventArgs>
Occurs when a double-tap gesture occurs on the control.
Inherited from InputElement
EffectiveViewportChanged EventHandler<EffectiveViewportChangedEventArgs>?
Occurs when the element's effective viewport changes.
Inherited from Layoutable
GotFocus EventHandler<GotFocusEventArgs>
Occurs when the control receives focus.
Inherited from InputElement
Initialized EventHandler?
Occurs when the styled element has finished initialization.
Inherited from StyledElement
KeyDown EventHandler<KeyEventArgs>
Occurs when a key is pressed while the control has focus.
Inherited from InputElement
KeyUp EventHandler<KeyEventArgs>
Occurs when a key is released while the control has focus.
Inherited from InputElement
LayoutUpdated EventHandler?
Occurs when a layout pass completes for the control.
Inherited from Layoutable
LostFocus EventHandler<RoutedEventArgs>
Occurs when the control loses focus.
Inherited from InputElement
PointerCaptureLost EventHandler<PointerCaptureLostEventArgs>
Occurs when the control or its child control loses the pointer capture for any reason, event will not be triggered for a parent control if capture was transferred to another child of that parent control
Inherited from InputElement
PointerEnter EventHandler<PointerEventArgs>
Occurs when the pointer enters the control.
Inherited from InputElement
PointerLeave EventHandler<PointerEventArgs>
Occurs when the pointer leaves the control.
Inherited from InputElement
PointerMoved EventHandler<PointerEventArgs>
Occurs when the pointer moves over the control.
Inherited from InputElement
PointerPressed EventHandler<PointerPressedEventArgs>
Occurs when the pointer is pressed over the control.
Inherited from InputElement
PointerReleased EventHandler<PointerReleasedEventArgs>
Occurs when the pointer is released over the control.
Inherited from InputElement
PointerWheelChanged EventHandler<PointerWheelEventArgs>
Occurs when the mouse wheen is scrolled over the control.
Inherited from InputElement
PropertyChanged EventHandler<AvaloniaPropertyChangedEventArgs>
Raised when a AvaloniaProperty value changes on this object.
Inherited from AvaloniaObject
ResourcesChanged EventHandler<ResourcesChangedEventArgs>?
Occurs when a resource in this styled element or a parent styled element has changed.
Inherited from StyledElement
SelectionChanged EventHandler<SelectionChangedEventArgs>
Occurs when the control's selection changes.
Inherited from SelectingItemsControl
Tapped EventHandler<RoutedEventArgs>
Occurs when a tap gesture occurs on the control.
Inherited from InputElement
TemplateApplied EventHandler<TemplateAppliedEventArgs>
Raised when the control's template is applied.
Inherited from TemplatedControl
TextInput EventHandler<TextInputEventArgs>
Occurs when a user typed some text while the control has focus.
Inherited from InputElement
TextInputMethodClientRequested EventHandler<TextInputMethodClientRequestedEventArgs>
Occurs when an input element gains input focus and input method is looking for the corresponding client
Inherited from InputElement
TextInputOptionsQuery EventHandler<TextInputOptionsQueryEventArgs>
Occurs when an input element gains input focus and input method is asking for required content options
Inherited from InputElement

Fields

Name Constant Value Summary
AutoScrollToSelectedItemProperty
Defines the AutoScrollToSelectedItem property.
Inherited from SelectingItemsControl
static
BackgroundProperty
Defines the Background property.
Inherited from TemplatedControl
static
BorderBrushProperty
Defines the BorderBrush property.
Inherited from TemplatedControl
static
BorderThicknessProperty
Defines the BorderThickness property.
Inherited from TemplatedControl
static
BoundsProperty
Defines the Bounds property.
Inherited from Visual
static
ClipProperty
Defines the Clip property.
Inherited from Visual
static
ClipToBoundsProperty
Defines the ClipToBounds property.
Inherited from Visual
static
ClockProperty
Defines the Clock property.
Inherited from Animatable
static
ContentTemplateProperty
Defines the ContentTemplate property.
static
ContextFlyoutProperty
Defines the ContextFlyout property
Inherited from Control
static
ContextMenuProperty
Defines the ContextMenu property.
Inherited from Control
static
CursorProperty
Gets or sets associated mouse cursor.
Inherited from InputElement
static
DataContextProperty
Defines the DataContext property.
Inherited from StyledElement
static
DesiredSizeProperty
Defines the DesiredSize property.
Inherited from Layoutable
static
DoubleTappedEvent
Defines the DoubleTapped event.
Inherited from InputElement
static
FocusableProperty
Defines the Focusable property.
Inherited from InputElement
static
FocusAdornerProperty
Defines the FocusAdorner property.
Inherited from Control
static
FontFamilyProperty
Defines the FontFamily property.
Inherited from TemplatedControl
static
FontSizeProperty
Defines the FontSize property.
Inherited from TemplatedControl
static
FontStyleProperty
Defines the FontStyle property.
Inherited from TemplatedControl
static
FontWeightProperty
Defines the FontWeight property.
Inherited from TemplatedControl
static
ForegroundProperty
Defines the Foreground property.
Inherited from TemplatedControl
static
GotFocusEvent
Defines the GotFocus event.
Inherited from InputElement
static
HeightProperty
Defines the Height property.
Inherited from Layoutable
static
HorizontalAlignmentProperty
Defines the HorizontalAlignment property.
Inherited from Layoutable
static
HorizontalContentAlignmentProperty
Defines the HorizontalContentAlignment property.
static
IsEffectivelyEnabledProperty
Defines the IsEffectivelyEnabled property.
Inherited from InputElement
static
IsEnabledProperty
Defines the IsEnabled property.
Inherited from InputElement
static
IsFocusedProperty
Defines the IsFocused property.
Inherited from InputElement
static
IsHitTestVisibleProperty
Defines the IsHitTestVisible property.
Inherited from InputElement
static
IsKeyboardFocusWithinProperty
Defines the IsKeyboardFocusWithin property.
Inherited from InputElement
static
IsPointerOverProperty
Defines the IsPointerOver property.
Inherited from InputElement
static
IsSelectedChangedEvent
Event that should be raised by items that implement ISelectable to notify the parent SelectingItemsControl that their selection state has changed.
Inherited from SelectingItemsControl
static
IsTemplateFocusTargetProperty
Defines the IsTemplateFocusTarget attached property.
Inherited from TemplatedControl
static
IsVisibleProperty
Defines the IsVisibleProperty property.
Inherited from Visual
static
ItemCountProperty
Defines the ItemCount property.
Inherited from ItemsControl
static
ItemsPanelProperty
Defines the ItemsPanel property.
Inherited from ItemsControl
static
ItemsProperty
Defines the Items property.
Inherited from ItemsControl
static
ItemTemplateProperty
Defines the ItemTemplate property.
Inherited from ItemsControl
static
KeyDownEvent
Defines the KeyDown event.
Inherited from InputElement
static
KeyUpEvent
Defines the KeyUp event.
Inherited from InputElement
static
LostFocusEvent
Defines the LostFocus event.
Inherited from InputElement
static
MarginProperty
Defines the Margin property.
Inherited from Layoutable
static
MaxHeightProperty
Defines the MaxHeight property.
Inherited from Layoutable
static
MaxWidthProperty
Defines the MaxWidth property.
Inherited from Layoutable
static
MinHeightProperty
Defines the MinHeight property.
Inherited from Layoutable
static
MinWidthProperty
Defines the MinWidth property.
Inherited from Layoutable
static
NameProperty
Defines the Name property.
Inherited from StyledElement
static
OpacityMaskProperty
Defines the OpacityMask property.
Inherited from Visual
static
OpacityProperty
Defines the Opacity property.
Inherited from Visual
static
PaddingProperty
Defines the Padding property.
Inherited from TemplatedControl
static
ParentProperty
Defines the Parent property.
Inherited from StyledElement
static
PointerCaptureLostEvent
Defines the PointerCaptureLost routed event.
Inherited from InputElement
static
PointerEnterEvent
Defines the PointerEnter event.
Inherited from InputElement
static
PointerLeaveEvent
Defines the PointerLeave event.
Inherited from InputElement
static
PointerMovedEvent
Defines the PointerMoved event.
Inherited from InputElement
static
PointerPressedEvent
Defines the PointerPressed event.
Inherited from InputElement
static
PointerReleasedEvent
Defines the PointerReleased event.
Inherited from InputElement
static
PointerWheelChangedEvent
Defines the PointerWheelChanged event.
Inherited from InputElement
static
RenderTransformOriginProperty
Defines the RenderTransformOrigin property.
Inherited from Visual
static
RenderTransformProperty
Defines the RenderTransform property.
Inherited from Visual
static
RequestBringIntoViewEvent
Event raised when an element wishes to be scrolled into view.
Inherited from Control
static
SelectedContentProperty
The selected content property
static
SelectedContentTemplateProperty
The selected content template property
static
SelectedIndexProperty
Defines the SelectedIndex property.
Inherited from SelectingItemsControl
static
SelectedItemProperty
Defines the SelectedItem property.
Inherited from SelectingItemsControl
static
SelectedItemsProperty
Defines the SelectedItems property.
Inherited from SelectingItemsControl
static
SelectionChangedEvent
Defines the SelectionChanged event.
Inherited from SelectingItemsControl
static
SelectionModeProperty
Defines the SelectionMode property.
Inherited from SelectingItemsControl
static
SelectionProperty
Defines the Selection property.
Inherited from SelectingItemsControl
static
TabStripPlacementProperty
Defines the TabStripPlacement property.
static
TagProperty
Defines the Tag property.
Inherited from Control
static
TappedEvent
Defines the Tapped event.
Inherited from InputElement
static
TemplateAppliedEvent
Defines the TemplateApplied routed event.
Inherited from TemplatedControl
static
TemplatedParentProperty
Defines the TemplatedParent property.
Inherited from StyledElement
static
TemplateProperty
Defines the Template property.
Inherited from TemplatedControl
static
TextInputEvent
Defines the TextInput event.
Inherited from InputElement
static
TextInputMethodClientRequestedEvent
Defines the TextInputMethodClientRequested event.
Inherited from InputElement
static
TextInputOptionsQueryEvent
Defines the TextInputOptionsQuery event.
Inherited from InputElement
static
TransformedBoundsProperty
Inherited from Visual
static
TransitionsProperty
Defines the Transitions property.
Inherited from Animatable
static
UseLayoutRoundingProperty
Defines the UseLayoutRoundingProperty property.
Inherited from Layoutable
static
VerticalAlignmentProperty
Defines the VerticalAlignment property.
Inherited from Layoutable
static
VerticalContentAlignmentProperty
Defines the VerticalContentAlignment property.
static
VisualParentProperty
Defines the VisualParent property.
Inherited from Visual
static
WidthProperty
Defines the Width property.
Inherited from Layoutable
static
ZIndexProperty
Defines the ZIndex property.
Inherited from Visual
static

Properties

Name Value Summary
AlwaysSelected bool
Gets a value indicating whether AlwaysSelected is set.
Inherited from SelectingItemsControl
AutoScrollToSelectedItem bool
Gets or sets a value indicating whether to automatically scroll to newly selected items.
Inherited from SelectingItemsControl
Background IBrush
Gets or sets the brush used to draw the control's background.
Inherited from TemplatedControl
BorderBrush IBrush
Gets or sets the brush used to draw the control's border.
Inherited from TemplatedControl
BorderThickness Thickness
Gets or sets the thickness of the control's border.
Inherited from TemplatedControl
Bounds Rect
Gets the bounds of the control relative to its parent.
Inherited from Visual
Classes Classes
Gets or sets the styled element's classes.
Inherited from StyledElement
Clip Geometry
Gets or sets the geometry clip for this visual.
Inherited from Visual
ClipToBounds bool
Gets or sets a value indicating whether the control should be clipped to its bounds.
Inherited from Visual
Clock IClock
Gets or sets the clock which controls the animations on the control.
Inherited from Animatable
ContentTemplate IDataTemplate
Gets or sets the default data template used to display the content of the selected tab.
ContextFlyout FlyoutBase?
Gets or sets a context flyout to the control
Inherited from Control
ContextMenu ContextMenu?
Gets or sets a context menu to the control.
Inherited from Control
Cursor Cursor?
Gets or sets associated mouse cursor.
Inherited from InputElement
DataContext object?
Gets or sets the control's data context.
Inherited from StyledElement
DataTemplates DataTemplates
Gets or sets the data templates for the control.
Inherited from Control
DesiredSize Size
Gets the size that this element computed during the measure pass of the layout process.
Inherited from Layoutable
Focusable bool
Gets or sets a value indicating whether the control can receive focus.
Inherited from InputElement
FocusAdorner ITemplate<IControl>?
Gets or sets the control's focus adorner.
Inherited from Control
FontFamily FontFamily
Gets or sets the font family used to draw the control's text.
Inherited from TemplatedControl
FontSize double
Gets or sets the size of the control's text in points.
Inherited from TemplatedControl
FontStyle FontStyle
Gets or sets the font style used to draw the control's text.
Inherited from TemplatedControl
FontWeight FontWeight
Gets or sets the font weight used to draw the control's text.
Inherited from TemplatedControl
Foreground IBrush
Gets or sets the brush used to draw the control's text and other foreground elements.
Inherited from TemplatedControl
GestureRecognizers GestureRecognizerCollection
Inherited from InputElement
Height double
Gets or sets the height of the element.
Inherited from Layoutable
HorizontalAlignment HorizontalAlignment
Gets or sets the element's preferred horizontal alignment in its parent.
Inherited from Layoutable
HorizontalContentAlignment HorizontalAlignment
Gets or sets the horizontal alignment of the content within the control.
InheritanceParent IAvaloniaObject
Gets or sets the parent object that inherited AvaloniaProperty values are inherited from.
Inherited from AvaloniaObject
IsArrangeValid bool
Gets a value indicating whether the control's layouts arrange is valid.
Inherited from Layoutable
IsEffectivelyEnabled bool
Gets a value indicating whether this control and all its parents are enabled.
Inherited from InputElement
IsEffectivelyVisible bool
Gets a value indicating whether this control and all its parents are visible.
Inherited from Visual
IsEnabled bool
Gets or sets a value indicating whether the control is enabled for user interaction.
Inherited from InputElement
IsEnabledCore bool
Allows a derived class to override the enabled state of the control.
Inherited from InputElement
IsFocused bool
Gets a value indicating whether the control is focused.
Inherited from InputElement
IsHitTestVisible bool
Gets or sets a value indicating whether the control is considered for hit testing.
Inherited from InputElement
IsInitialized bool
Gets a value that indicates whether the element has finished initialization.
Inherited from StyledElement
IsKeyboardFocusWithin bool
Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements.
Inherited from InputElement
IsMeasureValid bool
Gets a value indicating whether the control's layout measure is valid.
Inherited from Layoutable
IsPointerOver bool
Gets a value indicating whether the pointer is currently over the control.
Inherited from InputElement
IsVisible bool
Gets or sets a value indicating whether this control is visible.
Inherited from Visual
ItemContainerGenerator IItemContainerGenerator
Gets the IItemContainerGenerator for the control.
Inherited from ItemsControl
ItemCount int
Gets the number of items in Items.
Inherited from ItemsControl
Items IEnumerable
Gets or sets the items to display.
Inherited from ItemsControl
ItemsPanel ITemplate<IPanel>
Gets or sets the panel used to display the items.
Inherited from ItemsControl
ItemTemplate IDataTemplate
Gets or sets the data template used to display the items in the control.
Inherited from ItemsControl
KeyBindings List<KeyBinding>
Inherited from InputElement
LogicalChildren IAvaloniaList<ILogical>
Gets the styled element's logical children.
Inherited from StyledElement
Margin Thickness
Gets or sets the margin around the element.
Inherited from Layoutable
MaxHeight double
Gets or sets the maximum height of the element.
Inherited from Layoutable
MaxWidth double
Gets or sets the maximum width of the element.
Inherited from Layoutable
MinHeight double
Gets or sets the minimum height of the element.
Inherited from Layoutable
MinWidth double
Gets or sets the minimum width of the element.
Inherited from Layoutable
Name string?
Gets or sets the name of the styled element.
Inherited from StyledElement
Opacity double
Gets or sets the opacity of the control.
Inherited from Visual
OpacityMask IBrush
Gets or sets the opacity mask of the control.
Inherited from Visual
Padding Thickness
Gets or sets the padding placed between the border of the control and its content.
Inherited from TemplatedControl
Parent IControl?
Inherited from Control
Parent IStyledElement?
Gets the styled element's logical parent.
Inherited from StyledElement
Presenter IItemsPresenter
Gets the items presenter control.
Inherited from ItemsControl
PseudoClasses IPseudoClasses
Gets the Classes collection in a form that allows adding and removing pseudoclasses.
Inherited from StyledElement
RenderTransform ITransform
Gets or sets the render transform of the control.
Inherited from Visual
RenderTransformOrigin RelativePoint
Gets or sets the transform origin of the control.
Inherited from Visual
Resources IResourceDictionary
Gets or sets the styled element's resource dictionary.
Inherited from StyledElement
SelectedContent object
Gets or sets the content of the selected tab.
SelectedContentTemplate IDataTemplate
Gets or sets the content template for the selected tab.
SelectedIndex int
Gets or sets the index of the selected item.
Inherited from SelectingItemsControl
SelectedItem object?
Gets or sets the selected item.
Inherited from SelectingItemsControl
SelectedItems IList?
Gets or sets the selected items.
Inherited from SelectingItemsControl
Selection ISelectionModel
Gets or sets the model that holds the current selection.
Inherited from SelectingItemsControl
SelectionMode SelectionMode
Gets or sets the selection mode.
Inherited from SelectingItemsControl
Styles Styles
Gets the styles for the styled element.
Inherited from StyledElement
TabStripPlacement Dock
Gets or sets the tabstrip placement of the TabControl.
Tag object?
Gets or sets a user-defined object attached to the control.
Inherited from Control
Template IControlTemplate
Gets or sets the template that defines the control's appearance.
Inherited from TemplatedControl
TemplatedParent ITemplatedControl?
Gets the styled element whose lookless template this styled element is part of.
Inherited from StyledElement
this[AvaloniaProperty] object
Gets or sets the value of a AvaloniaProperty.
Inherited from AvaloniaObject
this[IndexerDescriptor] IBinding
Gets or sets a binding for a AvaloniaProperty.
Inherited from AvaloniaObject
TransformedBounds TransformedBounds?
Gets the bounds of the control relative to the window, accounting for rendering transforms.
Inherited from Visual
Transitions Transitions?
Gets or sets the property transitions for the control.
Inherited from Animatable
UseLayoutRounding bool
Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time.
Inherited from Layoutable
VerticalAlignment VerticalAlignment
Gets or sets the element's preferred vertical alignment in its parent.
Inherited from Layoutable
VerticalContentAlignment VerticalAlignment
Gets or sets the vertical alignment of the content within the control.
VisualChildren IAvaloniaList<IVisual>
Gets the control's child visuals.
Inherited from Visual
VisualRoot IRenderRoot
Gets the root of the visual tree, if the control is attached to a visual tree.
Inherited from Visual
Width double
Gets or sets the width of the element.
Inherited from Layoutable
ZIndex int
Gets or sets the Z index of the control.
Inherited from Visual

Methods

Name Value Summary
AddHandler(RoutedEvent, Delegate, RoutingStrategies, bool) void
Adds a handler for the specified routed event.
Inherited from Interactive
AddHandler<TEventArgs>(RoutedEvent<TEventArgs>, EventHandler<TEventArgs>, RoutingStrategies, bool) void
Adds a handler for the specified routed event.
Inherited from Interactive
AffectsArrange(AvaloniaProperty[]) void
Marks a property as affecting the control's arrangement.
Inherited from Layoutable
static
AffectsArrange<T>(AvaloniaProperty[]) void
Marks a property as affecting the control's arrangement.
Inherited from Layoutable
static
AffectsMeasure(AvaloniaProperty[]) void
Marks a property as affecting the control's measurement.
Inherited from Layoutable
static
AffectsMeasure<T>(AvaloniaProperty[]) void
Marks a property as affecting the control's measurement.
Inherited from Layoutable
static
AffectsRender(AvaloniaProperty[]) void
Indicates that a property change should cause InvalidateVisual() to be called.
Inherited from Visual
static
AffectsRender<T>(AvaloniaProperty[]) void
Indicates that a property change should cause InvalidateVisual() to be called.
Inherited from Visual
static
ApplyStyling() bool
Applies styling to the control if the control is initialized and styling is not already applied.
Inherited from StyledElement
ApplyTemplate() void
Creates the visual children of the control, if necessary
Inherited from TemplatedControl
Arrange(Rect) void
Arranges the control and its children.
Inherited from Layoutable
ArrangeCore(Rect) void
The default implementation of the control's arrange pass.
Inherited from Layoutable
ArrangeOverride(Size) Size
Positions child elements as part of a layout pass.
Inherited from Layoutable
BeginBatchUpdate() void
Inherited from AvaloniaObject
BeginInit() void
Inherited from SelectingItemsControl
Bind<T>(DirectPropertyBase<T>, IObservable<BindingValue<T>>) IDisposable
Binds a AvaloniaProperty to an observable.
Inherited from AvaloniaObject
Bind<T>(StyledPropertyBase<T>, IObservable<BindingValue<T>>, BindingPriority) IDisposable
Binds a AvaloniaProperty to an observable.
Inherited from AvaloniaObject
BuildEventRoute(RoutedEvent) EventRoute
Builds an event route for a routed event.
Inherited from Interactive
CheckAccess() bool
Inherited from AvaloniaObject
ClearValue(AvaloniaProperty) void
Clears a AvaloniaProperty's local value.
Inherited from AvaloniaObject
ClearValue<T>(AvaloniaProperty<T>) void
Clears a AvaloniaProperty's local value.
Inherited from AvaloniaObject
ClearValue<T>(DirectPropertyBase<T>) void
Clears a AvaloniaProperty's local value.
Inherited from AvaloniaObject
ClearValue<T>(StyledPropertyBase<T>) void
Clears a AvaloniaProperty's local value.
Inherited from AvaloniaObject
CoerceValue<T>(StyledPropertyBase<T>) void
Coerces the specified AvaloniaProperty.
Inherited from AvaloniaObject
CreateItemContainerGenerator() IItemContainerGenerator
DisableTransitions() void
Disables transitions for the control.
Inherited from Animatable
ElementAt(IEnumerable, int) object
Gets the item at the specified index in a collection.
Inherited from ItemsControl
static
EnableTransitions() void
Enables transitions for the control.
Inherited from Animatable
EndBatchUpdate() void
Inherited from AvaloniaObject
EndInit() void
Inherited from SelectingItemsControl
Equals(object) bool
Compares two objects using reference equality.
Inherited from AvaloniaObject
Focus() void
Focuses the control.
Inherited from InputElement
GetBaseValue<T>(StyledPropertyBase<T>, BindingPriority) Optional<T>
Gets an AvaloniaProperty base value.
Inherited from AvaloniaObject
GetContainerFromEventSource(IInteractive?) IControl?
Tries to get the container that was the source of an event.
Inherited from SelectingItemsControl
GetHashCode() int
Gets the hash code for the object.
Inherited from AvaloniaObject
GetIsTemplateFocusTarget(Control) bool
Gets the value of the IsTemplateFocusTargetProperty attached property on a control.
Inherited from TemplatedControl
static
GetNextControl(INavigableContainer, NavigationDirection, IInputElement, bool) IInputElement
Inherited from ItemsControl
static
GetTemplateFocusTarget() IControl
Gets the element that receives the focus adorner.
Inherited from TemplatedControl
GetValue(AvaloniaProperty) object
Gets a AvaloniaProperty value.
Inherited from AvaloniaObject
GetValue<T>(DirectPropertyBase<T>) T
Gets a AvaloniaProperty value.
Inherited from AvaloniaObject
GetValue<T>(StyledPropertyBase<T>) T
Gets a AvaloniaProperty value.
Inherited from AvaloniaObject
IndexOf(IEnumerable, object) int
Gets the index of an item in a collection.
Inherited from ItemsControl
static
InitializeIfNeeded() void
Inherited from StyledElement
InvalidateArrange() void
Invalidates the arrangement of the control and queues a new layout pass.
Inherited from Layoutable
InvalidateMeasure() void
Invalidates the measurement of the control and queues a new layout pass.
Inherited from Layoutable
InvalidateStyles() void
Inherited from Layoutable
InvalidateVisual() void
Invalidates the visual and queues a repaint.
Inherited from Visual
IsAnimating(AvaloniaProperty) bool
Checks whether a AvaloniaProperty is animating.
Inherited from AvaloniaObject
IsSet(AvaloniaProperty) bool
Checks whether a AvaloniaProperty is set on this object.
Inherited from AvaloniaObject
ItemsChanged(AvaloniaPropertyChangedEventArgs) void
Called when the Items property changes.
Inherited from ItemsControl
ItemsCollectionChanged(object, NotifyCollectionChangedEventArgs) void
Inherited from SelectingItemsControl
LogicalChildrenCollectionChanged(object, NotifyCollectionChangedEventArgs) void
Inherited from Visual
Measure(Size) void
Carries out a measure of the control.
Inherited from Layoutable
MeasureCore(Size) Size
The default implementation of the control's measure pass.
Inherited from Layoutable
MeasureOverride(Size) Size
Measures the control and its child elements as part of a layout pass.
Inherited from Layoutable
MoveSelection(IControl?, NavigationDirection, bool) bool
Moves the selection in the specified direction relative to the specified container.
Inherited from SelectingItemsControl
MoveSelection(NavigationDirection, bool) bool
Moves the selection in the specified direction relative to the current selection.
Inherited from SelectingItemsControl
NotifyChildResourcesChanged(ResourcesChangedEventArgs) void
Inherited from TemplatedControl
OnApplyTemplate(TemplateAppliedEventArgs) void
OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs) void
Called when the styled element is added to a rooted logical tree.
Inherited from TemplatedControl
OnAttachedToVisualTree(VisualTreeAttachmentEventArgs) void
Inherited from SelectingItemsControl
OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs) void
Inherited from Control
OnContainersDematerialized(ItemContainerEventArgs) void
Called when containers are dematerialized for the ItemsControl by its ItemContainerGenerator.
Inherited from SelectingItemsControl
OnContainersMaterialized(ItemContainerEventArgs) void
OnContainersRecycled(ItemContainerEventArgs) void
OnDataContextBeginUpdate() void
Called when the DataContext begins updating.
Inherited from SelectingItemsControl
OnDataContextChanged(EventArgs) void
Called when the DataContext property changes.
Inherited from StyledElement
OnDataContextEndUpdate() void
Called when the DataContext finishes updating.
Inherited from SelectingItemsControl
OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs) void
Called when the styled element is removed from a rooted logical tree.
Inherited from TemplatedControl
OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs) void
Called when the control is removed from a rooted visual tree.
Inherited from Visual
OnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs) void
Inherited from Control
OnGotFocus(GotFocusEventArgs) void
OnInitialized() void
Inherited from SelectingItemsControl
OnKeyDown(KeyEventArgs) void
Inherited from SelectingItemsControl
OnKeyUp(KeyEventArgs) void
Called before the KeyUp event occurs.
Inherited from InputElement
OnLostFocus(RoutedEventArgs) void
Called before the LostFocus event occurs.
Inherited from Control
OnMeasureInvalidated() void
Called by InvalidateMeasure
Inherited from Layoutable
OnPointerCaptureLost(PointerCaptureLostEventArgs) void
Called before the PointerCaptureLost event occurs.
Inherited from InputElement
OnPointerEnter(PointerEventArgs) void
Called before the PointerEnter event occurs.
Inherited from InputElement
OnPointerLeave(PointerEventArgs) void
Called before the PointerLeave event occurs.
Inherited from InputElement
OnPointerMoved(PointerEventArgs) void
Called before the PointerMoved event occurs.
Inherited from InputElement
OnPointerPressed(PointerPressedEventArgs) void
Called before the PointerPressed event occurs.
OnPointerReleased(PointerReleasedEventArgs) void
OnPointerWheelChanged(PointerWheelEventArgs) void
Called before the PointerWheelChanged event occurs.
Inherited from InputElement
OnPropertyChanged<T>(AvaloniaPropertyChangedEventArgs<T>) void
Inherited from SelectingItemsControl
OnPropertyChangedCore<T>(AvaloniaPropertyChangedEventArgs<T>) void
Inherited from Animatable
OnTemplateApplied(TemplateAppliedEventArgs) void
Called when the control's template is applied.
Inherited from TemplatedControl
OnTemplateChanged(AvaloniaPropertyChangedEventArgs) void
Called when the Template property changes.
Inherited from TemplatedControl
OnTextInput(TextInputEventArgs) void
Called before the TextInput event occurs.
Inherited from InputElement
OnVisualParentChanged(IVisual, IVisual) void
Called when the control's visual parent changes.
Inherited from Layoutable
RaiseEvent(RoutedEventArgs) void
Raises a routed event.
Inherited from Interactive
RegisterContentPresenter(IContentPresenter) bool
Called when an IContentPresenter is registered with the control.
RemoveHandler(RoutedEvent, Delegate) void
Removes a handler for the specified routed event.
Inherited from Interactive
RemoveHandler<TEventArgs>(RoutedEvent<TEventArgs>, EventHandler<TEventArgs>) void
Removes a handler for the specified routed event.
Inherited from Interactive
Render(DrawingContext) void
Renders the visual to a DrawingContext.
Inherited from Visual
ScrollIntoView(int) void
Scrolls the specified item into view.
Inherited from SelectingItemsControl
ScrollIntoView(object) void
Scrolls the specified item into view.
Inherited from SelectingItemsControl
SetIsTemplateFocusTarget(Control, bool) void
Sets the value of the IsTemplateFocusTargetProperty attached property on a control.
Inherited from TemplatedControl
static
SetValue(AvaloniaProperty, object, BindingPriority) void
Sets a AvaloniaProperty value.
Inherited from AvaloniaObject
SetValue<T>(DirectPropertyBase<T>, T) void
Sets a AvaloniaProperty value.
Inherited from AvaloniaObject
SetValue<T>(StyledPropertyBase<T>, T, BindingPriority) IDisposable
Sets a AvaloniaProperty value.
Inherited from AvaloniaObject
UpdateDataValidation<T>(AvaloniaProperty<T>, BindingValue<T>) void
Called to update the validation state for properties for which data validation is enabled.
Inherited from SelectingItemsControl
UpdateIsEffectivelyEnabled() void
Updates the IsEffectivelyEnabled property value according to the parent control's enabled state and IsEnabledCore.
Inherited from InputElement
UpdateSelection(IControl, bool, bool, bool, bool) void
Updates the selection for a container based on user interaction.
Inherited from SelectingItemsControl
UpdateSelection(int, bool, bool, bool, bool) void
Updates the selection for an item based on user interaction.
Inherited from SelectingItemsControl
UpdateSelectionFromEventSource(IInteractive?, bool, bool, bool, bool) bool
Updates the selection based on an event that may have originated in a container that belongs to the control.
Inherited from SelectingItemsControl
VerifyAccess() void
Inherited from AvaloniaObject

Extension Methods

Name Value Summary
AddDisposableHandler<TEventArgs>(RoutedEvent<TEventArgs>, EventHandler<TEventArgs>, RoutingStrategies, bool) IDisposable
Adds a handler for the specified routed event and returns a disposable that can terminate the event subscription.
Bind(AvaloniaProperty, IObservable<BindingValue<object>>, BindingPriority) IDisposable
Binds a AvaloniaProperty to an observable.
Bind<T>(AvaloniaProperty<T>, IObservable<BindingValue<T>>, BindingPriority) IDisposable
Binds a AvaloniaProperty to an observable.
BindClass(string, IBinding, object) IDisposable
BringIntoView() void
Tries to bring the control into view.
BringIntoView(Rect) void
Tries to bring the control into view.
CalculateDistanceFromAncestor(IVisual) int
Calculates the distance from a visual's ancestor.
Find<T>(string) T
Finds a named element in an INameScope.
FindAncestorOfType<T>(bool) T
Finds first ancestor of given type.
FindCommonVisualAncestor(IVisual) IVisual
Tries to get the first common ancestor of two visuals.
FindControl<T>(string) T
Finds the named control in the scope of the specified control.
FindDataTemplate(object, IDataTemplate?) IDataTemplate?
Find a data template that matches a piece of data.
FindDescendantOfType<T>(bool) T
Finds first descendant of given type.
FindLogicalAncestorOfType<T>(bool) T
Finds first ancestor of given type.
FindLogicalDescendantOfType<T>(bool) T
Finds first descendant of given type.
FindNameScope() INameScope
FindResource(object) object?
Finds the specified resource by searching up the logical tree and then global styles.
Get<T>(string) T
Gets a named element from an INameScope or throws if no element of the requested name was found.
GetBindingObservable(AvaloniaProperty) IObservable<BindingValue<object>>
Gets an observable for a AvaloniaProperty.
GetBindingObservable<T>(AvaloniaProperty<T>) IObservable<BindingValue<T>>
Gets an observable for a AvaloniaProperty.
GetBindingSubject(AvaloniaProperty, BindingPriority) ISubject<BindingValue<object>>
Gets a subject for a AvaloniaProperty.
GetBindingSubject<T>(AvaloniaProperty<T>, BindingPriority) ISubject<BindingValue<T>>
Gets a subject for a AvaloniaProperty.
GetDiagnostic(AvaloniaProperty) AvaloniaPropertyValue
Gets a diagnostic for a AvaloniaProperty on a AvaloniaObject.
GetInputElementsAt(Point) IEnumerable<IInputElement>
Returns the active input elements at a point on an IInputElement.
GetLogicalAncestors() IEnumerable<ILogical>
Enumerates the ancestors of an ILogical in the logical tree.
GetLogicalChildren() IEnumerable<ILogical>
Enumerates the children of an ILogical in the logical tree.
GetLogicalDescendants() IEnumerable<ILogical>
Enumerates the descendants of an ILogical in the logical tree.
GetLogicalParent() ILogical
Gets the logical parent of an ILogical.
GetLogicalParent<T>() T
Gets the logical parent of an ILogical.
GetLogicalSiblings() IEnumerable<ILogical>
Enumerates the siblings of an ILogical in the logical tree.
GetObservable(AvaloniaProperty) IObservable<object>
Gets an observable for a AvaloniaProperty.
GetObservable<T>(AvaloniaProperty<T>) IObservable<T>
Gets an observable for a AvaloniaProperty.
GetObservable<TEventArgs>(RoutedEvent<TEventArgs>, RoutingStrategies, bool) IObservable<TEventArgs>
Gets an observable for a RoutedEvent<TEventArgs>.
GetPropertyChangedObservable(AvaloniaProperty) IObservable<AvaloniaPropertyChangedEventArgs>
Gets an observable that listens for property changed events for an AvaloniaProperty.
GetResourceObservable(object, Func<object?, object?>?) IObservable<object?>
GetSelfAndLogicalAncestors() IEnumerable<ILogical>
Enumerates an ILogical and its ancestors in the logical tree.
GetSelfAndLogicalDescendants() IEnumerable<ILogical>
Enumerates an ILogical and its descendants in the logical tree.
GetSelfAndVisualAncestors() IEnumerable<IVisual>
Enumerates an IVisual and its ancestors in the visual tree.
GetSelfAndVisualDescendants() IEnumerable<IVisual>
Enumerates an IVisual and its descendants in the visual tree.
GetStyleDiagnostics() StyleDiagnostics
Gets a style diagnostics for a StyledElement.
GetSubject(AvaloniaProperty, BindingPriority) ISubject<object>
Gets a subject for a AvaloniaProperty.
GetSubject<T>(AvaloniaProperty<T>, BindingPriority) ISubject<T>
Gets a subject for a AvaloniaProperty.
GetTemplateChildren() IEnumerable<IControl>
GetVisualAncestors() IEnumerable<IVisual>
Enumerates the ancestors of an IVisual in the visual tree.
GetVisualAt(Point) IVisual
Gets the first visual in the visual tree whose bounds contain a point.
GetVisualAt(Point, Func<IVisual, bool>) IVisual
Gets the first visual in the visual tree whose bounds contain a point.
GetVisualChildren() IEnumerable<IVisual>
Enumerates the children of an IVisual in the visual tree.
GetVisualDescendants() IEnumerable<IVisual>
Enumerates the descendants of an IVisual in the visual tree.
GetVisualParent() IVisual
Gets the visual parent of an IVisual.
GetVisualParent<T>() T
Gets the visual parent of an IVisual.
GetVisualRoot() IRenderRoot
Gets the root visual for an IVisual.
GetVisualsAt(Point) IEnumerable<IVisual>
Enumerates the visible visuals in the visual tree whose bounds contain a point.
GetVisualsAt(Point, Func<IVisual, bool>) IEnumerable<IVisual>
Enumerates the visuals in the visual tree whose bounds contain a point.
HitTestCustom(Point) bool
InputHitTest(Point) IInputElement?
Returns the topmost active input element at a point on an IInputElement.
InputHitTest(Point, Func<IVisual, bool>) IInputElement?
Returns the topmost active input element at a point on an IInputElement.
IsLogicalAncestorOf(ILogical) bool
Tests whether an ILogical is an ancestor of another logical.
IsVisualAncestorOf(IVisual) bool
Tests whether an IVisual is an ancestor of another visual.
PointToClient(PixelPoint) Point
Converts a point from screen to client coordinates.
PointToScreen(Point) PixelPoint
Converts a point from client to screen coordinates.
RegisterInNameScope<TabControl>(INameScope) T
TransformToVisual(IVisual) Matrix?
Returns a transform that transforms the visual's coordinates into the coordinates of the specified to.
TranslatePoint(Point, IVisual) Point?
Translates a point relative to this visual to coordinates that are relative to the specified visual.
TryFindResource(object, object?) bool
Tries to the specified resource by searching up the logical tree and then global styles.