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






Represents a command button control with various display mode, keyboard support, ribbon size and routed command.

Object Model

UXRibbonButton Class

Syntax

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

Remarks

Derived from UXButton, UXRibbonButton is a command button which represents an action that will be executed when the button is clicked. To learn more about UXButton, see UXButton Overview.

XAML Copy Code 
<Intersoft:UXRibbonTabGroup Name="NewGroup" Header="New">
    <Intersoft:UXRibbonButton Content="New E-mail" MinimumSize="Large" 
        LargeIcon="/assets/icons/new_email.png" 
        Icon="/assets/icons/new_email.png" />
    <Intersoft:UXRibbonButton Content="New Items" MaximumSize="Medium" 
        LargeIcon="/assets/icons/new_items.png" 
        Icon="/assets/icons/new_items.png">
    </Intersoft:UXRibbonButton>
    <Intersoft:UXRibbonButton Content="Junk" MaximumSize="Medium" 
                LargeIcon="/assets/icons/junk.png"
        Icon="/assets/icons/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.UXRibbon.UXRibbonButton

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.