Class SfNavigationDrawer

Represents a sliding menu that can be placed either left or right of the application page that allows to handle navigation between major modules of an application.

Inheritance

System.Object

SfNavigationDrawer

Namespace: Syncfusion.UI.Xaml.NavigationDrawer

Assembly: Syncfusion.SfNavigationDrawer.UWP.dll

Syntax

public class SfNavigationDrawer : Control

Remarks

Contains two panes of which one is the sidebar pane that contains the navigation items. The other is the main content pane that displays the actual content of the application.

Constructors

SfNavigationDrawer()

Initializes a new instance of the SfNavigationDrawer class.

Declaration

public SfNavigationDrawer()

See Also

SfNavigationDrawer

Fields

AnimationDurationProperty

Identifies the AnimationDuration dependency property.

Declaration

public static readonly DependencyProperty AnimationDurationProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the AnimationDuration dependency property.

ContentViewProperty

Identifies the ContentView dependency property.

Declaration

public static readonly DependencyProperty ContentViewProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ContentView dependency property.

DefaultDrawerSettingsProperty

Identifies the DefaultDrawerSettings dependency property.

Declaration

public static readonly DependencyProperty DefaultDrawerSettingsProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

DrawerContentViewProperty

Identifies the DrawerContentView dependency property.

Declaration

public static readonly DependencyProperty DrawerContentViewProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DrawerContentView dependency property.

DrawerFooterViewProperty

Identifies the DrawerFooterView dependency property.

Declaration

public static readonly DependencyProperty DrawerFooterViewProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DrawerFooterView dependency property.

DrawerHeaderViewProperty

Identifies the DrawerHeaderView dependency property.

Declaration

public static readonly DependencyProperty DrawerHeaderViewProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DrawerHeaderView dependency property.

DrawerHeightProperty

Identifies the DrawerHeight dependency property.

Declaration

public static readonly DependencyProperty DrawerHeightProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DrawerHeight dependency property.

DrawerWidthProperty

Identifies the DrawerWidth dependency property.

Declaration

public static readonly DependencyProperty DrawerWidthProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DrawerWidth dependency property.

EnableSwipeGestureProperty

Identifies the EnableSwipeGesture dependency property.

Declaration

public static readonly DependencyProperty EnableSwipeGestureProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the EnableSwipeGesture dependency property.

FooterHeightProperty

Identifies the FooterHeight dependency property.

Declaration

public static readonly DependencyProperty FooterHeightProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the FooterHeight dependency property.

HeaderHeightProperty

Identifies the HeaderHeight dependency property.

Declaration

public static readonly DependencyProperty HeaderHeightProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the HeaderHeight dependency property.

IsOpenProperty

Identifies the IsOpen dependency property.

Declaration

public static readonly DependencyProperty IsOpenProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the IsOpen dependency property.

PositionProperty

Identifies the Position dependency property.

Declaration

public static readonly DependencyProperty PositionProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the Position dependency property.

SecondaryDrawerSettingsProperty

Identifies the SecondaryDrawerSettings dependency property.

Declaration

public static readonly DependencyProperty SecondaryDrawerSettingsProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

TouchThresholdProperty

Identifies the TouchThreshold dependency property.

Declaration

public static readonly DependencyProperty TouchThresholdProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the TouchThreshold dependency property.

TransitionProperty

Identifies the Transition dependency property.

Declaration

public static readonly DependencyProperty TransitionProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the Transition dependency property.

Properties

AnimationDuration

Gets or sets the timespan for the expand and collapse animation of the drawer.

Declaration

public TimeSpan AnimationDuration { get; set; }

Property Value

Type	Description
System.TimeSpan	The duration of the drawer animation completion. The default value is 100.

Remarks

AnimationDuration property only applicable when the DisplayMode is set as Default.

See Also

DrawerWidth

ContentView

Gets or sets the value that for the main view of the NavigationDrawer where the actual application content can be placed.

Declaration

public object ContentView { get; set; }

Property Value

Type	Description
System.Object	The default value is null.

DefaultDrawerSettings

Gets or sets the DefaultDrawerSettings for the DrawerView panel in the DrawerSettings control.

Declaration

public DrawerSettings DefaultDrawerSettings { get; set; }

Property Value

Type	Description
DrawerSettings	The Default value is null.

See Also

DrawerSettings

DrawerContentView

Gets or sets the value that populates the body of the sidebar.

Declaration

public object DrawerContentView { get; set; }

Property Value

Type	Description
System.Object	The default value is null.

Remarks

DrawerContentView property is applicable only when the DisplayMode is Default.

See Also

DrawerWidth

DrawerHeight

DrawerFooterView

Gets or sets the value that populates the footer area of the sidebar.

Declaration

public object DrawerFooterView { get; set; }

Property Value

Type	Description
System.Object	The default value is null.

Remarks

DrawerFooterView property is applicable only when the DisplayMode is Default.

See Also

DrawerHeaderView

DrawerHeaderView

Gets or sets the value that populates the header of the sidebar.

Declaration

public object DrawerHeaderView { get; set; }

Property Value

Type	Description
System.Object	The default value is null.

Remarks

DrawerHeaderView property is applicable only when the DisplayMode is Default.

See Also

DrawerFooterView

DrawerHeight

Gets or sets the value that indicates the height of the sidebar.

Declaration

public double DrawerHeight { get; set; }

Property Value

Type	Description
System.Double	The default value is 636.

Remarks

Applicable only if the Postion is either Top or Bottom along with DisplayMode as Default. Otherwise the control height will be the DrawerHeight.

DrawerWidth

Gets or sets the value that indicates the width of the sidebar.

Declaration

public double DrawerWidth { get; set; }

Property Value

Type	Description
System.Double	The default value is 400.

Remarks

Applicable only if the Postion is either Left or Right along with DisplayMode as Default. Otherwise the control width will be the DrawerWidth.

See Also

DrawerHeight

EnableSwipeGesture

Gets or sets a value that indicates whether the drawer opens on swiping or not.

Declaration

public bool EnableSwipeGesture { get; set; }

Property Value

Type	Description
System.Boolean	true if swiping is enabled; otherwise, false.The default value is true.

Remarks

EnableSwipeGesture property only applicable for when the DisplayMode is set as Default.

FooterHeight

Gets or sets the value that indicates the footer height of the drawer view.

Declaration

public double FooterHeight { get; set; }

Property Value

Type	Description
System.Double	The default value is zero.

Remarks

FooterHeight property is only effective for Default DisplayMode.

See Also

HeaderHeight

HeaderHeight

Gets or sets the value that indicates the header height of the drawer view.

Declaration

public double HeaderHeight { get; set; }

Property Value

Type	Description
System.Double	The default value is zero.

Remarks

DrawerHeaderHeight property is applicable only for Default DisplayMode.

See Also

FooterHeight

IsOpen

Gets or sets a value indicating whether the drawer opening state of SfNavigationDrawer

Declaration

public bool IsOpen { get; set; }

Property Value

Type	Description
System.Boolean	true if drawer is in open state, otherwise false. The default value is false.

Remarks

IsOpen property is applicable for all DisplayMode.

Position

Gets or sets a value that indicates whether the position of drawer based on .

Declaration

public Position Position { get; set; }

Property Value

Type	Description
Position	One of the Position enumeration that specifies the position of drawer. The default mode is Left.

Remarks

Position property only applicable for when the DisplayMode is set as Default.

SecondaryDrawerSettings

Gets or sets the SecondaryDrawerSettings for the DrawerView panel in the DrawerSettings control.

Declaration

public DrawerSettings SecondaryDrawerSettings { get; set; }

Property Value

Type	Description
DrawerSettings	The Default value is null.

See Also

DrawerSettings

TouchThreshold

Gets or sets the value that indicates whether the threshold for easy panning from the edges.

Declaration

public double TouchThreshold { get; set; }

Property Value

Type	Description
System.Double	The threshold for easy panning from the edges. The default value is 20.

Remarks

TouchThreshold property only applicable when the DisplayMode is set as Default.

See Also

EnableSwipeGesture

Transition

Gets or sets a value that specifies whether the transition of drawer based on .

Declaration

public Transition Transition { get; set; }

Property Value

Type	Description
Transition	One of the Transition enumeration that specifies the transition of drawer. The default mode is SlideOnTop.

Remarks

Transition property only applicable when the DisplayMode is set as Default.

Methods

add_Closed(SfNavigationDrawer.DrawerEventHandler)

Declaration

public void add_Closed(SfNavigationDrawer.DrawerEventHandler value)

Parameters

Type	Name	Description
SfNavigationDrawer.DrawerEventHandler	value

add_Closing(SfNavigationDrawer.DrawerCancelEventHandler)

Declaration

public void add_Closing(SfNavigationDrawer.DrawerCancelEventHandler value)

Parameters

Type	Name	Description
SfNavigationDrawer.DrawerCancelEventHandler	value

add_Opened(SfNavigationDrawer.DrawerEventHandler)

Declaration

public void add_Opened(SfNavigationDrawer.DrawerEventHandler value)

Parameters

Type	Name	Description
SfNavigationDrawer.DrawerEventHandler	value

add_Opening(SfNavigationDrawer.DrawerCancelEventHandler)

Declaration

public void add_Opening(SfNavigationDrawer.DrawerCancelEventHandler value)

Parameters

Type	Name	Description
SfNavigationDrawer.DrawerCancelEventHandler	value

Dispose()

Dispose method.

Declaration

public void Dispose()

OnApplyTemplate()

Initializes all the child elements of the SfNavigationDrawer control.

Declaration

protected override void OnApplyTemplate()

OnDefaultDrawerSettings()

Set the DefaultDrawerSettings value to the present drawer.

Declaration

public void OnDefaultDrawerSettings()

remove_Closed(SfNavigationDrawer.DrawerEventHandler)

Declaration

public void remove_Closed(SfNavigationDrawer.DrawerEventHandler value)

Parameters

Type	Name	Description
SfNavigationDrawer.DrawerEventHandler	value

remove_Closing(SfNavigationDrawer.DrawerCancelEventHandler)

Declaration

public void remove_Closing(SfNavigationDrawer.DrawerCancelEventHandler value)

Parameters

Type	Name	Description
SfNavigationDrawer.DrawerCancelEventHandler	value

remove_Opened(SfNavigationDrawer.DrawerEventHandler)

Declaration

public void remove_Opened(SfNavigationDrawer.DrawerEventHandler value)

Parameters

Type	Name	Description
SfNavigationDrawer.DrawerEventHandler	value

remove_Opening(SfNavigationDrawer.DrawerCancelEventHandler)

Declaration

public void remove_Opening(SfNavigationDrawer.DrawerCancelEventHandler value)

Parameters

Type	Name	Description
SfNavigationDrawer.DrawerCancelEventHandler	value

ToggleDrawer()

Toggles between the expand and collapse states of the drawer.

Declaration

public void ToggleDrawer()

ToggleSecondaryDrawer()

Represents the opening and closing of the navigationDrawer SfNavigationDrawer.

Declaration

public void ToggleSecondaryDrawer()

Events

Closed

Occurs when the drawer is closed in a NavigationDrawer.

Declaration

public event SfNavigationDrawer.DrawerEventHandler Closed

Event Type

Type
SfNavigationDrawer.DrawerEventHandler

Closing

Occurs when the drawer is closing in a NavigationDrawer.

Declaration

public event SfNavigationDrawer.DrawerCancelEventHandler Closing

Event Type

Type
SfNavigationDrawer.DrawerCancelEventHandler

Remarks

You can customize the Opening operation through CancelEventArgs event argument.

Opened

Occurs when the drawer is opened in a NavigationDrawer.

Declaration

public event SfNavigationDrawer.DrawerEventHandler Opened

Event Type

Type
SfNavigationDrawer.DrawerEventHandler

Opening

Declaration

public event SfNavigationDrawer.DrawerCancelEventHandler Opening

Event Type

Type
SfNavigationDrawer.DrawerCancelEventHandler

Extension Methods

DateTimeExtension.ToDateTime(Object)