ClassRadSideDrawer
Represents a control that enables a user to show a drawer from any side of a content.
Definition
Namespace:Telerik.UI.Xaml.Controls.Primitives
Assembly:Telerik.WinUI.Controls.dll
Syntax:
public class RadSideDrawer : RadControl
Inheritance: objectRadControlRadSideDrawer
Inherited Members
Constructors
RadSideDrawer()
Initializes a new instance of the RadSideDrawer class.
Declaration
public RadSideDrawer()
Fields
AnimationDurationProperty
Identifies the AnimationDuration dependency property.
Declaration
public static readonly DependencyProperty AnimationDurationProperty
Field Value
DependencyProperty
DrawerButtonHorizontalAlignmentProperty
Identifies the DrawerButtonHorizontalAlignment dependency property.
Declaration
public static readonly DependencyProperty DrawerButtonHorizontalAlignmentProperty
Field Value
DependencyProperty
DrawerButtonStyleProperty
Identifies the DrawerButtonStyle dependency property.
Declaration
public static readonly DependencyProperty DrawerButtonStyleProperty
Field Value
DependencyProperty
DrawerButtonVerticalAlignmentProperty
Identifies the DrawerButtonVerticalAlignment dependency property.
Declaration
public static readonly DependencyProperty DrawerButtonVerticalAlignmentProperty
Field Value
DependencyProperty
DrawerContentProperty
Identifies the DrawerContent dependency property.
Declaration
public static readonly DependencyProperty DrawerContentProperty
Field Value
DependencyProperty
DrawerContentTemplateProperty
Identifies the DrawerContentTemplate dependency property.
Declaration
public static readonly DependencyProperty DrawerContentTemplateProperty
Field Value
DependencyProperty
DrawerLengthProperty
Identifies the DrawerLength dependency property.
Declaration
public static readonly DependencyProperty DrawerLengthProperty
Field Value
DependencyProperty
DrawerLocationProperty
Identifies the DrawerLocation dependency property.
Declaration
public static readonly DependencyProperty DrawerLocationProperty
Field Value
DependencyProperty
DrawerStateProperty
Identifies the DrawerState dependency property.
Declaration
public static readonly DependencyProperty DrawerStateProperty
Field Value
DependencyProperty
DrawerTransitionFadeOpacityProperty
Identifies the DrawerTransitionFadeOpacity dependency property.
Declaration
public static readonly DependencyProperty DrawerTransitionFadeOpacityProperty
Field Value
DependencyProperty
DrawerTransitionProperty
Identifies the DrawerTransition dependency property.
Declaration
public static readonly DependencyProperty DrawerTransitionProperty
Field Value
DependencyProperty
IsOpenProperty
Identifies the IsOpen dependency property.
Declaration
public static readonly DependencyProperty IsOpenProperty
Field Value
DependencyProperty
MainContentProperty
Identifies the MainContent dependency property.
Declaration
public static readonly DependencyProperty MainContentProperty
Field Value
DependencyProperty
MainContentTemplateProperty
Identifies the MainContentTemplate dependency property.
Declaration
public static readonly DependencyProperty MainContentTemplateProperty
Field Value
DependencyProperty
TapOutsideToCloseProperty
Identifies the TapOutsideToClose dependency property.
Declaration
public static readonly DependencyProperty TapOutsideToCloseProperty
Field Value
DependencyProperty
TouchTargetThresholdProperty
Identifies the TouchTargetThreshold dependency property.
Declaration
public static readonly DependencyProperty TouchTargetThresholdProperty
Field Value
DependencyProperty
Properties
AnimationDuration
Gets or sets the duration of the animations used to show/hide the drawer.
Declaration
public Duration AnimationDuration { get; set; }
Property Value
Duration
CommandService
Gets the CommandService instance that manages the commanding behavior of this instance.
Declaration
public CommandService CommandService { get; }
Property Value
Commands
Gets the collection with all the custom commands registered with the CommandService. Custom commands have higher priority than the built-in (default) ones.
Declaration
public CommandCollection<RadSideDrawer> Commands { get; }
Property Value
DrawerButtonHorizontalAlignment
Gets or sets the horizontal alignment of the DrawerButton.
Declaration
public HorizontalAlignment DrawerButtonHorizontalAlignment { get; set; }
Property Value
HorizontalAlignment
DrawerButtonStyle
Gets or sets the style of the DrawerButton which is used to show/hide the drawer.
Declaration
public Style DrawerButtonStyle { get; set; }
Property Value
Style
DrawerButtonVerticalAlignment
Gets or sets the vertical alignment of the DrawerButton.
Declaration
public VerticalAlignment DrawerButtonVerticalAlignment { get; set; }
Property Value
VerticalAlignment
DrawerContent
Gets or sets the content of drawer.
DrawerContentTemplate
Gets or sets the template of the DrawerContentTemplate.
Declaration
public DataTemplate DrawerContentTemplate { get; set; }
Property Value
DataTemplate
DrawerLength
Gets or sets the length of the drawer length (height of width) depending on the drawer location.
DrawerLocation
Gets or sets the orientation of the drawer i.e. from which side of the MainContent to show(left, right, top or bottom).
Declaration
public DrawerLocation DrawerLocation { get; set; }
Property Value
DrawerManipulationMode
Gets or sets the DrawerManipulationMode used to show/hide the drawer.
Declaration
public DrawerManipulationMode DrawerManipulationMode { get; set; }
Property Value
DrawerState
Gets the DrawerState of the drawer.
DrawerTransition
Gets or sets the transition(set of animations) used to show/hide the drawer.
Declaration
public DrawerTransition DrawerTransition { get; set; }
Property Value
DrawerTransitionFadeOpacity
Gets or sets the Maximum opacity to which the of the drawer will animate its main content when opened.
Declaration
public double DrawerTransitionFadeOpacity { get; set; }
Property Value
IsOpen
Gets or sets a value indicating whether the drawer is opened or closed.
MainContent
Gets or sets the main content of the control.
MainContentTemplate
Gets or sets the template of the MainContent.
Declaration
public DataTemplate MainContentTemplate { get; set; }
Property Value
DataTemplate
TapOutsideToClose
Gets or sets a value indicating whether to close the drawer if a user taps outside the drawer.
TouchTargetThreshold
Gets or sets the distance from the main content's edge(depending on the DrawerLocation) in pixels which is responsive to gestures(to open/move/close the drawer).
Declaration
public double TouchTargetThreshold { get; set; }
Property Value
Methods
ApplyTemplateCore()
Called when the Framework is called. Inheritors should override this method should they have some custom template-related logic. This is done to ensure that the property is properly initialized.
ArrangeOverride(Size)
Called in the arrange pass of the layout system.
Declaration
protected override Size ArrangeOverride(Size finalSize)
Parameters
finalSize
Size
The final size that was given by the layout system.
Returns
Size
The final size of the panel.
Overrides
HideDrawer()
Hides the drawer, i.e. makes it in DrawerState.Closed.
Declaration
[Obsolete("This method is obsoleted and soon it will be deleted. Please, use IsOpen property.")]
public void HideDrawer()
MeasureOverride(Size)
Provides the behavior for the Measure pass of the layout cycle. Classes can override this method to define their own Measure pass behavior.
Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
availableSize
Size
The available size that this object can give to child objects. Infinity can be specified as a value to indicate that the object will size to whatever content is available.
Returns
Size
The size that this object determines it needs during layout, based on its calculations of the allocated sizes for child objects or based on other considerations such as a fixed container size.
Overrides
OnCreateAutomationPeer()
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
AutomationPeer
Overrides
OnKeyDown(KeyRoutedEventArgs)
Called before the KeyDown event occurs.
Declaration
protected override void OnKeyDown(KeyRoutedEventArgs e)
Parameters
e
KeyRoutedEventArgs
The data for the event.
OnTemplateApplied()
Occurs when the method has been called and the template is already successfully applied.
Declaration
protected override void OnTemplateApplied()
Overrides
ShowDrawer()
Shows the drawer, i.e. makes it in DrawerState.Opened.
Declaration
[Obsolete("This method is obsoleted and soon it will be deleted. Please, use IsOpen property.")]
public void ShowDrawer()
UnapplyTemplateCore()
Removes the current control template. Occurs when a template has already been applied and a new one is applied.
Declaration
protected override void UnapplyTemplateCore()
Overrides
Events
DrawerClosing
Occurs when the drawer starts closing. The user can provide custom logic which will be executed before the drawer is collapsed.
DrawerOpening
Occurs when the drawer starts opening. The user can provide custom logic which will be executed before the drawer is shown.