Back to all docs
API Reference / ArtOfTest.WebAii.Silverlight.UI / ToggleButton

Class
ToggleButton

Wraps a Silverlight ToggleButton element.

Definition

Namespace:ArtOfTest.WebAii.Silverlight.UI

Assembly:ArtOfTest.WebAii.dll

Syntax:
cs-api-definition
public class ToggleButton : ButtonBase, IAutomationPeer, IPeerConverter, IButtonBase, IContentControl, IControl, IToggleButton, IFrameworkElement, ITargetElement

Inheritance: objectAutomationObject<FrameworkElement>FrameworkElementSilverlightTestElementControlContentControlButtonBaseToggleButton

Derived Classes: CheckBoxRadioButtonPickerToggleButtonRadToggleButton

Implements: IAutomationPeerIButtonBaseIContentControlIControlIFrameworkElementIPeerConverterITargetElementIToggleButton

Inherited Members ButtonBase.ClickModePropertyButtonBase.IsFocusedPropertyButtonBase.IsMouseOverPropertyButtonBase.IsPressedPropertyButtonBase.ClickModeButtonBase.IsFocusedButtonBase.IsMouseOverButtonBase.IsPressedContentControl.ContentPropertyContentControl.ContentControl.IsTabStopPropertyControl.TabIndexPropertyControl.TabNavigationPropertyControl.PaddingPropertyControl.HorizontalContentAlignmentPropertyControl.VerticalContentAlignmentPropertyControl.BackgroundPropertyControl.BorderBrushPropertyControl.BorderThicknessPropertyControl.FontSizePropertyControl.ForegroundPropertyControl.IsEnabledPropertyControl.FontFamilyPropertyControl.FontStretchPropertyControl.FontStylePropertyControl.FontWeightPropertyControl.IsTabStopControl.TabIndexControl.TabNavigationControl.PaddingControl.HorizontalContentAlignmentControl.VerticalContentAlignmentControl.BackgroundControl.BorderBrushControl.BorderThicknessControl.FontSizeControl.ForegroundControl.IsEnabledControl.FontFamilyControl.FontStretchControl.FontStyleControl.FontWeightSilverlightTestElement.UseLayoutRoundingPropertySilverlightTestElement.UseLayoutRoundingFrameworkElement.ActualWidthPropertyFrameworkElement.ActualHeightPropertyFrameworkElement.WidthPropertyFrameworkElement.HeightPropertyFrameworkElement.MinWidthPropertyFrameworkElement.MaxWidthPropertyFrameworkElement.MinHeightPropertyFrameworkElement.MaxHeightPropertyFrameworkElement.HorizontalAlignmentPropertyFrameworkElement.VerticalAlignmentPropertyFrameworkElement.MarginPropertyFrameworkElement.DesiredSizePropertyFrameworkElement.RenderSizePropertyFrameworkElement.NamePropertyFrameworkElement.TagPropertyFrameworkElement.DataContextPropertyFrameworkElement.OpacityPropertyFrameworkElement.ClipPropertyFrameworkElement.RenderTransformPropertyFrameworkElement.OpacityMaskPropertyFrameworkElement.RenderTransformOriginPropertyFrameworkElement.IsHitTestVisiblePropertyFrameworkElement.VisibilityPropertyFrameworkElement.GetIdentifier(out string, out string)FrameworkElement.IsChild(FrameworkElement)FrameworkElement.GetChildTagIndex(FrameworkElement)FrameworkElement.InitializeMappings(MappingsCollection)FrameworkElement.As<T>()FrameworkElement.CastAs<T>()FrameworkElement.SetProxy(bool)FrameworkElement.SetUid(string)FrameworkElement.SetFindInfo(VisualFindInfo)FrameworkElement.SetXamlTag(string)FrameworkElement.AssignReference(AutomationReference)FrameworkElement.KeyPress(Keys, int, int, int)FrameworkElement.GetRectangle()FrameworkElement.GetRectangle(FrameworkElement)FrameworkElement.GetIntRectangle()FrameworkElement.IsHitTest()FrameworkElement.IsHitTest(bool)FrameworkElement.IsHitTest(FrameworkElement, bool)FrameworkElement.Highlight()FrameworkElement.Highlight(bool)FrameworkElement.Parent()FrameworkElement.Parent<T>()FrameworkElement.Parent(string)FrameworkElement.Parent(string, bool)FrameworkElement.GetNextSibling()FrameworkElement.GetPrevSibling()FrameworkElement.NextSibling(string)FrameworkElement.NextSibling<T>()FrameworkElement.PreviousSibling(string)FrameworkElement.PreviousSibling<T>()FrameworkElement.AnySibling<T>()FrameworkElement.AnySibling(string)FrameworkElement.GetScreenRectangle()FrameworkElement.ScrollToVisible()FrameworkElement.ScrollToVisible(ScrollToVisibleType)FrameworkElement.EnsureClickable()FrameworkElement.ToXml()FrameworkElement.Refresh()FrameworkElement.Equals(object)FrameworkElement.GetHashCode()FrameworkElement.GetProperties()FrameworkElement.GetAttachedProperty<T>(string, string)FrameworkElement.SetAttachedProperty<T>(string, string, T)FrameworkElement.SetFocus()FrameworkElement.ValidateMouseLocationIfNeeded(Point)FrameworkElement.GetStringPresentation()FrameworkElement.ToRealObject()FrameworkElement.FromRealObject(object)FrameworkElement.ValidateType(Type, string)FrameworkElement.GetKnownControlTypes(TechnologyType)FrameworkElement.RegisterElement(Type, string)FrameworkElement.InitKnownWpfControlTypes()FrameworkElement.InitKnownSilverlightControlTypes()FrameworkElement.InitKnownXamlControlTypes(Type)FrameworkElement.GetControlTypeFromInterface(Type)FrameworkElement.Match(IFindExpression)FrameworkElement.SetDepth(int)FrameworkElement.AddChildNode(ITargetElement)FrameworkElement.SetClosingTag(ITargetElement)FrameworkElement.GetChildren()FrameworkElement.GetParent()FrameworkElement.GetHostParent()FrameworkElement.SetParent(ITargetElement)FrameworkElement.GetUniqueHashCode()FrameworkElement.ToString()FrameworkElement.Capture()FrameworkElement.CaptureImage()FrameworkElement.GetProperty<T>(string)FrameworkElement.GetPropertyTypeSafe(string)FrameworkElement.GetAutomationProperty(string)FrameworkElement.SetProperty(string, object)FrameworkElement.ActualWidthFrameworkElement.ActualHeightFrameworkElement.WidthFrameworkElement.HeightFrameworkElement.MinWidthFrameworkElement.MaxWidthFrameworkElement.MinHeightFrameworkElement.MaxHeightFrameworkElement.HorizontalAlignmentFrameworkElement.VerticalAlignmentFrameworkElement.MarginFrameworkElement.DesiredSizeFrameworkElement.RenderSizeFrameworkElement.NameFrameworkElement.OpacityFrameworkElement.ClipFrameworkElement.RenderTransformFrameworkElement.OpacityMaskFrameworkElement.RenderTransformOriginFrameworkElement.IsHitTestVisibleFrameworkElement.VisibilityFrameworkElement.UidFrameworkElement.MappingsFrameworkElement.AutomationIdFrameworkElement.XamlTagBaseFrameworkElement.TextFrameworkElement.TextBlockContentFrameworkElement.TextLiteralContentFrameworkElement.UserFrameworkElement.XamlTagFrameworkElement.WaitFrameworkElement.FindFrameworkElement.ApplicationFrameworkElement.AbsoluteTagIndexFrameworkElement.TagNameIndexFrameworkElement.AbsoluteSiblingTagIndexFrameworkElement.EnableValidateMouseLocationFrameworkElement.ToolTipTextFrameworkElement.ComputedVisibilityFrameworkElement.IsVisibleFrameworkElement.ChildrenFrameworkElement.TechnologyTypeFrameworkElement.DepthFrameworkElement.IsTestRegionFrameworkElement.ParsedElementFrameworkElement.HostAutomationObject<FrameworkElement>.GetProperty(AutomationProperty)AutomationObject<FrameworkElement>.GetProperty(AutomationProperty, object)AutomationObject<FrameworkElement>.SetProperty(AutomationProperty, object)AutomationObject<FrameworkElement>.InvokeMethod(AutomationMethod, params object[])AutomationObject<FrameworkElement>.InvokeMethod(string, params object[])AutomationObject<FrameworkElement>.Serialize()AutomationObject<FrameworkElement>.Deserialize(string)AutomationObject<FrameworkElement>.ReferenceAutomationObject<FrameworkElement>.PropertyBag

Constructors

ToggleButton()

Declaration

cs-api-definition
public ToggleButton()

Fields

IsCheckedProperty

Declaration

cs-api-definition
public static AutomationProperty IsCheckedProperty

Field Value

AutomationProperty

IsThreeStateProperty

Declaration

cs-api-definition
public static AutomationProperty IsThreeStateProperty

Field Value

AutomationProperty

Properties

CheckIcon

Get the ToggleButton check icon element. Override for custom control template.

Declaration

cs-api-definition
public virtual FrameworkElement CheckIcon { get; }

Property Value

FrameworkElement

Implements IToggleButton.CheckIcon

IsChecked

Get/set whether the ToggleButton is checked.

Declaration

cs-api-definition
public bool? IsChecked { get; set; }

Property Value

bool?

Implements IToggleButton.IsChecked

IsThreeState

Get/set whether the ToggleButton is in three state.

Declaration

cs-api-definition
public bool IsThreeState { get; set; }

Property Value

bool

Implements IToggleButton.IsThreeState

Methods

Check(bool)

Checks the toggle button. If simulate real user clicks on the toggle box portion if it exists, otherwise clicks on the center of the button rectangle. If doesn't, simulate real user updates the checked state via an automation property.

Declaration

cs-api-definition
public void Check(bool simulateRealUser)

Parameters

simulateRealUser

bool

Whether to simulate a real user click.

Implements IToggleButton.Check(bool)

GetRealType()

Gets the real object type. This property returns string.empty on FrameworkElement and all subclasses that inherit from it.

Declaration

cs-api-definition
public override string GetRealType()

Returns

string

Overrides ButtonBase.GetRealType()

Toggle()

Changes the state of the toggle button. Clicks on the toggle box portion if it exists, otherwise clicks on the center of the button rectangle.

Declaration

cs-api-definition
public void Toggle()

Implements IToggleButton.Toggle()

UnCheck(bool)

Unchecks the toggle button. If simulate real user clicks on the toggle box portion if it exists, otherwise clicks on the center of the button rectangle. If doesn't, simulate real user updates the checked state via an automation property.

Declaration

cs-api-definition
public void UnCheck(bool simulateRealUser)

Parameters

simulateRealUser

bool

Whether to simulate a real user click.

Implements IToggleButton.UnCheck(bool)

In this article
DefinitionConstructorsToggleButton()FieldsIsCheckedPropertyIsThreeStatePropertyPropertiesCheckIconIsCheckedIsThreeStateMethodsCheck(bool)GetRealType()Toggle()UnCheck(bool)
Not finding the help you need?
Contact Support