Share via


BackButtonBehavior Class

Definition

Customizes the appearance and behavior of the back button in a Shell application.

public ref class BackButtonBehavior : Microsoft::Maui::Controls::BindableObject
public class BackButtonBehavior : Microsoft.Maui.Controls.BindableObject
type BackButtonBehavior = class
    inherit BindableObject
Public Class BackButtonBehavior
Inherits BindableObject
Inheritance
BackButtonBehavior

Constructors

Name Description
BackButtonBehavior()

Fields

Name Description
CommandParameterProperty

Bindable property for CommandParameter.

CommandProperty

Bindable property for Command.

IconOverrideProperty

Bindable property for IconOverride.

IsEnabledProperty

Bindable property for IsEnabled.

IsVisibleProperty

Bindable property for IsVisible.

TextOverrideProperty

Bindable property for TextOverride.

Properties

Name Description
BindingContext

Gets or sets an object that contains the properties that will be targeted by the bound properties that belong to this BindableObject. This is a bindable property.

(Inherited from BindableObject)
Command

Gets or sets the command to execute when the back button is pressed. This is a bindable property.

CommandParameter

Gets or sets the parameter to pass to the Command. This is a bindable property.

Dispatcher

Gets the dispatcher that was available when this bindable object was created, otherwise tries to find the nearest available dispatcher (probably the window's/app's).

(Inherited from BindableObject)
IconOverride

Gets or sets the icon to use instead of the default back button icon. This is a bindable property.

IsEnabled

Gets or sets a value indicating whether the back button is enabled. This is a bindable property.

IsVisible

Gets or sets a value indicating whether the back button is visible. This is a bindable property.

TextOverride

Gets or sets the text to display instead of the default back button text. This is a bindable property.

Methods

Name Description
ApplyBindings()

Applies all the current bindings to BindingContext.

(Inherited from BindableObject)
ClearValue(BindableProperty)

Clears any value that is previously set for a bindable property.

(Inherited from BindableObject)
ClearValue(BindablePropertyKey)

Clears any value that is previously set for a bindable property, identified by its key.

(Inherited from BindableObject)
CoerceValue(BindableProperty)

Coerces the value of the specified bindable property. This is done by invoking BindableProperty.CoerceValueDelegate of the specified bindable property.

(Inherited from BindableObject)
CoerceValue(BindablePropertyKey)

Coerces the value of the specified bindable property. This is done by invoking BindableProperty.CoerceValueDelegate of the specified bindable property.

(Inherited from BindableObject)
GetValue(BindableProperty)

Returns the value that is contained in the given bindable property.

(Inherited from BindableObject)
IsSet(BindableProperty)

Determines whether or not a bindable property exists and has a value set.

(Inherited from BindableObject)
OnBindingContextChanged()

Raises the BindingContextChanged event.

(Inherited from BindableObject)
OnPropertyChanged(String)

Raises the PropertyChanged event.

(Inherited from BindableObject)
OnPropertyChanging(String)

Raises the PropertyChanging event.

(Inherited from BindableObject)
RemoveBinding(BindableProperty)

Removes a previously set binding from a bindable property.

(Inherited from BindableObject)
SetBinding(BindableProperty, BindingBase)

Assigns a binding to a bindable property.

(Inherited from BindableObject)
SetValue(BindableProperty, Object)

Sets the value of the specified bindable property.

(Inherited from BindableObject)
SetValue(BindablePropertyKey, Object)

Sets the value of the specified bindable property.

(Inherited from BindableObject)
UnapplyBindings()

Removes all current bindings from the current context.

(Inherited from BindableObject)

Events

Name Description
BindingContextChanged

Occurs when the value of the BindingContext property changes.

(Inherited from BindableObject)
PropertyChanged

Occurs when a property value changes.

(Inherited from BindableObject)
PropertyChanging

Occurs when a property value is changing.

(Inherited from BindableObject)

Explicit Interface Implementations

Name Description
IDynamicResourceHandler.SetDynamicResource(BindableProperty, String) (Inherited from BindableObject)

Extension Methods

Name Description
GetPropertyIfSet<T>(BindableObject, BindableProperty, T)
SetAppTheme<T>(BindableObject, BindableProperty, T, T)
SetAppThemeColor(BindableObject, BindableProperty, Color, Color)
SetBinding(BindableObject, BindableProperty, String, BindingMode, IValueConverter, String)

Creates and applies a binding to a property.

SetBinding<TSource,TProperty>(BindableObject, BindableProperty, Func<TSource,TProperty>, BindingMode, IValueConverter, Object, String, Object, Object, Object)

Creates a binding between a property on the source object and a property on the target object.

Applies to