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






Represents a checkbox that user can select and clear.

Object Model

UXRibbonCheckBox Class

Syntax

Visual Basic (Declaration) 
<TemplateVisualStateAttribute(Name="Checked", GroupName="CheckedStates")>
<TemplateVisualStateAttribute(GroupName="CheckedStates", Name="Indeterminate")>
<TemplateVisualStateAttribute(GroupName="CommonStates", Name="Disabled")>
<TemplateVisualStateAttribute(GroupName="CheckedStates", Name="Unchecked")>
<TemplateVisualStateAttribute(GroupName="FocusStates", Name="Focused")>
<TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardFocused")>
<TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)>
<TemplateVisualStateAttribute(GroupName="FocusStates", Name="Unfocused")>
<TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardUnfocused")>
<TemplateVisualStateAttribute(GroupName="CommonStates", Name="HighlightFocused")>
<TemplatePartAttribute(Name="Glass", Type=System.Windows.Controls.Border)>
<TemplatePartAttribute(Name="InnerBorder", Type=System.Windows.Controls.Border)>
<TemplatePartAttribute(Name="IndeterminateElement", Type=System.Windows.Controls.Border)>
<TemplatePartAttribute(Name="AnimationElement", Type=System.Windows.Controls.Border)>
<TemplatePartAttribute(Name="StylishLabel", Type=Intersoft.Client.UI.Controls.StylishLabel)>
<DescriptionAttribute("Represents a checkbox that user can select and clear.")>
<TemplatePartAttribute(Name="OuterBorder", Type=System.Windows.Controls.Border)>
<TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")>
<TemplateVisualStateAttribute(GroupName="CommonStates", Name="MouseOver")>
<TemplateVisualStateAttribute(GroupName="CommonStates", Name="Pressed")>
<TemplatePartAttribute(Name="FocusVisualElement", Type=System.Windows.Controls.Border)>
<TemplatePartAttribute(Name="DisabledVisualElement", Type=System.Windows.Controls.Border)>
<TemplatePartAttribute(Name="CheckIcon", Type=System.Windows.Shapes.Path)>
<TemplatePartAttribute(Name="KeyboardFocus", Type=System.Windows.Shapes.Rectangle)>
Public Class UXRibbonCheckBox 
   Inherits Intersoft.Client.UI.Aqua.UXCheckBox
   Implements IControlIFramework, ILicensing, INavigationSourceINavigationSupportICommandSourceIKeyboardFocusIRibbonControlIRibbonKeyTipAction 
Visual Basic (Usage)Copy Code
Dim instance As UXRibbonCheckBox
C# 
[TemplateVisualStateAttribute(Name="Checked", GroupName="CheckedStates")]
[TemplateVisualStateAttribute(GroupName="CheckedStates", Name="Indeterminate")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Disabled")]
[TemplateVisualStateAttribute(GroupName="CheckedStates", Name="Unchecked")]
[TemplateVisualStateAttribute(GroupName="FocusStates", Name="Focused")]
[TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardFocused")]
[TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)]
[TemplateVisualStateAttribute(GroupName="FocusStates", Name="Unfocused")]
[TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardUnfocused")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="HighlightFocused")]
[TemplatePartAttribute(Name="Glass", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="InnerBorder", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="IndeterminateElement", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="AnimationElement", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="StylishLabel", Type=Intersoft.Client.UI.Controls.StylishLabel)]
[DescriptionAttribute("Represents a checkbox that user can select and clear.")]
[TemplatePartAttribute(Name="OuterBorder", Type=System.Windows.Controls.Border)]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="MouseOver")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Pressed")]
[TemplatePartAttribute(Name="FocusVisualElement", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="DisabledVisualElement", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="CheckIcon", Type=System.Windows.Shapes.Path)]
[TemplatePartAttribute(Name="KeyboardFocus", Type=System.Windows.Shapes.Rectangle)]
public class UXRibbonCheckBox : Intersoft.Client.UI.Aqua.UXCheckBox, IControlIFramework, ILicensing, INavigationSourceINavigationSupportICommandSourceIKeyboardFocusIRibbonControlIRibbonKeyTipAction  
JScript 
TemplateVisualStateAttribute(Name="Checked", GroupName="CheckedStates")
TemplateVisualStateAttribute(GroupName="CheckedStates", Name="Indeterminate")
TemplateVisualStateAttribute(GroupName="CommonStates", Name="Disabled")
TemplateVisualStateAttribute(GroupName="CheckedStates", Name="Unchecked")
TemplateVisualStateAttribute(GroupName="FocusStates", Name="Focused")
TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardFocused")
TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)
TemplateVisualStateAttribute(GroupName="FocusStates", Name="Unfocused")
TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardUnfocused")
TemplateVisualStateAttribute(GroupName="CommonStates", Name="HighlightFocused")
TemplatePartAttribute(Name="Glass", Type=System.Windows.Controls.Border)
TemplatePartAttribute(Name="InnerBorder", Type=System.Windows.Controls.Border)
TemplatePartAttribute(Name="IndeterminateElement", Type=System.Windows.Controls.Border)
TemplatePartAttribute(Name="AnimationElement", Type=System.Windows.Controls.Border)
TemplatePartAttribute(Name="StylishLabel", Type=Intersoft.Client.UI.Controls.StylishLabel)
DescriptionAttribute("Represents a checkbox that user can select and clear.")
TemplatePartAttribute(Name="OuterBorder", Type=System.Windows.Controls.Border)
TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")
TemplateVisualStateAttribute(GroupName="CommonStates", Name="MouseOver")
TemplateVisualStateAttribute(GroupName="CommonStates", Name="Pressed")
TemplatePartAttribute(Name="FocusVisualElement", Type=System.Windows.Controls.Border)
TemplatePartAttribute(Name="DisabledVisualElement", Type=System.Windows.Controls.Border)
TemplatePartAttribute(Name="CheckIcon", Type=System.Windows.Shapes.Path)
TemplatePartAttribute(Name="KeyboardFocus", Type=System.Windows.Shapes.Rectangle)
public class UXRibbonCheckBox extends Intersoft.Client.UI.Aqua.UXCheckBox implements IControlIFramework, ILicensing, INavigationSourceINavigationSupportICommandSourceIKeyboardFocusIRibbonControlIRibbonKeyTipAction 
Managed Extensions for C++ 
[TemplateVisualStateAttribute(Name="Checked", GroupName="CheckedStates")]
[TemplateVisualStateAttribute(GroupName="CheckedStates", Name="Indeterminate")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Disabled")]
[TemplateVisualStateAttribute(GroupName="CheckedStates", Name="Unchecked")]
[TemplateVisualStateAttribute(GroupName="FocusStates", Name="Focused")]
[TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardFocused")]
[TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)]
[TemplateVisualStateAttribute(GroupName="FocusStates", Name="Unfocused")]
[TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardUnfocused")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="HighlightFocused")]
[TemplatePartAttribute(Name="Glass", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="InnerBorder", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="IndeterminateElement", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="AnimationElement", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="StylishLabel", Type=Intersoft.Client.UI.Controls.StylishLabel)]
[DescriptionAttribute("Represents a checkbox that user can select and clear.")]
[TemplatePartAttribute(Name="OuterBorder", Type=System.Windows.Controls.Border)]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="MouseOver")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Pressed")]
[TemplatePartAttribute(Name="FocusVisualElement", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="DisabledVisualElement", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="CheckIcon", Type=System.Windows.Shapes.Path)]
[TemplatePartAttribute(Name="KeyboardFocus", Type=System.Windows.Shapes.Rectangle)]
public __gc class UXRibbonCheckBox : public Intersoft.Client.UI.Aqua.UXCheckBox, IControlIFramework, ILicensing, INavigationSourceINavigationSupportICommandSourceIKeyboardFocusIRibbonControlIRibbonKeyTipAction  
C++/CLI 
[TemplateVisualStateAttribute(Name="Checked", GroupName="CheckedStates")]
[TemplateVisualStateAttribute(GroupName="CheckedStates", Name="Indeterminate")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Disabled")]
[TemplateVisualStateAttribute(GroupName="CheckedStates", Name="Unchecked")]
[TemplateVisualStateAttribute(GroupName="FocusStates", Name="Focused")]
[TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardFocused")]
[TemplatePartAttribute(Name="RootElement", Type=System.Windows.Controls.Grid)]
[TemplateVisualStateAttribute(GroupName="FocusStates", Name="Unfocused")]
[TemplateVisualStateAttribute(GroupName="KeyboardFocusStates", Name="KeyboardUnfocused")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="HighlightFocused")]
[TemplatePartAttribute(Name="Glass", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="InnerBorder", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="IndeterminateElement", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="AnimationElement", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="StylishLabel", Type=Intersoft.Client.UI.Controls.StylishLabel)]
[DescriptionAttribute("Represents a checkbox that user can select and clear.")]
[TemplatePartAttribute(Name="OuterBorder", Type=System.Windows.Controls.Border)]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="MouseOver")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Pressed")]
[TemplatePartAttribute(Name="FocusVisualElement", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="DisabledVisualElement", Type=System.Windows.Controls.Border)]
[TemplatePartAttribute(Name="CheckIcon", Type=System.Windows.Shapes.Path)]
[TemplatePartAttribute(Name="KeyboardFocus", Type=System.Windows.Shapes.Rectangle)]
public ref class UXRibbonCheckBox : public Intersoft.Client.UI.Aqua.UXCheckBox, IControlIFramework, ILicensing, INavigationSourceINavigationSupportICommandSourceIKeyboardFocusIRibbonControlIRibbonKeyTipAction  

Remarks

Derived from UXCheckBox, UXRibbonCheckBox shares several features in common such as three state selection, selection routed events and more. This means that you can use UXRibbonCheckBox to obtain data input which accepts Checked, Unchecked and Indeterminate state. You enable the three state mode by setting the IsThreeState property to true, then get or set the selection state through the CheckedState property. For more information, see UXCheckBox Overview.

XAML Copy Code
<Intersoft:UXRibbonCheckBox Content="Delete" 
        Icon="/assets/icons/delete.png" />

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.UXCheckBox
                                    Intersoft.Client.UI.Aqua.UXRibbon.UXRibbonCheckBox

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.