Skip to main content

DrawerPage Class

Definition

Assembly:Avalonia.Controls
Package:Avalonia

A page that provides a drawer pattern.

public class DrawerPage

Inheritance: object -> AvaloniaObject -> Animatable -> StyledElement -> Visual -> Layoutable -> Interactive -> InputElement -> Control -> TemplatedControl -> Page -> DrawerPage

Constructors

NameDescription
DrawerPageNo summary available.

DrawerPage Constructor

public DrawerPage()

Methods

NameDescription
AddHandler (2 overloads)Adds a handler for the specified routed event. Inherited from Interactive.
ApplyStylingApplies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement.
ApplyTemplateCreates the visual children of the control, if necessary Inherited from TemplatedControl.
ArrangeArranges the control and its children. Inherited from Layoutable.
BeginInitInherited from StyledElement.
Bind (8 overloads)Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject.
CheckAccessReturns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject.
ClearValue (4 overloads)Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject.
CoerceValueCoerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
EndInitInherited from StyledElement.
EqualsCompares two objects using reference equality. Inherited from AvaloniaObject.
FocusFocuses the control. Inherited from InputElement.
GetBaseValueInherited from AvaloniaObject.
GetFlowDirectionGets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
GetHashCodeGets the hash code for the object. Inherited from AvaloniaObject.
GetIsHoldingEnabledInherited from InputElement.
GetIsHoldWithMouseEnabledInherited from InputElement.
GetIsTemplateFocusTargetGets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
GetValue (3 overloads)Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
InvalidateArrangeInvalidates the arrangement of the control and queues a new layout pass. Inherited from Layoutable.
InvalidateMeasureInvalidates the measurement of the control and queues a new layout pass. Inherited from Layoutable.
InvalidateVisualInvalidates the visual and queues a repaint. Inherited from Visual.
IsAnimatingChecks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsSetChecks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject.
MeasureCarries out a measure of the control. Inherited from Layoutable.
RaiseEventRaises a routed event. Inherited from Interactive.
RemoveHandler (2 overloads)Removes a handler for the specified routed event. Inherited from Interactive.
RenderRenders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual.
SetCurrentValue (2 overloads)Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject.
SetFlowDirectionSets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
SetIsHoldingEnabledInherited from InputElement.
SetIsHoldWithMouseEnabledInherited from InputElement.
SetIsTemplateFocusTargetSets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
SetValue (3 overloads)Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
TryGetResourceInherited from StyledElement.
UpdateLayoutExecutes a layout pass. Inherited from Layoutable.
VerifyAccessChecks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject.

Properties

NameDescription
ActualThemeVariantGets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement.
BackdropBrushGets or sets the backdrop brush for overlay mode.
BackgroundGets or sets the brush used to draw the control's background. Inherited from TemplatedControl.
BackgroundSizingGets or sets how the control's background is drawn relative to the control's border. Inherited from TemplatedControl.
BorderBrushGets or sets the brush used to draw the control's border. Inherited from TemplatedControl.
BorderThicknessGets or sets the thickness of the control's border. Inherited from TemplatedControl.
BoundsGets the bounds of the control relative to its parent. Inherited from Visual.
CacheModeGets or sets the cache mode of the visual. Inherited from Visual.
ClassesGets or sets the styled element's classes. Inherited from StyledElement.
ClipGets or sets the geometry clip for this visual. Inherited from Visual.
ClipToBoundsGets or sets a value indicating whether the control should be clipped to its bounds. Inherited from Visual.
CompactDrawerLengthGets or sets the compact drawer width.
ContentGets or sets the main content.
ContentTemplateGets or sets the data template used to display Avalonia.Controls.DrawerPage.Content.
ContextFlyoutGets or sets a context flyout to the control Inherited from Control.
ContextMenuGets or sets a context menu to the control. Inherited from Control.
CornerRadiusGets or sets the radius of the border rounded corners. Inherited from TemplatedControl.
CurrentPageGets or sets the currently active child page. Inherited from Page.
CursorGets or sets associated mouse cursor. Inherited from InputElement.
DataContextGets or sets the control's data context. Inherited from StyledElement.
DataTemplatesGets or sets the data templates for the control. Inherited from Control.
DesiredSizeGets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable.
DispatcherReturns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
DisplayModeGets or sets the Avalonia.Controls.SplitViewDisplayMode.
DrawerGets or sets the drawer pane content.
DrawerBackgroundGets or sets the background brush of the drawer pane.
DrawerBehaviorGets or sets the open/close behavior of the drawer pane.
DrawerBreakpointLengthGets or sets the size threshold for switching to overlay mode. Set to 0 to disable.
DrawerFooterGets or sets the footer content displayed at the bottom of the drawer pane.
DrawerFooterBackgroundGets or sets the background brush of the drawer footer area.
DrawerFooterForegroundGets or sets the foreground brush of the drawer footer area.
DrawerFooterTemplateGets or sets the data template used to display Avalonia.Controls.DrawerPage.DrawerFooter.
DrawerHeaderGets or sets the header content displayed at the top of the drawer pane.
DrawerHeaderBackgroundGets or sets the background brush of the drawer header area.
DrawerHeaderForegroundGets or sets the foreground brush of the drawer header area.
DrawerHeaderTemplateGets or sets the data template used to display Avalonia.Controls.DrawerPage.DrawerHeader.
DrawerIconGets or sets the icon displayed in the drawer toggle button.
DrawerIconTemplateGets or sets the data template used to display the drawer icon.
DrawerLayoutBehaviorGets or sets the layout behavior of the drawer.
DrawerLengthGets or sets the width of the drawer pane.
DrawerPlacementGets or sets which edge of the control the drawer appears from.
DrawerTemplateGets or sets the data template used to display Avalonia.Controls.DrawerPage.Drawer content.
EffectGets or sets the effect of the control. Inherited from Visual.
FlowDirectionGets or sets the text flow direction. Inherited from Visual.
FocusableGets or sets a value indicating whether the control can receive focus. Inherited from InputElement.
FocusAdornerGets or sets the control's focus adorner. Inherited from Control.
FontFamilyGets or sets the font family used to draw the control's text. Inherited from TemplatedControl.
FontFeaturesGets or sets the font features turned on/off. Inherited from TemplatedControl.
FontSizeGets or sets the size of the control's text in points. Inherited from TemplatedControl.
FontStretchGets or sets the font stretch used to draw the control's text. Inherited from TemplatedControl.
FontStyleGets or sets the font style used to draw the control's text. Inherited from TemplatedControl.
FontWeightGets or sets the font weight used to draw the control's text. Inherited from TemplatedControl.
ForegroundGets or sets the brush used to draw the control's text and other foreground elements. Inherited from TemplatedControl.
GestureRecognizersInherited from InputElement.
HasMirrorTransformGets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual.
HeaderGets or sets the header content displayed in the navigation bar or tab strip. Inherited from Page.
HeaderTemplateGets or sets the data template used to display the header. Inherited from Page.
HeightGets or sets the height of the element. Inherited from Layoutable.
HorizontalAlignmentGets or sets the element's preferred horizontal alignment in its parent. Inherited from Layoutable.
HorizontalContentAlignmentGets or sets the horizontal alignment of the detail content.
IconGets or sets the icon displayed alongside the page header. Inherited from Page.
IconTemplateGets or sets the data template used to display the icon. Inherited from Page.
IsArrangeValidGets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable.
IsEffectivelyEnabledGets a value indicating whether this control and all its parents are enabled. Inherited from InputElement.
IsEffectivelyVisibleGets a value indicating whether this control and all its parents are visible. Inherited from Visual.
IsEnabledGets or sets a value indicating whether the control is enabled for user interaction. Inherited from InputElement.
IsFocusedGets a value indicating whether the control is focused. Inherited from InputElement.
IsGestureEnabledGets or sets whether swipe gestures can open or close the drawer.
IsHitTestVisibleGets or sets a value indicating whether the control is considered for hit testing. Inherited from InputElement.
IsInitializedGets a value that indicates whether the element has finished initialization. Inherited from StyledElement.
IsInNavigationPageGets or sets whether this page is currently hosted inside a NavigationPage. Inherited from Page.
IsKeyboardFocusWithinGets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement.
IsLoadedGets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
IsMeasureValidGets a value indicating whether the control's layout measure is valid. Inherited from Layoutable.
IsOpenGets or sets whether the drawer pane is currently open.
IsPointerOverGets a value indicating whether the pointer is currently over the control. Inherited from InputElement.
IsTabStopGets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement.
IsVisibleGets or sets a value indicating whether this control is visible. Inherited from Visual.
ItemInherited from AvaloniaObject.
KeyBindingsInherited from InputElement.
LetterSpacingGets or sets the letter spacing for the control's text content. Inherited from TemplatedControl.
MarginGets or sets the margin around the element. Inherited from Layoutable.
MaxHeightGets or sets the maximum height of the element. Inherited from Layoutable.
MaxWidthGets or sets the maximum width of the element. Inherited from Layoutable.
MinHeightGets or sets the minimum height of the element. Inherited from Layoutable.
MinWidthGets or sets the minimum width of the element. Inherited from Layoutable.
NameGets or sets the name of the styled element. Inherited from StyledElement.
NavigationGets or sets the Avalonia.Controls.INavigation service provided by the parent NavigationPage. Inherited from Page.
OpacityGets or sets the opacity of the control. Inherited from Visual.
OpacityMaskGets or sets the opacity mask of the control. Inherited from Visual.
PaddingGets or sets the padding placed between the border of the control and its content. Inherited from TemplatedControl.
ParentGets the styled element's logical parent. Inherited from StyledElement.
RenderTransformGets or sets the render transform of the control. Inherited from Visual.
RenderTransformOriginGets or sets the transform origin of the control. Inherited from Visual.
ResourcesGets or sets the styled element's resource dictionary. Inherited from StyledElement.
SafeAreaPaddingGets or sets the safe-area padding applied to this page's content. Inherited from Page.
StyleKeyGets the type by which the element is styled. Inherited from StyledElement.
StylesGets the styles for the styled element. Inherited from StyledElement.
TabIndexGets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key. Inherited from InputElement.
TagGets or sets a user-defined object attached to the control. Inherited from Control.
TemplateGets or sets the template that defines the control's appearance. Inherited from TemplatedControl.
TemplatedParentGets the styled element whose lookless template this styled element is part of. Inherited from StyledElement.
ThemeGets or sets the theme to be applied to the element. Inherited from StyledElement.
TransitionsGets or sets the property transitions for the control. Inherited from Animatable.
UseLayoutRoundingGets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. Inherited from Layoutable.
VerticalAlignmentGets or sets the element's preferred vertical alignment in its parent. Inherited from Layoutable.
VerticalContentAlignmentGets or sets the vertical alignment of the detail content.
WidthGets or sets the width of the element. Inherited from Layoutable.
ZIndexGets or sets the Z index of the control. Inherited from Visual.

BackdropBrush Property

Gets or sets the backdrop brush for overlay mode.

public Avalonia.Media.IBrush BackdropBrush { get; set; }

CompactDrawerLength Property

Gets or sets the compact drawer width.

public double CompactDrawerLength { get; set; }

Content Property

Gets or sets the main content.

public object Content { get; set; }

ContentTemplate Property

Gets or sets the data template used to display Avalonia.Controls.DrawerPage.Content.

public Avalonia.Controls.Templates.IDataTemplate ContentTemplate { get; set; }

DisplayMode Property

Gets or sets the Avalonia.Controls.SplitViewDisplayMode.

public Avalonia.Controls.SplitViewDisplayMode DisplayMode { get; set; }

Drawer Property

Gets or sets the drawer pane content.

public object Drawer { get; set; }

DrawerBackground Property

Gets or sets the background brush of the drawer pane.

public Avalonia.Media.IBrush DrawerBackground { get; set; }

DrawerBehavior Property

Gets or sets the open/close behavior of the drawer pane.

public Avalonia.Controls.DrawerBehavior DrawerBehavior { get; set; }

DrawerBreakpointLength Property

Gets or sets the size threshold for switching to overlay mode. Set to 0 to disable.

public double DrawerBreakpointLength { get; set; }

DrawerFooter Property

Gets or sets the footer content displayed at the bottom of the drawer pane.

public object DrawerFooter { get; set; }

DrawerFooterBackground Property

Gets or sets the background brush of the drawer footer area.

public Avalonia.Media.IBrush DrawerFooterBackground { get; set; }

DrawerFooterForeground Property

Gets or sets the foreground brush of the drawer footer area.

public Avalonia.Media.IBrush DrawerFooterForeground { get; set; }

DrawerFooterTemplate Property

Gets or sets the data template used to display Avalonia.Controls.DrawerPage.DrawerFooter.

public Avalonia.Controls.Templates.IDataTemplate DrawerFooterTemplate { get; set; }

DrawerHeader Property

Gets or sets the header content displayed at the top of the drawer pane.

public object DrawerHeader { get; set; }

DrawerHeaderBackground Property

Gets or sets the background brush of the drawer header area.

public Avalonia.Media.IBrush DrawerHeaderBackground { get; set; }

DrawerHeaderForeground Property

Gets or sets the foreground brush of the drawer header area.

public Avalonia.Media.IBrush DrawerHeaderForeground { get; set; }

DrawerHeaderTemplate Property

Gets or sets the data template used to display Avalonia.Controls.DrawerPage.DrawerHeader.

public Avalonia.Controls.Templates.IDataTemplate DrawerHeaderTemplate { get; set; }

DrawerIcon Property

Gets or sets the icon displayed in the drawer toggle button.

public object DrawerIcon { get; set; }

DrawerIconTemplate Property

Gets or sets the data template used to display the drawer icon.

public Avalonia.Controls.Templates.IDataTemplate DrawerIconTemplate { get; set; }

DrawerLayoutBehavior Property

Gets or sets the layout behavior of the drawer.

public Avalonia.Controls.DrawerLayoutBehavior DrawerLayoutBehavior { get; set; }

DrawerLength Property

Gets or sets the width of the drawer pane.

public double DrawerLength { get; set; }

DrawerPlacement Property

Gets or sets which edge of the control the drawer appears from.

public Avalonia.Controls.DrawerPlacement DrawerPlacement { get; set; }

DrawerTemplate Property

Gets or sets the data template used to display Avalonia.Controls.DrawerPage.Drawer content.

public Avalonia.Controls.Templates.IDataTemplate DrawerTemplate { get; set; }

HorizontalContentAlignment Property

Gets or sets the horizontal alignment of the detail content.

public Avalonia.Layout.HorizontalAlignment HorizontalContentAlignment { get; set; }

IsGestureEnabled Property

Gets or sets whether swipe gestures can open or close the drawer.

public bool IsGestureEnabled { get; set; }

IsOpen Property

Gets or sets whether the drawer pane is currently open.

public bool IsOpen { get; set; }

Remarks

Setting this property to while Avalonia.Controls.DrawerPage.DrawerBehavior is Avalonia.Controls.DrawerBehavior.Disabled is a no-op; the value is coerced back to . When closing programmatically, the Avalonia.Controls.DrawerPage.Closing event is raised and can be cancelled; if cancelled, the property reverts to . The Avalonia.Controls.DrawerPage.Closing event is not raised when the drawer is forced closed because Avalonia.Controls.DrawerPage.DrawerBehavior is set to Avalonia.Controls.DrawerBehavior.Disabled.

VerticalContentAlignment Property

Gets or sets the vertical alignment of the detail content.

public Avalonia.Layout.VerticalAlignment VerticalContentAlignment { get; set; }

Fields

NameDescription
BackdropBrushPropertyDefines the Avalonia.Controls.DrawerPage.BackdropBrush property.
BackgroundPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Background property. Inherited from TemplatedControl.
BackgroundSizingPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.BackgroundSizing property. Inherited from TemplatedControl.
BorderBrushPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.BorderBrush property. Inherited from TemplatedControl.
BorderThicknessPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.BorderThickness property. Inherited from TemplatedControl.
BoundsPropertyDefines the Avalonia.Visual.Bounds property. Inherited from Visual.
CacheModePropertyDefines the Avalonia.Visual.CacheMode property. Inherited from Visual.
ClipPropertyDefines the Avalonia.Visual.Clip property. Inherited from Visual.
ClipToBoundsPropertyDefines the Avalonia.Visual.ClipToBounds property. Inherited from Visual.
ClosedEventDefines the Avalonia.Controls.DrawerPage.Closed routed event.
ClosingEventDefines the Avalonia.Controls.DrawerPage.Closing routed event.
CompactDrawerLengthPropertyDefines the Avalonia.Controls.DrawerPage.CompactDrawerLength property.
ContentPropertyDefines the Avalonia.Controls.DrawerPage.Content property.
ContentTemplatePropertyDefines the Avalonia.Controls.DrawerPage.ContentTemplate property.
ContextCanceledEventProvides event data for the Avalonia.Input.InputElement.ContextCanceled event. Inherited from InputElement.
ContextFlyoutPropertyDefines the Avalonia.Controls.Control.ContextFlyout property Inherited from Control.
ContextMenuPropertyDefines the Avalonia.Controls.Control.ContextMenu property. Inherited from Control.
ContextRequestedEventProvides event data for the Avalonia.Input.InputElement.ContextRequested event. Inherited from InputElement.
CornerRadiusPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.CornerRadius property. Inherited from TemplatedControl.
CurrentPagePropertyDefines the Avalonia.Controls.Page.CurrentPage property. Inherited from Page.
CursorPropertyGets or sets associated mouse cursor. Inherited from InputElement.
DataContextPropertyDefines the Avalonia.StyledElement.DataContext property. Inherited from StyledElement.
DesiredSizePropertyDefines the Avalonia.Layout.Layoutable.DesiredSize property. Inherited from Layoutable.
DisplayModePropertyDefines the Avalonia.Controls.DrawerPage.DisplayMode property.
DoubleTappedEventDefines the Avalonia.Input.InputElement.DoubleTapped event. Inherited from InputElement.
DrawerBackgroundPropertyDefines the Avalonia.Controls.DrawerPage.DrawerBackground property.
DrawerBehaviorPropertyDefines the Avalonia.Controls.DrawerPage.DrawerBehavior property.
DrawerBreakpointLengthPropertyDefines the Avalonia.Controls.DrawerPage.DrawerBreakpointLength property.
DrawerFooterBackgroundPropertyDefines the Avalonia.Controls.DrawerPage.DrawerFooterBackground property.
DrawerFooterForegroundPropertyDefines the Avalonia.Controls.DrawerPage.DrawerFooterForeground property.
DrawerFooterPropertyDefines the Avalonia.Controls.DrawerPage.DrawerFooter property.
DrawerFooterTemplatePropertyDefines the Avalonia.Controls.DrawerPage.DrawerFooterTemplate property.
DrawerHeaderBackgroundPropertyDefines the Avalonia.Controls.DrawerPage.DrawerHeaderBackground property.
DrawerHeaderForegroundPropertyDefines the Avalonia.Controls.DrawerPage.DrawerHeaderForeground property.
DrawerHeaderPropertyDefines the Avalonia.Controls.DrawerPage.DrawerHeader property.
DrawerHeaderTemplatePropertyDefines the Avalonia.Controls.DrawerPage.DrawerHeaderTemplate property.
DrawerIconPropertyDefines the Avalonia.Controls.DrawerPage.DrawerIcon property.
DrawerIconTemplatePropertyDefines the Avalonia.Controls.DrawerPage.DrawerIconTemplate property.
DrawerLayoutBehaviorPropertyDefines the Avalonia.Controls.DrawerPage.DrawerLayoutBehavior property.
DrawerLengthPropertyDefines the Avalonia.Controls.DrawerPage.DrawerLength property.
DrawerPlacementPropertyDefines the Avalonia.Controls.DrawerPage.DrawerPlacement property.
DrawerPropertyDefines the Avalonia.Controls.DrawerPage.Drawer property.
DrawerTemplatePropertyDefines the Avalonia.Controls.DrawerPage.DrawerTemplate property.
EffectPropertyDefines the Avalonia.Visual.Effect property. Inherited from Visual.
FlowDirectionPropertyDefines the Avalonia.Visual.FlowDirection property. Inherited from Visual.
FocusablePropertyDefines the Avalonia.Input.InputElement.Focusable property. Inherited from InputElement.
FocusAdornerPropertyDefines the Avalonia.Controls.Control.FocusAdorner property. Inherited from Control.
FontFamilyPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontFamily property. Inherited from TemplatedControl.
FontFeaturesPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontFeaturesProperty property. Inherited from TemplatedControl.
FontSizePropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontSize property. Inherited from TemplatedControl.
FontStretchPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
FontStylePropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontStyle property. Inherited from TemplatedControl.
FontWeightPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
ForegroundPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Foreground property. Inherited from TemplatedControl.
GettingFocusEventDefines the Avalonia.Input.InputElement.GettingFocus event. Inherited from InputElement.
GotFocusEventDefines the Avalonia.Input.InputElement.GotFocus event. Inherited from InputElement.
HasMirrorTransformPropertyDefines the Avalonia.Visual.HasMirrorTransform property. Inherited from Visual.
HeaderPropertyDefines the Avalonia.Controls.Page.Header property. Inherited from Page.
HeaderTemplatePropertyDefines the Avalonia.Controls.Page.HeaderTemplate property. Inherited from Page.
HeightPropertyDefines the Avalonia.Layout.Layoutable.Height property. Inherited from Layoutable.
HoldingEventDefines the Avalonia.Input.InputElement.Holding event. Inherited from InputElement.
HorizontalAlignmentPropertyDefines the Avalonia.Layout.Layoutable.HorizontalAlignment property. Inherited from Layoutable.
HorizontalContentAlignmentPropertyDefines the Avalonia.Controls.DrawerPage.HorizontalContentAlignment property.
IconPropertyDefines the Avalonia.Controls.Page.Icon property. Inherited from Page.
IconTemplatePropertyDefines the Avalonia.Controls.Page.IconTemplate property. Inherited from Page.
IsEffectivelyEnabledPropertyDefines the Avalonia.Input.InputElement.IsEffectivelyEnabled property. Inherited from InputElement.
IsEnabledPropertyDefines the Avalonia.Input.InputElement.IsEnabled property. Inherited from InputElement.
IsFocusedPropertyDefines the Avalonia.Input.InputElement.IsFocused property. Inherited from InputElement.
IsGestureEnabledPropertyDefines the Avalonia.Controls.DrawerPage.IsGestureEnabled property.
IsHitTestVisiblePropertyDefines the Avalonia.Input.InputElement.IsHitTestVisible property. Inherited from InputElement.
IsHoldingEnabledPropertyDefines the IsHoldingEnabled attached property. Inherited from InputElement.
IsHoldWithMouseEnabledPropertyDefines the IsHoldWithMouseEnabled attached property. Inherited from InputElement.
IsInNavigationPagePropertyDefines the Avalonia.Controls.Page.IsInNavigationPage property. Inherited from Page.
IsKeyboardFocusWithinPropertyDefines the Avalonia.Input.InputElement.IsKeyboardFocusWithin property. Inherited from InputElement.
IsOpenPropertyDefines the Avalonia.Controls.DrawerPage.IsOpen property.
IsPointerOverPropertyDefines the Avalonia.Input.InputElement.IsPointerOver property. Inherited from InputElement.
IsTabStopPropertyDefines the Avalonia.Input.InputElement.IsTabStop property. Inherited from InputElement.
IsTemplateFocusTargetPropertyDefines the IsTemplateFocusTarget attached property. Inherited from TemplatedControl.
IsVisiblePropertyDefines the Avalonia.Visual.IsVisible property. Inherited from Visual.
KeyDownEventDefines the Avalonia.Input.InputElement.KeyDown event. Inherited from InputElement.
KeyUpEventDefines the Avalonia.Input.InputElement.KeyUp event. Inherited from InputElement.
LetterSpacingPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.LetterSpacing property. Inherited from TemplatedControl.
LoadedEventDefines the Avalonia.Controls.Control.Loaded event. Inherited from Control.
LosingFocusEventDefines the Avalonia.Input.InputElement.LosingFocus event. Inherited from InputElement.
LostFocusEventDefines the Avalonia.Input.InputElement.LostFocus event. Inherited from InputElement.
MarginPropertyDefines the Avalonia.Layout.Layoutable.Margin property. Inherited from Layoutable.
MaxHeightPropertyDefines the Avalonia.Layout.Layoutable.MaxHeight property. Inherited from Layoutable.
MaxWidthPropertyDefines the Avalonia.Layout.Layoutable.MaxWidth property. Inherited from Layoutable.
MinHeightPropertyDefines the Avalonia.Layout.Layoutable.MinHeight property. Inherited from Layoutable.
MinWidthPropertyDefines the Avalonia.Layout.Layoutable.MinWidth property. Inherited from Layoutable.
NamePropertyDefines the Avalonia.StyledElement.Name property. Inherited from StyledElement.
NavigationPropertyDefines the Avalonia.Controls.Page.Navigation property. Inherited from Page.
OpacityMaskPropertyDefines the Avalonia.Visual.OpacityMask property. Inherited from Visual.
OpacityPropertyDefines the Avalonia.Visual.Opacity property. Inherited from Visual.
OpenedEventDefines the Avalonia.Controls.DrawerPage.Opened routed event.
PaddingPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Padding property. Inherited from TemplatedControl.
PageNavigationSystemBackButtonPressedEventDefines the routed event raised when the system back button is pressed. Inherited from Page.
ParentPropertyDefines the Avalonia.StyledElement.Parent property. Inherited from StyledElement.
PinchEndedEventDefines the Avalonia.Input.InputElement.PinchEnded event. Inherited from InputElement.
PinchEventDefines the Avalonia.Input.InputElement.Pinch event. Inherited from InputElement.
PointerCaptureLostEventDefines the Avalonia.Input.InputElement.PointerCaptureLost routed event. Inherited from InputElement.
PointerEnteredEventDefines the Avalonia.Input.InputElement.PointerEntered event. Inherited from InputElement.
PointerExitedEventDefines the Avalonia.Input.InputElement.PointerExited event. Inherited from InputElement.
PointerMovedEventDefines the Avalonia.Input.InputElement.PointerMoved event. Inherited from InputElement.
PointerPressedEventDefines the Avalonia.Input.InputElement.PointerPressed event. Inherited from InputElement.
PointerReleasedEventDefines the Avalonia.Input.InputElement.PointerReleased event. Inherited from InputElement.
PointerTouchPadGestureMagnifyEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureMagnify event. Inherited from InputElement.
PointerTouchPadGestureRotateEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureRotate event. Inherited from InputElement.
PointerTouchPadGestureSwipeEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureSwipe event. Inherited from InputElement.
PointerWheelChangedEventDefines the Avalonia.Input.InputElement.PointerWheelChanged event. Inherited from InputElement.
PullGestureEndedEventDefines the Avalonia.Input.InputElement.PullGestureEnded event. Inherited from InputElement.
PullGestureEventDefines the Avalonia.Input.InputElement.PullGesture event. Inherited from InputElement.
RenderTransformOriginPropertyDefines the Avalonia.Visual.RenderTransformOrigin property. Inherited from Visual.
RenderTransformPropertyDefines the Avalonia.Visual.RenderTransform property. Inherited from Visual.
RequestBringIntoViewEventEvent raised when an element wishes to be scrolled into view. Inherited from Control.
RightTappedEventDefines the Avalonia.Input.InputElement.RightTapped event. Inherited from InputElement.
SafeAreaPaddingPropertyDefines the Avalonia.Controls.Page.SafeAreaPadding property. Inherited from Page.
ScrollGestureEndedEventDefines the Avalonia.Input.InputElement.ScrollGestureEnded event. Inherited from InputElement.
ScrollGestureEventDefines the Avalonia.Input.InputElement.ScrollGesture event. Inherited from InputElement.
ScrollGestureInertiaStartingEventDefines the Avalonia.Input.InputElement.ScrollGestureInertiaStarting event. Inherited from InputElement.
SizeChangedEventDefines the Avalonia.Controls.Control.SizeChanged event. Inherited from Control.
SwipeGestureEndedEventDefines the Avalonia.Input.InputElement.SwipeGestureEnded event. Inherited from InputElement.
SwipeGestureEventDefines the Avalonia.Input.InputElement.SwipeGesture event. Inherited from InputElement.
TabIndexPropertyDefines the Avalonia.Input.InputElement.TabIndex property. Inherited from InputElement.
TagPropertyDefines the Avalonia.Controls.Control.Tag property. Inherited from Control.
TappedEventDefines the Avalonia.Input.InputElement.Tapped event. Inherited from InputElement.
TemplateAppliedEventDefines the Avalonia.Controls.Primitives.TemplatedControl.TemplateApplied routed event. Inherited from TemplatedControl.
TemplatedParentPropertyDefines the Avalonia.StyledElement.TemplatedParent property. Inherited from StyledElement.
TemplatePropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Template property. Inherited from TemplatedControl.
TextInputEventDefines the Avalonia.Input.InputElement.TextInput event. Inherited from InputElement.
TextInputMethodClientRequestedEventDefines the Avalonia.Input.InputElement.TextInputMethodClientRequested event. Inherited from InputElement.
ThemePropertyDefines the Avalonia.StyledElement.Theme property. Inherited from StyledElement.
TransitionsPropertyDefines the Avalonia.Animation.Animatable.Transitions property. Inherited from Animatable.
UnloadedEventDefines the Avalonia.Controls.Control.Unloaded event. Inherited from Control.
UseLayoutRoundingPropertyDefines the Avalonia.Layout.Layoutable.UseLayoutRounding property. Inherited from Layoutable.
VerticalAlignmentPropertyDefines the Avalonia.Layout.Layoutable.VerticalAlignment property. Inherited from Layoutable.
VerticalContentAlignmentPropertyDefines the Avalonia.Controls.DrawerPage.VerticalContentAlignment property.
VisualParentPropertyDefines the Avalonia.Visual.VisualParent property. Inherited from Visual.
WidthPropertyDefines the Avalonia.Layout.Layoutable.Width property. Inherited from Layoutable.
ZIndexPropertyDefines the Avalonia.Visual.ZIndex property. Inherited from Visual.

BackdropBrushProperty Field

Defines the Avalonia.Controls.DrawerPage.BackdropBrush property.

public Avalonia.StyledProperty<Avalonia.Media.IBrush> BackdropBrushProperty

ClosedEvent Field

Defines the Avalonia.Controls.DrawerPage.Closed routed event.

public Avalonia.Interactivity.RoutedEvent<Avalonia.Interactivity.RoutedEventArgs> ClosedEvent

ClosingEvent Field

Defines the Avalonia.Controls.DrawerPage.Closing routed event.

public Avalonia.Interactivity.RoutedEvent<Avalonia.Controls.DrawerClosingEventArgs> ClosingEvent

CompactDrawerLengthProperty Field

Defines the Avalonia.Controls.DrawerPage.CompactDrawerLength property.

public Avalonia.StyledProperty<double> CompactDrawerLengthProperty

ContentProperty Field

Defines the Avalonia.Controls.DrawerPage.Content property.

public Avalonia.StyledProperty<object> ContentProperty

ContentTemplateProperty Field

Defines the Avalonia.Controls.DrawerPage.ContentTemplate property.

public Avalonia.StyledProperty<Avalonia.Controls.Templates.IDataTemplate> ContentTemplateProperty

DisplayModeProperty Field

Defines the Avalonia.Controls.DrawerPage.DisplayMode property.

public Avalonia.StyledProperty<Avalonia.Controls.SplitViewDisplayMode> DisplayModeProperty

DrawerBackgroundProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerBackground property.

public Avalonia.StyledProperty<Avalonia.Media.IBrush> DrawerBackgroundProperty

DrawerBehaviorProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerBehavior property.

public Avalonia.StyledProperty<Avalonia.Controls.DrawerBehavior> DrawerBehaviorProperty

DrawerBreakpointLengthProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerBreakpointLength property.

public Avalonia.StyledProperty<double> DrawerBreakpointLengthProperty

DrawerFooterBackgroundProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerFooterBackground property.

public Avalonia.StyledProperty<Avalonia.Media.IBrush> DrawerFooterBackgroundProperty

DrawerFooterForegroundProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerFooterForeground property.

public Avalonia.StyledProperty<Avalonia.Media.IBrush> DrawerFooterForegroundProperty

DrawerFooterProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerFooter property.

public Avalonia.StyledProperty<object> DrawerFooterProperty

DrawerFooterTemplateProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerFooterTemplate property.

public Avalonia.StyledProperty<Avalonia.Controls.Templates.IDataTemplate> DrawerFooterTemplateProperty

DrawerHeaderBackgroundProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerHeaderBackground property.

public Avalonia.StyledProperty<Avalonia.Media.IBrush> DrawerHeaderBackgroundProperty

DrawerHeaderForegroundProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerHeaderForeground property.

public Avalonia.StyledProperty<Avalonia.Media.IBrush> DrawerHeaderForegroundProperty

DrawerHeaderProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerHeader property.

public Avalonia.StyledProperty<object> DrawerHeaderProperty

DrawerHeaderTemplateProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerHeaderTemplate property.

public Avalonia.StyledProperty<Avalonia.Controls.Templates.IDataTemplate> DrawerHeaderTemplateProperty

DrawerIconProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerIcon property.

public Avalonia.StyledProperty<object> DrawerIconProperty

DrawerIconTemplateProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerIconTemplate property.

public Avalonia.StyledProperty<Avalonia.Controls.Templates.IDataTemplate> DrawerIconTemplateProperty

DrawerLayoutBehaviorProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerLayoutBehavior property.

public Avalonia.StyledProperty<Avalonia.Controls.DrawerLayoutBehavior> DrawerLayoutBehaviorProperty

DrawerLengthProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerLength property.

public Avalonia.StyledProperty<double> DrawerLengthProperty

DrawerPlacementProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerPlacement property.

public Avalonia.StyledProperty<Avalonia.Controls.DrawerPlacement> DrawerPlacementProperty

DrawerProperty Field

Defines the Avalonia.Controls.DrawerPage.Drawer property.

public Avalonia.StyledProperty<object> DrawerProperty

DrawerTemplateProperty Field

Defines the Avalonia.Controls.DrawerPage.DrawerTemplate property.

public Avalonia.StyledProperty<Avalonia.Controls.Templates.IDataTemplate> DrawerTemplateProperty

HorizontalContentAlignmentProperty Field

Defines the Avalonia.Controls.DrawerPage.HorizontalContentAlignment property.

public Avalonia.StyledProperty<Avalonia.Layout.HorizontalAlignment> HorizontalContentAlignmentProperty

IsGestureEnabledProperty Field

Defines the Avalonia.Controls.DrawerPage.IsGestureEnabled property.

public Avalonia.StyledProperty<bool> IsGestureEnabledProperty

IsOpenProperty Field

Defines the Avalonia.Controls.DrawerPage.IsOpen property.

public Avalonia.StyledProperty<bool> IsOpenProperty

OpenedEvent Field

Defines the Avalonia.Controls.DrawerPage.Opened routed event.

public Avalonia.Interactivity.RoutedEvent<Avalonia.Interactivity.RoutedEventArgs> OpenedEvent

VerticalContentAlignmentProperty Field

Defines the Avalonia.Controls.DrawerPage.VerticalContentAlignment property.

public Avalonia.StyledProperty<Avalonia.Layout.VerticalAlignment> VerticalContentAlignmentProperty

Events

NameDescription
ActualThemeVariantChangedRaised when the theme variant is changed on the element or an ancestor of the element. Inherited from StyledElement.
AttachedToLogicalTreeRaised when the styled element is attached to a rooted logical tree. Inherited from StyledElement.
AttachedToVisualTreeRaised when the control is attached to a rooted visual tree. Inherited from Visual.
ClosedOccurs when Avalonia.Controls.DrawerPage.IsOpen changes to and closing is not cancelled.
ClosingOccurs when the drawer is about to close.
ContextCanceledOccurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened. Inherited from InputElement.
ContextRequestedOccurs when the user has completed a context input gesture, such as a right-click. Inherited from InputElement.
DataContextChangedOccurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement.
DetachedFromLogicalTreeRaised when the styled element is detached from a rooted logical tree. Inherited from StyledElement.
DetachedFromVisualTreeRaised when the control is detached from a rooted visual tree. Inherited from Visual.
DoubleTappedOccurs when the user briefly contacts and releases twice on a single point, without significant movement. Inherited from InputElement.
EffectiveViewportChangedOccurs when the element's effective viewport changes. Inherited from Layoutable.
GettingFocusOccurs before the control receives focus. Inherited from InputElement.
GotFocusOccurs when the control receives focus. Inherited from InputElement.
HoldingOccurs when the user makes a single contact, then maintains contact beyond a given time threshold without releasing or making another contact. Inherited from InputElement.
InitializedOccurs when the styled element has finished initialization. Inherited from StyledElement.
KeyDownOccurs when a key is pressed while the control has focus. Inherited from InputElement.
KeyUpOccurs when a key is released while the control has focus. Inherited from InputElement.
LayoutUpdatedOccurs when a layout pass completes for the control. Inherited from Layoutable.
LoadedOccurs when the control has been fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
LosingFocusOccurs before the control loses focus. Inherited from InputElement.
LostFocusOccurs when the control loses focus. Inherited from InputElement.
NavigatedFromOccurs when the page has been navigated from. Inherited from Page.
NavigatedToOccurs when the page has been navigated to. Inherited from Page.
NavigatingOccurs when the page is about to be navigated from. Inherited from Page.
OpenedOccurs when Avalonia.Controls.DrawerPage.IsOpen changes to .
PageNavigationSystemBackButtonPressedRaised when the system back button is pressed while this page is active. Inherited from Page.
PinchOccurs when the user moves two contact points closer together. Inherited from InputElement.
PinchEndedOccurs when the user releases both contact points used in a pinch gesture. Inherited from InputElement.
PointerCaptureLostOccurs 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.
PointerEnteredOccurs when the pointer enters the control. Inherited from InputElement.
PointerExitedOccurs when the pointer leaves the control. Inherited from InputElement.
PointerMovedOccurs when the pointer moves over the control. Inherited from InputElement.
PointerPressedOccurs when the pointer is pressed over the control. Inherited from InputElement.
PointerReleasedOccurs when the pointer is released over the control. Inherited from InputElement.
PointerTouchPadGestureMagnifyOccurs when the user moves two contact points away from each other on a touchpad. Inherited from InputElement.
PointerTouchPadGestureRotateOccurs when the user places two contact points and moves them in a circular motion on a touchpad. Inherited from InputElement.
PointerTouchPadGestureSwipeOccurs when the user performs a rapid dragging motion in a single direction on a touchpad. Inherited from InputElement.
PointerWheelChangedOccurs when the mouse is scrolled over the control. Inherited from InputElement.
PropertyChangedRaised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.
PullGestureOccurs when the user drags from the edge of a control. Inherited from InputElement.
PullGestureEndedOccurs when the user releases the pointer after a pull gesture. Inherited from InputElement.
ResourcesChangedOccurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement.
RightTappedOccurs when the user briefly contacts and releases a single point, without significant movement, using a mechanism on the input device recognized as a right button or equivalent. Inherited from InputElement.
ScrollGestureOccurs when the user continuously moves the pointer in the same direction within the control’s boundaries. Inherited from InputElement.
ScrollGestureEndedOccurs when a scroll gesture has fully stopped, taking into account any inertial movement that continues the scroll after the user has released the pointer. Inherited from InputElement.
ScrollGestureInertiaStartingOccurs within a scroll gesture, when the user releases the pointer, and scrolling continues by transitioning to momentum-based gliding movement. Inherited from InputElement.
SizeChangedOccurs when the bounds (actual size) of the control have changed. Inherited from Control.
SwipeGestureOccurs when the user rapidly drags the pointer in a single direction across the control. Inherited from InputElement.
SwipeGestureEndedOccurs when a swipe gesture ends on the control. Inherited from InputElement.
TappedOccurs when the user briefly contacts and releases a single point, without significant movement. Inherited from InputElement.
TemplateAppliedRaised when the control's template is applied. Inherited from TemplatedControl.
TextInputOccurs when a user typed some text while the control has focus. Inherited from InputElement.
TextInputMethodClientRequestedOccurs when an input element gains input focus and input method is looking for the corresponding client Inherited from InputElement.
UnloadedOccurs when the control is removed from the visual tree. Inherited from Control.

Closed Event

Occurs when Avalonia.Controls.DrawerPage.IsOpen changes to and closing is not cancelled.

public event EventHandler<Avalonia.Interactivity.RoutedEventArgs> Closed

Closing Event

Occurs when the drawer is about to close.

public event EventHandler<Avalonia.Controls.DrawerClosingEventArgs> Closing

Opened Event

Occurs when Avalonia.Controls.DrawerPage.IsOpen changes to .

public event EventHandler<Avalonia.Interactivity.RoutedEventArgs> Opened

On this page