SwitchCell Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A Cell with a label and an on/off switch.
public ref class SwitchCell : Microsoft::Maui::Controls::Cell
public class SwitchCell : Microsoft.Maui.Controls.Cell
type SwitchCell = class
inherit Cell
Public Class SwitchCell
Inherits Cell
- Inheritance
Remarks
The following example shows a basic use.
using System;
using Microsoft.Maui.Controls;
namespace FormsGallery
{
class SwitchCellDemoPage : ContentPage
{
public SwitchCellDemoPage()
{
Label header = new Label
{
Text = "SwitchCell",
FontSize = Device.GetNamedSize (NamedSize.Large, typeof(Label)),
HorizontalOptions = LayoutOptions.Center
};
TableView tableView = new TableView
{
Intent = TableIntent.Form,
Root = new TableRoot
{
new TableSection
{
new SwitchCell
{
Text = "SwitchCell:"
}
}
}
};
// Accomodate iPhone status bar.
this.Padding = new Thickness(10, Device.OnPlatform(20, 0, 0), 10, 5);
// Build the page.
this.Content = new StackLayout
{
Children =
{
header,
tableView
}
};
}
}
}
Constructors
SwitchCell() |
Fields
DefaultCellHeight |
The default height of cells. (Inherited from Cell) |
OnColorProperty |
Bindable property for OnColor. |
OnProperty |
Bindable property for On. |
TextProperty |
Bindable property for Text. |
Properties
AutomationId |
Gets or sets a value that allows the automation framework to find and interact with this element. (Inherited from Element) |
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) |
ClassId |
Gets or sets a value used to identify a collection of semantically similar elements. (Inherited from Element) |
ContextActions |
Gets a list of menu items to display when the user performs the device-specific context gesture on the Cell. (Inherited from Cell) |
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) |
EffectControlProvider |
For internal use by .NET MAUI. (Inherited from Element) |
Effects |
Gets or sets the styles and properties that will be applied to the element during runtime. (Inherited from Element) |
Handler |
Gets or sets the associated handler for this element. (Inherited from Element) |
HasContextActions |
Gets a value that indicates whether the cell has at least one menu item in its ContextActions list property. (Inherited from Cell) |
Height |
Gets or sets the height of the Cell. (Inherited from Cell) |
Id |
Gets a value that can be used to uniquely identify an element throughout the run of your application. (Inherited from Element) |
IsContextActionsLegacyModeEnabled | (Inherited from Cell) |
IsEnabled |
Gets or sets the IsEnabled state of the Cell. This is a bindable property. (Inherited from Cell) |
LogicalChildren |
Obsolete.
(Inherited from Element)
|
On |
Gets or sets the state of the switch. This is a bindable property. |
OnColor | |
Parent |
Gets or sets the parent Element of this element. (Inherited from Element) |
RealParent |
For internal use by .NET MAUI. (Inherited from Element) |
RenderHeight |
Gets the height of the rendered cell on the device. (Inherited from Cell) |
StyleId |
Gets or sets a user defined value to uniquely identify the element. (Inherited from Element) |
Text |
Gets or sets the text displayed next to the switch. This is a bindable property. |
Methods
AddLogicalChild(Element) |
Adds an Element to the logical children. (Inherited from Element) |
ApplyBindings() |
Applies all the current bindings to BindingContext. (Inherited from BindableObject) |
ClearLogicalChildren() |
Removes all child Elements. (Inherited from Element) |
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) |
EffectIsAttached(String) |
For internal use by .NET MAUI. (Inherited from Element) |
FindByName(String) |
Returns the element that has the specified name. (Inherited from Element) |
ForceUpdateSize() |
Immediately updates the cell's size. (Inherited from Cell) |
GetValue(BindableProperty) |
Returns the value that is contained in the given bindable property. (Inherited from BindableObject) |
InsertLogicalChild(Int32, Element) |
Inserts an Element to the logical children at the specified index. (Inherited from Element) |
IsSet(BindableProperty) |
Determines whether or not a bindable property exists and has a value set. (Inherited from BindableObject) |
On<T>() | (Inherited from Cell) |
OnAppearing() | (Inherited from Cell) |
OnBindingContextChanged() | (Inherited from Cell) |
OnChildAdded(Element) |
Raises the ChildAdded event. Implement this method to add class handling for this event. (Inherited from Element) |
OnChildRemoved(Element, Int32) |
Raises the ChildRemoved event. Implement this method to add class handling for this event (Inherited from Element) |
OnDisappearing() | (Inherited from Cell) |
OnHandlerChanged() |
When overridden in a derived class, should raise the HandlerChanged event. (Inherited from Element) |
OnHandlerChanging(HandlerChangingEventArgs) |
When overridden in a derived class, should raise the HandlerChanging event. (Inherited from Element) |
OnParentChanged() |
When overridden in a derived class, should raise the ParentChanged event. (Inherited from Element) |
OnParentChanging(ParentChangingEventArgs) |
When overridden in a derived class, should raise the ParentChanging event. (Inherited from Element) |
OnParentSet() | (Inherited from Cell) |
OnPropertyChanged(String) |
Method that is called when a bound property is changed. (Inherited from Element) |
OnPropertyChanging(String) | (Inherited from Cell) |
OnTapped() | (Inherited from Cell) |
RemoveBinding(BindableProperty) |
Removes a previously set binding from a bindable property. (Inherited from BindableObject) |
RemoveDynamicResource(BindableProperty) |
Removes a previously set dynamic resource. (Inherited from Element) |
RemoveLogicalChild(Element) |
Removes the first occurrence of a specific Element from the logical children. (Inherited from Element) |
SendAppearing() |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Cell) |
SendDisappearing() |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Cell) |
SetBinding(BindableProperty, BindingBase) |
Assigns a binding to a bindable property. (Inherited from BindableObject) |
SetDynamicResource(BindableProperty, String) |
Sets the BindableProperty property of this element to be updated via the DynamicResource with the provided key. (Inherited from Element) |
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) |
SetValueFromRenderer(BindableProperty, Object) |
For internal use by .NET MAUI. (Inherited from Element) |
SetValueFromRenderer(BindablePropertyKey, Object) |
For internal use by .NET MAUI. (Inherited from Element) |
UnapplyBindings() |
Removes all current bindings from the current context. (Inherited from BindableObject) |
Events
Appearing | (Inherited from Cell) |
BindingContextChanged |
Occurs when the value of the BindingContext property changes. (Inherited from BindableObject) |
ChildAdded |
Raised whenever a child element is added to the element. (Inherited from Element) |
ChildRemoved |
Raised whenever a child element is removed from the element. (Inherited from Element) |
DescendantAdded |
Raised whenever a child element is added to the element's subtree. (Inherited from Element) |
DescendantRemoved |
Raised whenever a child element is removed from the elements subtree. (Inherited from Element) |
Disappearing | (Inherited from Cell) |
ForceUpdateSizeRequested | (Inherited from Cell) |
HandlerChanged |
Raised whenever the element's handler has changed. (Inherited from Element) |
HandlerChanging |
Raised whenever the element's handler starts to change. (Inherited from Element) |
OnChanged | |
ParentChanged |
Raised whenever the element's parent has changed. (Inherited from Element) |
ParentChanging |
Raised whenever the element's starts to change. (Inherited from Element) |
PropertyChanged |
Occurs when a property value changes. (Inherited from BindableObject) |
PropertyChanging |
Occurs when a property value is changing. (Inherited from BindableObject) |
Tapped | (Inherited from Cell) |
Explicit Interface Implementations
IContextFlyoutElement.ContextFlyout |
Gets the ContextFlyout for the view. Menu flyouts, menu flyout subitems, and menu flyout separators can be added to the context flyout. (Inherited from Element) |
IDynamicResourceHandler.SetDynamicResource(BindableProperty, String) | (Inherited from BindableObject) |
IEffectControlProvider.RegisterEffect(Effect) |
Registers the specified |
IElement.Parent |
Gets the Parent of the Element. (Inherited from Element) |
IElementController.Descendants() |
For internal use by .NET MAUI. (Inherited from Element) |
IElementController.LogicalChildren |
For internal use by .NET MAUI. (Inherited from Element) |
IElementController.SetValueFromRenderer(BindableProperty, Object) |
For internal use by .NET MAUI. (Inherited from Element) |
INameScope.RegisterName(String, Object) |
For internal use by .NET MAUI. (Inherited from Element) |
INameScope.UnregisterName(String) |
For internal use by .NET MAUI. (Inherited from Element) |
IToolTipElement.ToolTip |
Represents a small rectangular pop-up window that displays a brief description of a view's purpose when the user rests the pointer on the view. (Inherited from Element) |
IVisualTreeElement.GetVisualChildren() | (Inherited from Cell) |
IVisualTreeElement.GetVisualParent() |
Gets the element's visual parent. (Inherited from Element) |