Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

FlipSwitch Class

Namespace:
ActiproSoftware.Windows.Controls.Gauge
Assembly:
ActiproSoftware.Gauge.Wpf.dll

Represents a flip switch control.

public class FlipSwitch : CircularGaugeBase, ILogicalParent, IVisualParent
Inheritance:
object Visual UIElement FrameworkElement GaugeElement GaugeBase CircularGaugeBase object
Implements:
ILogicalParent IVisualParent

Constructors

FlipSwitch()

Initializes an instance of the class.

public FlipSwitch()

Properties

BallBrush

The brush used to render the ball of the switch.

public Brush? BallBrush { get; set; }

Property Value

Brush:

The default value is DarkGray.

BaseAccentBrush

The brush used to render the accent shape on the base.

public Brush? BaseAccentBrush { get; set; }

Property Value

Brush:

The default value is Black.

BaseBackground

The brush used to render the base background.

public Brush? BaseBackground { get; set; }

Property Value

Brush:

The default value is DarkGray.

FocusBrush

The brush used to render the focus indicator.

public Brush? FocusBrush { get; set; }

Property Value

Brush:

The default value is DarkGoldenrod.

FocusExtent

The extent of the focus indicator.

public Unit FocusExtent { get; set; }

Property Value

Unit:

The default value is 3%.

IsChecked

Whether the FlipSwitch is checked.

public bool? IsChecked { get; set; }

Property Value

bool?:

true if the FlipSwitch is checked; false if the FlipSwitch is unchecked; otherwise null. The default value is false.

IsSwitchEffectEnabled

Indicates whether a special effect should be rendered for the switch.

public bool IsSwitchEffectEnabled { get; set; }

Property Value

bool:

The default value is true.

IsThreeState

Whether the control supports two or three states.

public bool IsThreeState { get; set; }

Property Value

bool:

The default value is false.

RenderedFocused

Indicates whether the switch should be rendered with a focus indicator.

protected bool RenderedFocused { get; set; }

Property Value

bool:

The default value is false.

ShaftBrush

The brush used to render the shaft of the switch.

public Brush? ShaftBrush { get; set; }

Property Value

Brush:

The default value is Gray.

SwitchInterval

The interval that it takes the switch to travel to a new location.

public Duration SwitchInterval { get; set; }

Property Value

Duration:

The default value is 250 milliseconds.

SwitchOffset

The offset of the switch, which is used to move it up and down.

protected double SwitchOffset { get; set; }

Property Value

double:

The default value is 0.

SwitchRadiusRatio

The radius of the switch as a ratio of the Radius property.

public double SwitchRadiusRatio { get; set; }

Property Value

double:

The default value is 0.75.

SwitchType

The type of switch rendered.

public FlipSwitchType SwitchType { get; set; }

Property Value

FlipSwitchType:

The default value is Circular.

TipBrush

The brush used to render the tip of the switch.

public Brush? TipBrush { get; set; }

Property Value

Brush:

The default value is Gray.

Methods

OnChecked(RoutedEventArgs)

Raises the Checked event.

protected virtual void OnChecked(RoutedEventArgs e)
Parameter Type Description
e RoutedEventArgs

The RoutedEventArgs instance containing the event data.

OnCreateAutomationPeer()

Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

protected override AutomationPeer? OnCreateAutomationPeer()

Returns

AutomationPeer:

The type-specific AutomationPeer implementation.

OnIndeterminate(RoutedEventArgs)

Raises the Indeterminate event.

protected virtual void OnIndeterminate(RoutedEventArgs e)
Parameter Type Description
e RoutedEventArgs

The RoutedEventArgs instance containing the event data.

OnMouseDown(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.Input.Mouse.MouseDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

protected override void OnMouseDown(MouseButtonEventArgs e)
Parameter Type Description
e MouseButtonEventArgs

The MouseButtonEventArgs that contains the event data. This event data reports details about the mouse button that was pressed and the handled state.

OnRender(DrawingContext)

When overridden in a derived class, participates in rendering operations that are directed by the layout system. The rendering instructions for this element are not used directly when this method is invoked, and are instead preserved for later asynchronous use by layout and drawing.

protected override void OnRender(DrawingContext drawingContext)
Parameter Type Description
drawingContext DrawingContext

The drawing instructions for a specific element. This context is provided to the layout system.

OnToggle()

Called by the OnClick method to implement toggle behavior.

protected virtual void OnToggle()

Remarks

This method toggles the IsChecked property.

OnUnchecked(RoutedEventArgs)

Raises the Unchecked event.

protected virtual void OnUnchecked(RoutedEventArgs e)
Parameter Type Description
e RoutedEventArgs

The RoutedEventArgs instance containing the event data.

RenderFlipSwitch(DrawingContext)

Renders the switch based on various properties.

protected virtual void RenderFlipSwitch(DrawingContext drawingContext)
Parameter Type Description
drawingContext DrawingContext

The drawing context.

UpdateSwitchOffset()

Updates the SwitchOffset, usually with an animation.

protected virtual void UpdateSwitchOffset()

Events

Checked

Occurs when the IsChecked property is changed to true.

public event RoutedEventHandler Checked

Event Type

RoutedEventHandler

Indeterminate

Occurs when the IsChecked property is changed to null.

public event RoutedEventHandler Indeterminate

Event Type

RoutedEventHandler

Unchecked

Occurs when the IsChecked property is changed to false.

public event RoutedEventHandler Unchecked

Event Type

RoutedEventHandler

Fields

BallBrushProperty

Defines the BallBrush property.

public static readonly DependencyProperty BallBrushProperty

BaseAccentBrushProperty

Defines the BaseAccentBrush property.

public static readonly DependencyProperty BaseAccentBrushProperty

BaseBackgroundProperty

Defines the BaseBackground property.

public static readonly DependencyProperty BaseBackgroundProperty

CheckedEvent

Defines the Checked routed event.

public static readonly RoutedEvent CheckedEvent

FocusBrushProperty

Defines the FocusBrush property.

public static readonly DependencyProperty FocusBrushProperty

FocusExtentProperty

Defines the FocusExtent property.

public static readonly DependencyProperty FocusExtentProperty

IndeterminateEvent

Defines the Indeterminate routed event.

public static readonly RoutedEvent IndeterminateEvent

IsCheckedProperty

Defines the IsChecked property.

public static readonly DependencyProperty IsCheckedProperty

IsSwitchEffectEnabledProperty

Defines the IsSwitchEffectEnabled property.

public static readonly DependencyProperty IsSwitchEffectEnabledProperty

IsThreeStateProperty

Defines the IsThreeState property.

public static readonly DependencyProperty IsThreeStateProperty

RenderedFocusedProperty

Defines the RenderedFocused property.

protected static readonly DependencyProperty RenderedFocusedProperty

ShaftBrushProperty

Defines the ShaftBrush property.

public static readonly DependencyProperty ShaftBrushProperty

SwitchIntervalProperty

Defines the SwitchInterval property.

public static readonly DependencyProperty SwitchIntervalProperty

SwitchOffsetProperty

Defines the SwitchOffset property.

protected static readonly DependencyProperty SwitchOffsetProperty

SwitchRadiusRatioProperty

Defines the SwitchRadiusRatio property.

public static readonly DependencyProperty SwitchRadiusRatioProperty

SwitchTypeProperty

Defines the SwitchType property.

public static readonly DependencyProperty SwitchTypeProperty

TipBrushProperty

Defines the TipBrush property.

public static readonly DependencyProperty TipBrushProperty

UncheckedEvent

Defines the Unchecked routed event.

public static readonly RoutedEvent UncheckedEvent

Inherited Members

Extension Methods