Intersoft ClientUI Documentation
UXRibbonToggleButton Class
Members  See Also  Send Feedback
Intersoft.Client.UI.Aqua.UXRibbon Namespace : UXRibbonToggleButton Class






Represents a toggle button with three-state check behavior.

Object Model

UXRibbonToggleButton Class

Syntax

Visual Basic (Declaration) 
<TemplateVisualStateAttribute(Name="MediumState", GroupName="SizeStates")>
<TemplateVisualStateAttribute(GroupName="FocusStates", Name="Unfocused")>
<TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)>
<TemplateVisualStateAttribute(GroupName="FocusStates", Name="Focused")>
<TemplateVisualStateAttribute(GroupName="SizeStates", Name="SmallState")>
<TemplatePartAttribute(Name="InnerBorder", Type=System.Windows.Controls.Border)>
<TemplatePartAttribute(Name="Glass", Type=System.Windows.Controls.Border)>
<TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardFocused")>
<DescriptionAttribute("Represents a toggle button with three-state check behavior.")>
<TemplatePartAttribute(Name="KeyboardFocus", Type=System.Windows.Shapes.Rectangle)>
<TemplatePartAttribute(Name="DisabledVisualElement", Type=System.Windows.Controls.Border)>
<TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")>
<TemplatePartAttribute(Name="FocusVisualElement", Type=System.Windows.Controls.Border)>
<TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardUnfocused")>
<TemplateVisualStateAttribute(GroupName="CommonStates", Name="Disabled")>
<TemplateVisualStateAttribute(GroupName="CommonStates", Name="Checked")>
<TemplatePartAttribute(Name="LargeStylishLabel", Type=Intersoft.Client.UI.Controls.StylishLabel)>
<TemplateVisualStateAttribute(GroupName="CommonStates", Name="MouseOver")>
<TemplateVisualStateAttribute(GroupName="SizeStates", Name="LargeState")>
<TemplateVisualStateAttribute(GroupName="CommonStates", Name="HighlightFocused")>
<TemplatePartAttribute(Name="AnimationElement", Type=System.Windows.Controls.Border)>
<TemplateVisualStateAttribute(GroupName="CommonStates", Name="Pressed")>
<TemplatePartAttribute(Name="StylishLabel", Type=Intersoft.Client.UI.Controls.StylishLabel)>
<TemplatePartAttribute(Name="OuterBorder", Type=System.Windows.Controls.Border)>
Public Class UXRibbonToggleButton 
   Inherits Intersoft.Client.UI.Aqua.UXToggleButton
   Implements IControl, IFramework, ILicensing, INavigationSource, INavigationSupport, ICommandSource, IKeyboardFocus, IRibbonControl, IRibbonKeyTipAction 
Visual Basic (Usage)Copy Code
Dim instance As UXRibbonToggleButton
C# 
[TemplateVisualStateAttribute(Name="MediumState", GroupName="SizeStates")]
[TemplateVisualStateAttribute(GroupName="FocusStates", Name="Unfocused")]
[TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)]
[TemplateVisualStateAttribute(GroupName="FocusStates", Name="Focused")]
[TemplateVisualStateAttribute(GroupName="SizeStates", Name="SmallState")]
[TemplatePartAttribute(Name="InnerBorder", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="Glass", Type=System.Windows.Controls.Border)]
[TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardFocused")]
[DescriptionAttribute("Represents a toggle button with three-state check behavior.")]
[TemplatePartAttribute(Name="KeyboardFocus", Type=System.Windows.Shapes.Rectangle)]
[TemplatePartAttribute(Name="DisabledVisualElement", Type=System.Windows.Controls.Border)]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")]
[TemplatePartAttribute(Name="FocusVisualElement", Type=System.Windows.Controls.Border)]
[TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardUnfocused")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Disabled")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Checked")]
[TemplatePartAttribute(Name="LargeStylishLabel", Type=Intersoft.Client.UI.Controls.StylishLabel)]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="MouseOver")]
[TemplateVisualStateAttribute(GroupName="SizeStates", Name="LargeState")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="HighlightFocused")]
[TemplatePartAttribute(Name="AnimationElement", Type=System.Windows.Controls.Border)]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Pressed")]
[TemplatePartAttribute(Name="StylishLabel", Type=Intersoft.Client.UI.Controls.StylishLabel)]
[TemplatePartAttribute(Name="OuterBorder", Type=System.Windows.Controls.Border)]
public class UXRibbonToggleButton : Intersoft.Client.UI.Aqua.UXToggleButton, IControl, IFramework, ILicensing, INavigationSource, INavigationSupport, ICommandSource, IKeyboardFocus, IRibbonControl, IRibbonKeyTipAction 
JScript 
TemplateVisualStateAttribute(Name="MediumState", GroupName="SizeStates")
TemplateVisualStateAttribute(GroupName="FocusStates", Name="Unfocused")
TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)
TemplateVisualStateAttribute(GroupName="FocusStates", Name="Focused")
TemplateVisualStateAttribute(GroupName="SizeStates", Name="SmallState")
TemplatePartAttribute(Name="InnerBorder", Type=System.Windows.Controls.Border)
TemplatePartAttribute(Name="Glass", Type=System.Windows.Controls.Border)
TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardFocused")
DescriptionAttribute("Represents a toggle button with three-state check behavior.")
TemplatePartAttribute(Name="KeyboardFocus", Type=System.Windows.Shapes.Rectangle)
TemplatePartAttribute(Name="DisabledVisualElement", Type=System.Windows.Controls.Border)
TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")
TemplatePartAttribute(Name="FocusVisualElement", Type=System.Windows.Controls.Border)
TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardUnfocused")
TemplateVisualStateAttribute(GroupName="CommonStates", Name="Disabled")
TemplateVisualStateAttribute(GroupName="CommonStates", Name="Checked")
TemplatePartAttribute(Name="LargeStylishLabel", Type=Intersoft.Client.UI.Controls.StylishLabel)
TemplateVisualStateAttribute(GroupName="CommonStates", Name="MouseOver")
TemplateVisualStateAttribute(GroupName="SizeStates", Name="LargeState")
TemplateVisualStateAttribute(GroupName="CommonStates", Name="HighlightFocused")
TemplatePartAttribute(Name="AnimationElement", Type=System.Windows.Controls.Border)
TemplateVisualStateAttribute(GroupName="CommonStates", Name="Pressed")
TemplatePartAttribute(Name="StylishLabel", Type=Intersoft.Client.UI.Controls.StylishLabel)
TemplatePartAttribute(Name="OuterBorder", Type=System.Windows.Controls.Border)
public class UXRibbonToggleButton extends Intersoft.Client.UI.Aqua.UXToggleButton implements IControl, IFramework, ILicensing, INavigationSource, INavigationSupport, ICommandSource, IKeyboardFocus, IRibbonControl, IRibbonKeyTipAction 
Managed Extensions for C++ 
[TemplateVisualStateAttribute(Name="MediumState", GroupName="SizeStates")]
[TemplateVisualStateAttribute(GroupName="FocusStates", Name="Unfocused")]
[TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)]
[TemplateVisualStateAttribute(GroupName="FocusStates", Name="Focused")]
[TemplateVisualStateAttribute(GroupName="SizeStates", Name="SmallState")]
[TemplatePartAttribute(Name="InnerBorder", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="Glass", Type=System.Windows.Controls.Border)]
[TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardFocused")]
[DescriptionAttribute("Represents a toggle button with three-state check behavior.")]
[TemplatePartAttribute(Name="KeyboardFocus", Type=System.Windows.Shapes.Rectangle)]
[TemplatePartAttribute(Name="DisabledVisualElement", Type=System.Windows.Controls.Border)]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")]
[TemplatePartAttribute(Name="FocusVisualElement", Type=System.Windows.Controls.Border)]
[TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardUnfocused")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Disabled")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Checked")]
[TemplatePartAttribute(Name="LargeStylishLabel", Type=Intersoft.Client.UI.Controls.StylishLabel)]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="MouseOver")]
[TemplateVisualStateAttribute(GroupName="SizeStates", Name="LargeState")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="HighlightFocused")]
[TemplatePartAttribute(Name="AnimationElement", Type=System.Windows.Controls.Border)]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Pressed")]
[TemplatePartAttribute(Name="StylishLabel", Type=Intersoft.Client.UI.Controls.StylishLabel)]
[TemplatePartAttribute(Name="OuterBorder", Type=System.Windows.Controls.Border)]
public __gc class UXRibbonToggleButton : public Intersoft.Client.UI.Aqua.UXToggleButton, IControl, IFramework, ILicensing, INavigationSource, INavigationSupport, ICommandSource, IKeyboardFocus, IRibbonControl, IRibbonKeyTipAction 
C++/CLI 
[TemplateVisualStateAttribute(Name="MediumState", GroupName="SizeStates")]
[TemplateVisualStateAttribute(GroupName="FocusStates", Name="Unfocused")]
[TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)]
[TemplateVisualStateAttribute(GroupName="FocusStates", Name="Focused")]
[TemplateVisualStateAttribute(GroupName="SizeStates", Name="SmallState")]
[TemplatePartAttribute(Name="InnerBorder", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="Glass", Type=System.Windows.Controls.Border)]
[TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardFocused")]
[DescriptionAttribute("Represents a toggle button with three-state check behavior.")]
[TemplatePartAttribute(Name="KeyboardFocus", Type=System.Windows.Shapes.Rectangle)]
[TemplatePartAttribute(Name="DisabledVisualElement", Type=System.Windows.Controls.Border)]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")]
[TemplatePartAttribute(Name="FocusVisualElement", Type=System.Windows.Controls.Border)]
[TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardUnfocused")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Disabled")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Checked")]
[TemplatePartAttribute(Name="LargeStylishLabel", Type=Intersoft.Client.UI.Controls.StylishLabel)]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="MouseOver")]
[TemplateVisualStateAttribute(GroupName="SizeStates", Name="LargeState")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="HighlightFocused")]
[TemplatePartAttribute(Name="AnimationElement", Type=System.Windows.Controls.Border)]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Pressed")]
[TemplatePartAttribute(Name="StylishLabel", Type=Intersoft.Client.UI.Controls.StylishLabel)]
[TemplatePartAttribute(Name="OuterBorder", Type=System.Windows.Controls.Border)]
public ref class UXRibbonToggleButton : public Intersoft.Client.UI.Aqua.UXToggleButton, IControl, IFramework, ILicensing, INavigationSource, INavigationSupport, ICommandSource, IKeyboardFocus, IRibbonControl, IRibbonKeyTipAction 

Remarks

Inherited from UXToggleButton, UXRibbonToggleButton exposes many of the features available in UXToggleButton such as ImageContent presentation model, default and cancel button, dialog result, commanding, navigation, and more. To learn more about UXToggleButton, see UXToggleButton Overview.

XAML Copy Code 
<Intersoft:UXRibbonTabGroup Name="NewGroup" Header="New">
    <Intersoft:UXRibbonToggleButton Content="Paste" MinimumSize="Large" 
        LargeIcon="/RibbonSample;component/Assets/Images/Outlook/new_email.png" 
        Icon="/RibbonSample;component/Assets/Images/Outlook/new_email.png" />
    <Intersoft:UXRibbonToggleButton Content="New Items" MaximumSize="Medium" 
        LargeIcon="/RibbonSample;component/Assets/Images/Outlook/new_items.png" 
        Icon="/RibbonSample;component/Assets/Images/Outlook/new_items.png" />
    <Intersoft:UXRibbonToggleButton Content="Junk" MaximumSize="Medium" 
        LargeIcon="/RibbonSample;component/Assets/Images/Outlook/junk.png" 
        Icon="/RibbonSample;component/Assets/Images/Outlook/junk.png" />
</Intersoft:UXRibbonTabGroup>

The result looks like the following figure.

To learn more about ribbon controls, see Working with Ribbon Controls.

Inheritance Hierarchy

System.Object
   System.Windows.DependencyObject
      System.Windows.UIElement
         System.Windows.FrameworkElement
            System.Windows.Controls.Control
               System.Windows.Controls.ContentControl
                  System.Windows.Controls.Primitives.ButtonBase
                     System.Windows.Controls.Button
                        Intersoft.Client.Framework.ISButton
                           Intersoft.Client.UI.Aqua.UXButton
                              Intersoft.Client.UI.Aqua.UXToggleButton
                                 Intersoft.Client.UI.Aqua.UXRibbon.UXRibbonToggleButton

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2012 All Rights Reserved.