ToggleSwitch Class

[TemplatePart(Name = "PART_SwitchKnob", Type = typeof(Grid))]
[TemplatePart(Name = "PART_SwitchKnobIndeterminate", Type = typeof(ElementChrome))]
[TemplatePart(Name = "PART_SwitchKnobOff", Type = typeof(ElementChrome))]
[TemplatePart(Name = "PART_SwitchKnobOn", Type = typeof(ElementChrome))]
[TemplatePart(Name = "PART_SwitchKnobShadow", Type = typeof(ShadowChrome))]
[TemplatePart(Name = "PART_KnobTranslateTransform", Type = typeof(TranslateTransform))]
[TemplatePart(Name = "PART_SwitchTrack", Type = typeof(FrameworkElement))]
[TemplatePart(Name = "PART_Thumb", Type = typeof(Thumb))]
public class ToggleSwitch : ToggleButton, IOrientedElement

public ToggleSwitch()

public ToggleSwitchContentPlacement ContentPlacement { get; set; }

Property Value

ToggleSwitchContentPlacement:

One of the ToggleSwitchContentPlacement values which indicate the placement of content. The default value is Near.

public Thickness FarContentMargin { get; set; }

Property Value

Thickness:

The margin for far side content.

public object IndeterminateContent { get; set; }

Property Value

object:

An object that contains the "indeterminate" content.

public DataTemplate IndeterminateContentTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate used to display the IndeterminateContent.

public DataTemplateSelector IndeterminateContentTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector to use for the IndeterminateContent.

public Brush IndeterminateKnobBackground { get; set; }

Property Value

Brush:

A Brush for the knob element background.

public Brush IndeterminateKnobBorderBrush { get; set; }

Property Value

Brush:

A Brush for the knob element border.

public Brush IndeterminateTrackBackground { get; set; }

Property Value

Brush:

A Brush for the track element background.

public Brush IndeterminateTrackBorderBrush { get; set; }

Property Value

Brush:

A Brush for the track element border.

public bool IsAnimationEnabled { get; set; }

Property Value

bool:

true if animations are enabled; otherwise, false. The default value is true.

public bool IsKnobShadowEnabled { get; set; }

Property Value

bool:

true if the shadow is enabled; otherwise, false. The default value is false.

Remarks

Set this property to false to prevent the shadow from rendering.

public double KnobAscent { get; set; }

Property Value

double:

The size of the knob element on the perpendicular axis. The default value is 12.

Remarks

The largest possible value assigned to this property should also be assigned to MaxKnobAscent.

See Also

• KnobExtent
• MaxKnobAscent
• MaxKnobExtent

public Thickness KnobBorderThickness { get; set; }

Property Value

Thickness:

A Thickness for the knob element border.

public CornerRadius KnobCornerRadius { get; set; }

Property Value

CornerRadius:

A CornerRadius for the knob element.

public double KnobExtent { get; set; }

Property Value

double:

The size of the knob element on the primary axis. The default value is 12.

Remarks

The largest possible value assigned to this property should also be assigned to MaxKnobExtent.

See Also

• KnobAscent
• MaxKnobAscent
• MaxKnobExtent

public Thickness KnobMargin { get; set; }

Property Value

Thickness:

A Thickness for the margin of the knob element.

public double KnobOpacity { get; set; }

Property Value

double:

The opacity of the element, a value from 0 to 1. The default value is 1.

public double KnobShadowDirection { get; set; }

Property Value

double:

The direction of the shadow, in degrees. The default value is 270, meaning down.

public int KnobShadowElevation { get; set; }

Property Value

int:

The elevation of the shadow, a value from 0 to 24. The default value is 0.

Remarks

Higher elevations render larger shadows. 0 doesn't render a shadow. The IsKnobShadowEnabled property must be set to true for the shadow to render.

public double KnobShadowOpacity { get; set; }

Property Value

double:

The opacity of the shadow, a value from 0 to 1. The default value is 0.3.

public double MaxKnobAscent { get; set; }

Property Value

double

Remarks

Assigning a value to this property is only necessary if the value of KnobAscent increases through user interaction (e.g., the ascent increases on mouse over) so that space is properly reserved in the layout to accommodate the maximum size.

See Also

• KnobAscent
• KnobExtent
• MaxKnobExtent

public double MaxKnobExtent { get; set; }

Property Value

double

Remarks

Assigning a value to this property is only necessary if the value of KnobExtent increases through user interaction (e.g., the extent increases on mouse over) so that space is properly reserved in the layout to accommodate the maximum size.

See Also

• KnobAscent
• KnobExtent
• MaxKnobAscent

public Thickness NearContentMargin { get; set; }

Property Value

Thickness:

The margin for near side content.

public object OffContent { get; set; }

Property Value

object:

An object that contains the "on" content. The default value is null.

public DataTemplate OffContentTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate used to display the OffContent.

public DataTemplateSelector OffContentTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector to use for the OffContent.

public Brush OffKnobBackground { get; set; }

Property Value

Brush:

A Brush for the knob element background.

public Brush OffKnobBorderBrush { get; set; }

Property Value

Brush:

A Brush for the knob element border.

public Brush OffTrackBackground { get; set; }

Property Value

Brush:

A Brush for the track element background.

public Brush OffTrackBorderBrush { get; set; }

Property Value

Brush:

A Brush for the track element border.

public object OnContent { get; set; }

Property Value

object:

An object that contains the "on" content.

public DataTemplate OnContentTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate used to display the OnContent.

public DataTemplateSelector OnContentTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector to use for the OnContent.

public Brush OnKnobBackground { get; set; }

Property Value

Brush:

A Brush for the knob element background.

public Brush OnKnobBorderBrush { get; set; }

Property Value

Brush:

A Brush for the knob element border.

public Brush OnTrackBackground { get; set; }

Property Value

Brush:

A Brush for the track element background.

public Brush OnTrackBorderBrush { get; set; }

Property Value

Brush:

A Brush for the track element border.

public Orientation Orientation { get; set; }

Property Value

Orientation:

One of the Orientation values. The default value is Horizontal.

public double TrackAscent { get; set; }

Property Value

double:

The size of the track element on the perpendicular axis. The default value is 20.

public Thickness TrackBorderThickness { get; set; }

Property Value

Thickness:

A Thickness for the track element border.

public Thickness TrackContentMargin { get; set; }

Property Value

Thickness:

The margin for track content.

public CornerRadius TrackCornerRadius { get; set; }

Property Value

CornerRadius:

A CornerRadius for the track element.

public double TrackExtent { get; set; }

Property Value

double:

The size of the track element on the primary axis. The default value is 40.

public double TrackOpacity { get; set; }

Property Value

double:

The opacity of the element, a value from 0 to 1. The default value is 1.

public override void OnApplyTemplate()

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameter	Type	Description
e	DependencyPropertyChangedEventArgs	An System.Windows.DependencyPropertyChangedEventArgs which defines data for the event.

public static readonly DependencyProperty ContentPlacementProperty

public static readonly DependencyProperty FarContentMarginProperty

public static readonly DependencyProperty IndeterminateContentProperty

public static readonly DependencyProperty IndeterminateContentTemplateProperty

public static readonly DependencyProperty IndeterminateContentTemplateSelectorProperty

public static readonly DependencyProperty IndeterminateKnobBackgroundProperty

public static readonly DependencyProperty IndeterminateKnobBorderBrushProperty

public static readonly DependencyProperty IndeterminateTrackBackgroundProperty

public static readonly DependencyProperty IndeterminateTrackBorderBrushProperty

public static readonly DependencyProperty IsAnimationEnabledProperty

public static readonly DependencyProperty IsKnobShadowEnabledProperty

public static readonly DependencyProperty KnobAscentProperty

public static readonly DependencyProperty KnobBorderThicknessProperty

public static readonly DependencyProperty KnobCornerRadiusProperty

public static readonly DependencyProperty KnobExtentProperty

public static readonly DependencyProperty KnobMarginProperty

public static readonly DependencyProperty KnobOpacityProperty

public static readonly DependencyProperty KnobShadowDirectionProperty

public static readonly DependencyProperty KnobShadowElevationProperty

public static readonly DependencyProperty KnobShadowOpacityProperty

public static readonly DependencyProperty MaxKnobAscentProperty

public static readonly DependencyProperty MaxKnobExtentProperty

public static readonly DependencyProperty NearContentMarginProperty

public static readonly DependencyProperty OffContentProperty

public static readonly DependencyProperty OffContentTemplateProperty

public static readonly DependencyProperty OffContentTemplateSelectorProperty

public static readonly DependencyProperty OffKnobBackgroundProperty

public static readonly DependencyProperty OffKnobBorderBrushProperty

public static readonly DependencyProperty OffTrackBackgroundProperty

public static readonly DependencyProperty OffTrackBorderBrushProperty

public static readonly DependencyProperty OnContentProperty

public static readonly DependencyProperty OnContentTemplateProperty

public static readonly DependencyProperty OnContentTemplateSelectorProperty

public static readonly DependencyProperty OnKnobBackgroundProperty

public static readonly DependencyProperty OnKnobBorderBrushProperty

public static readonly DependencyProperty OnTrackBackgroundProperty

public static readonly DependencyProperty OnTrackBorderBrushProperty

public static readonly DependencyProperty OrientationProperty

public static readonly DependencyProperty TrackAscentProperty

public static readonly DependencyProperty TrackBorderThicknessProperty

public static readonly DependencyProperty TrackContentMarginProperty

public static readonly DependencyProperty TrackCornerRadiusProperty

public static readonly DependencyProperty TrackExtentProperty

public static readonly DependencyProperty TrackOpacityProperty