menu

Xamarin.Forms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class DrawerSettings - API Reference

    Show / Hide Table of Contents

    Class DrawerSettings

    SfNavigationDrawer represents a class that contains properties for drop-down customizations.

    Inheritance
    System.Object
    DrawerSettings
    Namespace: Syncfusion.SfNavigationDrawer.XForms
    Assembly: Syncfusion.SfNavigationDrawer.XForms.dll
    Syntax
    public class DrawerSettings : BindableObject

    Constructors

    DrawerSettings()

    Declaration
    public DrawerSettings()

    Fields

    ContentBackgroundColorProperty

    Identifies the ContentBackgroundColor bindable property. This property can be used to customize the drawer background color of the SfNavigationDrawer control.

    Declaration
    public static readonly BindableProperty ContentBackgroundColorProperty
    Field Value
    Type Description
    Xamarin.Forms.BindableProperty

    DrawerContentViewProperty

    Identifies the DrawerContentView bindable property. This property can be used to customize the drawer content view of the SfNavigationDrawer control.

    Declaration
    public static readonly BindableProperty DrawerContentViewProperty
    Field Value
    Type Description
    Xamarin.Forms.BindableProperty

    DrawerFooterHeightProperty

    Identifies the DrawerFooterHeight bindable property. This property can be used to customize the drawer footer height of the SfNavigationDrawer control.

    Declaration
    public static readonly BindableProperty DrawerFooterHeightProperty
    Field Value
    Type Description
    Xamarin.Forms.BindableProperty

    DrawerFooterViewProperty

    Identifies the DrawerFooterView bindable property. This property can be used to customize the drawer footer view of the SfNavigationDrawer control.

    Declaration
    public static readonly BindableProperty DrawerFooterViewProperty
    Field Value
    Type Description
    Xamarin.Forms.BindableProperty

    DrawerHeaderHeightProperty

    Identifies the DrawerHeaderHeight bindable property. This property can be used to customize the drawer header height of the SfNavigationDrawer control.

    Declaration
    public static readonly BindableProperty DrawerHeaderHeightProperty
    Field Value
    Type Description
    Xamarin.Forms.BindableProperty

    DrawerHeaderViewProperty

    Identifies the DrawerHeaderView bindable property. This property can be used to customize the drawer header view of the SfNavigationDrawer control.

    Declaration
    public static readonly BindableProperty DrawerHeaderViewProperty
    Field Value
    Type Description
    Xamarin.Forms.BindableProperty

    DrawerHeightProperty

    Identifies the DrawerHeight bindable property. This property can be used to customize the drawer height of the SfNavigationDrawer control.

    Declaration
    public static readonly BindableProperty DrawerHeightProperty
    Field Value
    Type Description
    Xamarin.Forms.BindableProperty

    DrawerWidthProperty

    Identifies the DrawerWidth bindable property. This property can be used to customize the drawer width of the SfNavigationDrawer control.

    Declaration
    public static readonly BindableProperty DrawerWidthProperty
    Field Value
    Type Description
    Xamarin.Forms.BindableProperty

    DurationProperty

    Identifies the Duration bindable property. This property can be used to change the animation duration of the SfNavigationDrawer control.

    Declaration
    public static readonly BindableProperty DurationProperty
    Field Value
    Type Description
    Xamarin.Forms.BindableProperty

    EnableSwipeGestureProperty

    Identifies the EnableSwipeGesture bindable property. It indicates whether swipe gesture to open drawer is enabled or not in the SfNavigationDrawer control.

    Declaration
    public static readonly BindableProperty EnableSwipeGestureProperty
    Field Value
    Type Description
    Xamarin.Forms.BindableProperty

    IsOpenProperty

    Identifies the IsOpen bindable property. It indicates whether the drawer is opened or not in the SfNavigationDrawer control.

    Declaration
    public static readonly BindableProperty IsOpenProperty
    Field Value
    Type Description
    Xamarin.Forms.BindableProperty

    PositionProperty

    Identifies the Position bindable property. This property can be used to change the drawer position of the SfNavigationDrawer control.

    Declaration
    public static readonly BindableProperty PositionProperty
    Field Value
    Type Description
    Xamarin.Forms.BindableProperty

    TouchThresholdProperty

    Identifies the TouchThreshold bindable property. You can get the drag position of the drawer based on touch threshold value.

    Declaration
    public static readonly BindableProperty TouchThresholdProperty
    Field Value
    Type Description
    Xamarin.Forms.BindableProperty

    TransitionProperty

    Identifies the Transition bindable property. This property can be used to change the transition mode of the SfNavigationDrawer control.

    Declaration
    public static readonly BindableProperty TransitionProperty
    Field Value
    Type Description
    Xamarin.Forms.BindableProperty

    Properties

    ContentBackgroundColor

    Gets or sets the drawer background color of SfNavigationDrawer control.

    Declaration
    public Color ContentBackgroundColor { get; set; }
    Property Value
    Type Description
    Xamarin.Forms.Color

    The default value is White.

    DrawerContentView

    Gets or sets the value of DrawerContentView. This property can be used to customize the drawer content view of the SfNavigationDrawer control.

    Declaration
    public View DrawerContentView { get; set; }
    Property Value
    Type Description
    Xamarin.Forms.View

    The default value is null.

    DrawerFooterHeight

    Gets or sets the value of DrawerFooterHeight. This property can be used to customize the drawer footer height of the SfNavigationDrawer control.

    Declaration
    public float DrawerFooterHeight { get; set; }
    Property Value
    Type Description
    System.Single

    The default value is 150.

    DrawerFooterView

    Gets or sets the value of DrawerFooterView. This property can be used to customize the drawer footer view of the SfNavigationDrawer control.

    Declaration
    public View DrawerFooterView { get; set; }
    Property Value
    Type Description
    Xamarin.Forms.View

    The default value is null.

    DrawerHeaderHeight

    Gets or sets the value of DrawerHeaderHeight. This property can be used to customize the drawer header height of the SfNavigationDrawer control.

    Declaration
    public float DrawerHeaderHeight { get; set; }
    Property Value
    Type Description
    System.Single

    The default value is 150.

    DrawerHeaderView

    Gets or sets the value of DrawerHeaderView. This property can be used to customize the drawer header view of the SfNavigationDrawer control.

    Declaration
    public View DrawerHeaderView { get; set; }
    Property Value
    Type Description
    Xamarin.Forms.View

    The default value is null.

    DrawerHeight

    Gets or sets the value of DrawerHeight. This property can be used to customize the drawer height of the SfNavigationDrawer control.

    Declaration
    public float DrawerHeight { get; set; }
    Property Value
    Type Description
    System.Single

    The default value is 500.

    DrawerWidth

    Gets or sets the value of the DrawerWidth. This property can be used to customize the drawer width of the SfNavigationDrawer control.

    Declaration
    public float DrawerWidth { get; set; }
    Property Value
    Type Description
    System.Single

    The default value is 300.

    Duration

    Gets or sets the value of Duration. This property can be used to change the animation duration of the SfNavigationDrawer control.

    Declaration
    public float Duration { get; set; }
    Property Value
    Type Description
    System.Single

    The default value is 400.

    EnableSwipeGesture

    Gets or sets a value indicating whether swipe gesture to open drawer is enabled or not in the SfNavigationDrawer control.

    Declaration
    public bool EnableSwipeGesture { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true.

    IsOpen

    Gets or sets a value indicating whether the drawer is opened or not in the SfNavigationDrawer control.

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

    The default value is false.

    Position

    Gets or sets the value of Position. This property can be used to change the drawer position of the SfNavigationDrawer control.

    Declaration
    public Position Position { get; set; }
    Property Value
    Type Description
    Position

    The default value is Left.

    TouchThreshold

    Gets or sets the value of TouchThreshold. You can get the drag position of the drawer based on touch threshold value.

    Declaration
    public float TouchThreshold { get; set; }
    Property Value
    Type Description
    System.Single

    The default value is 40.

    Transition

    Gets or sets the value of Transition. This property can be used to change the transition mode of the SfNavigationDrawer control.

    Declaration
    public Transition Transition { get; set; }
    Property Value
    Type Description
    Transition

    The default value is SlideOnTop.

    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved