Class SfBackdropPage

Represents a root class for backdrop control which is composed of two surfaces: a back layer and a front layer. The back layer displays actions and context, and these control and inform the front layers content.

Inheritance

System.Object

SfBackdropPage

Namespace: Syncfusion.XForms.Backdrop

Assembly: Syncfusion.SfBackdrop.XForms.dll

Syntax

public class SfBackdropPage : ContentPage, IParentThemeElement, IThemeElement

Constructors

SfBackdropPage()

Initializes a new instance of the SfBackdropPage class.

Declaration

public SfBackdropPage()

Fields

BackLayerProperty

Gets or sets a value for a view to place behind the front view of backdrop control.

Declaration

public static readonly BindableProperty BackLayerProperty

Field Value

Type
Xamarin.Forms.BindableProperty

BackLayerRevealOptionProperty

Gets or sets the exploring mode of the BackdropBackLayer.

Declaration

public static readonly BindableProperty BackLayerRevealOptionProperty

Field Value

Type
Xamarin.Forms.BindableProperty

CloseIconImageSourceProperty

Identifies the CloseIconImageSource bindable property.

Declaration

public static readonly BindableProperty CloseIconImageSourceProperty

Field Value

Type
Xamarin.Forms.BindableProperty

CloseIconProperty

Gets or sets the image source for the close icon.

Declaration

public static readonly BindableProperty CloseIconProperty

Field Value

Type
Xamarin.Forms.BindableProperty

CloseTextProperty

Identifies the CloseText bindable property.

Declaration

public static readonly BindableProperty CloseTextProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FrontLayerProperty

Gets or sets a value for a view to place above the back view of backdrop control.

Declaration

public static readonly BindableProperty FrontLayerProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IsBackLayerRevealedProperty

Gets or sets a value indicating whether back layer should be expanded state.

Declaration

public static readonly BindableProperty IsBackLayerRevealedProperty

Field Value

Type
Xamarin.Forms.BindableProperty

OpenIconImageSourceProperty

Identifies the OpenIconImageSource bindable property.

Declaration

public static readonly BindableProperty OpenIconImageSourceProperty

Field Value

Type
Xamarin.Forms.BindableProperty

OpenIconProperty

Gets or sets the value for the image source of Open icon.

Declaration

public static readonly BindableProperty OpenIconProperty

Field Value

Type
Xamarin.Forms.BindableProperty

OpenTextProperty

Identifies the OpenText bindable property.

Declaration

public static readonly BindableProperty OpenTextProperty

Field Value

Type
Xamarin.Forms.BindableProperty

Properties

BackLayer

Gets or sets a value for a view to place behind the BackdropFrontLayer.

Declaration

public BackdropBackLayer BackLayer { get; set; }

Property Value

Type
BackdropBackLayer

BackLayerRevealOption

Gets or sets the value that indicate how the back layer gets revealed.

Declaration

public RevealOption BackLayerRevealOption { get; set; }

Property Value

Type
RevealOption

CloseIcon

Gets or sets the value for the image source of close icon.

Declaration

public string CloseIcon { get; set; }

Property Value

Type
System.String

CloseIconImageSource

Declaration

public ImageSource CloseIconImageSource { get; set; }

Property Value

Type
Xamarin.Forms.ImageSource

CloseText

Gets or sets the value to display the CloseIcon text.

Declaration

public string CloseText { get; set; }

Property Value

Type
System.String

Content

Gets the view that contains the content of the Page.

Declaration

public View Content { get; }

Property Value

Type
Xamarin.Forms.View

ControlTemplate

Gets the control template that is used to display content.

Declaration

public ControlTemplate ControlTemplate { get; }

Property Value

Type
Xamarin.Forms.ControlTemplate

FrontLayer

Gets or sets a value for a view to place above the BackdropBackLayer.

Declaration

public BackdropFrontLayer FrontLayer { get; set; }

Property Value

Type
BackdropFrontLayer

IsBackLayerRevealed

Gets or sets a value indicating whether back layer should be expanded state.

Declaration

public bool IsBackLayerRevealed { get; set; }

Property Value

Type
System.Boolean

OpenIcon

Gets or sets the value for the image source of Open icon.

Declaration

public string OpenIcon { get; set; }

Property Value

Type
System.String

OpenIconImageSource

Declaration

public ImageSource OpenIconImageSource { get; set; }

Property Value

Type
Xamarin.Forms.ImageSource

OpenText

Gets or sets the value to display the OpenIcon text.

Declaration

public string OpenText { get; set; }

Property Value

Type
System.String

Padding

Gets the space between the content of the Page and it's border.

Declaration

public Thickness Padding { get; }

Property Value

Type
Xamarin.Forms.Thickness

Methods

OnAppearing()

When overridden, allows application developers to customize behavior immediately prior to the Page becoming visible.

Declaration

protected override void OnAppearing()

OnDisappearing()

When overridden, allows the application developer to customize behavior as the Page disappears.

Declaration

protected override void OnDisappearing()

OnSizeAllocated(Double, Double)

Handles the size allocated.

Declaration

protected override void OnSizeAllocated(double width, double height)

Parameters

Type	Name	Description
System.Double	width	The width.
System.Double	height	The height.

Events

BackLayerStateChanged

Occurs when the back layer gets revealed or concealed.

Declaration

public event EventHandler BackLayerStateChanged

Event Type

Type
System.EventHandler