Class RadSideDrawer

Represents a side drawer control that provides a sliding panel with main and drawer content areas.

Inheritance
System.Object
RadView
RadSideDrawer
Inherited Members
Namespace: Telerik.Maui.Controls
Assembly: Telerik.Maui.Controls.dll

Syntax

public class RadSideDrawer : RadView, IRadSideDrawer, IView, IElement, ITransform

Constructors

RadSideDrawer()

Initializes a new instance of the RadSideDrawer class.

Declaration
public RadSideDrawer()

Fields

AreGesturesEnabledProperty

Identifies the AreGesturesEnabled property.

Declaration
public static readonly BindableProperty AreGesturesEnabledProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DrawerContentProperty

Identifies the DrawerContent property.

Declaration
public static readonly BindableProperty DrawerContentProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DrawerLengthProperty

Identifies the DrawerLength property.

Declaration
public static readonly BindableProperty DrawerLengthProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DrawerLocationProperty

Identifies the DrawerLocation property.

Declaration
public static readonly BindableProperty DrawerLocationProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DrawerTransitionDurationProperty

Identifies the DrawerTransitionDuration property.

Declaration
public static readonly BindableProperty DrawerTransitionDurationProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DrawerTransitionFadeOpacityProperty

Identifies the DrawerTransitionFadeOpacity property.

Declaration
public static readonly BindableProperty DrawerTransitionFadeOpacityProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DrawerTransitionTypeProperty

Identifies the DrawerTransitionType property.

Declaration
public static readonly BindableProperty DrawerTransitionTypeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

IsOpenProperty

Identifies the IsOpen property.

Declaration
public static readonly BindableProperty IsOpenProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

MainContentProperty

Identifies the MainContent property.

Declaration
public static readonly BindableProperty MainContentProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

TapOutsideToCloseProperty

Identifies the TapOutsideToClose property.

Declaration
public static readonly BindableProperty TapOutsideToCloseProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

TouchTargetThresholdProperty

Identifies the TouchTargetThreshold property.

Declaration
public static readonly BindableProperty TouchTargetThresholdProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

Properties

AreGesturesEnabled

Gets or sets a value indicating whether gestures are enabled for the drawer.

Declaration
public bool AreGesturesEnabled { get; set; }
Property Value
System.Boolean

true if gestures are enabled; otherwise, false.
Implements

Commands

Gets the collection of commands associated with the side drawer.

Declaration
public ObservableCollection<ControlCommandBase<RadSideDrawer>> Commands { get; }
Property Value
System.Collections.ObjectModel.ObservableCollection<ControlCommandBase<RadSideDrawer>>

An System.Collections.ObjectModel.ObservableCollection<> of ControlCommandBase<T> commands.

DrawerContent

Gets or sets the content displayed in the drawer panel.

Declaration
public View DrawerContent { get; set; }
Property Value
Microsoft.Maui.Controls.View

A Microsoft.Maui.Controls.View containing the drawer content.

DrawerLength

Gets or sets the length of the drawer.

Declaration
public double DrawerLength { get; set; }
Property Value
System.Double

A System.Double representing the drawer length.
Implements

DrawerLocation

Gets or sets the location of the drawer.

Declaration
public SideDrawerLocation DrawerLocation { get; set; }
Property Value
SideDrawerLocation

A SideDrawerLocation value that specifies where the drawer appears.

DrawerTransitionDuration

Gets or sets the duration of drawer transitions.

Declaration
public double DrawerTransitionDuration { get; set; }
Property Value
System.Double

A System.Double representing the transition duration in seconds.
Implements

DrawerTransitionFadeOpacity

Gets or sets the fade opacity for drawer transitions.

Declaration
public double DrawerTransitionFadeOpacity { get; set; }
Property Value
System.Double

A System.Double representing the fade opacity value.
Implements

DrawerTransitionType

Gets or sets the type of transition used when opening/closing the drawer.

Declaration
public SideDrawerTransitionType DrawerTransitionType { get; set; }
Property Value
SideDrawerTransitionType

A SideDrawerTransitionType value that defines the transition animation.

IsOpen

Gets or sets a value indicating whether the drawer is open.

Declaration
public bool IsOpen { get; set; }
Property Value
System.Boolean

true if the drawer is open; otherwise, false.
Implements

MainContent

Gets or sets the main content displayed when the drawer is closed.

Declaration
public View MainContent { get; set; }
Property Value
Microsoft.Maui.Controls.View

A Microsoft.Maui.Controls.View containing the main content.

TapOutsideToClose

Gets or sets the TapOutsideToClose property. If set to true, the side drawer will close, when the user clicks/taps outside it. If set to false, the side drawer will not close and the main content area will remain active, so the user can interact with it. The default value is true.

Declaration
public bool TapOutsideToClose { get; set; }
Property Value
System.Boolean

Implements

TouchTargetThreshold

Gets or sets the touch target threshold for gesture recognition.

Declaration
public double TouchTargetThreshold { get; set; }
Property Value
System.Double

A System.Double representing the touch threshold value.
Implements

Methods

OnBindingContextChanged()

Called when the binding context changes.

Declaration
protected override void OnBindingContextChanged()

OnPropertyChanged(String)

Called when a property value changes.

Declaration
protected override void OnPropertyChanged(string propertyName = null)
Parameters
System.String propertyName

The name of the property that changed.
Overrides

Events

DrawerClosed

Occurs when the drawer is closed. The user can provide custom logic which will be executed after the drawer is collapsed.

Declaration
public event EventHandler DrawerClosed
Event Type
System.EventHandler

DrawerClosing

Occurs when the drawer starts closing. The user can provide custom logic which will be executed before the drawer is collapsed.

Declaration
public event EventHandler DrawerClosing
Event Type
System.EventHandler

DrawerOpened

Occurs when the drawer is opened. The user can provide custom logic which will be executed after the drawer is shown.

Declaration
public event EventHandler DrawerOpened
Event Type
System.EventHandler

DrawerOpening

Occurs when the drawer starts opening. The user can provide custom logic which will be executed before the drawer is shown.

Declaration
public event EventHandler DrawerOpening
Event Type
System.EventHandler

Explicit Interface Implementations

IRadSideDrawer.DrawerContent

Declaration
IView IRadSideDrawer.DrawerContent { get; set; }
Returns
Microsoft.Maui.IView

Implements

IRadSideDrawer.DrawerLocation

Declaration
SideDrawerLocation IRadSideDrawer.DrawerLocation { get; set; }
Returns
SideDrawerLocation

Implements

IRadSideDrawer.DrawerTransitionType

Declaration
SideDrawerTransitionType IRadSideDrawer.DrawerTransitionType { get; set; }
Returns
SideDrawerTransitionType

Implements

IRadSideDrawer.MainContent

Declaration
IView IRadSideDrawer.MainContent { get; set; }
Returns
Microsoft.Maui.IView

Implements

IRadSideDrawer.OnDrawerClosed()

Declaration
void IRadSideDrawer.OnDrawerClosed()
Implements

IRadSideDrawer.OnDrawerClosing()

Declaration
bool IRadSideDrawer.OnDrawerClosing()
Returns
System.Boolean

Implements

IRadSideDrawer.OnDrawerOpened()

Declaration
void IRadSideDrawer.OnDrawerOpened()
Implements

IRadSideDrawer.OnDrawerOpening()

Declaration
bool IRadSideDrawer.OnDrawerOpening()
Returns
System.Boolean

Implements

Extension Methods