Dela via


RibbonToggleButton Class

Represents a toggle button that is used in a Ribbon control.

Inheritance Hierarchy

System.Object
  System.Windows.Threading.DispatcherObject
    System.Windows.DependencyObject
      System.Windows.Media.Visual
        System.Windows.UIElement
          System.Windows.FrameworkElement
            System.Windows.Controls.Control
              System.Windows.Controls.ContentControl
                System.Windows.Controls.Primitives.ButtonBase
                  System.Windows.Controls.Primitives.ToggleButton
                    Microsoft.Windows.Controls.Ribbon.RibbonToggleButton

Namespace:  Microsoft.Windows.Controls.Ribbon
Assembly:  RibbonControlsLibrary (in RibbonControlsLibrary.dll)

Syntax

'Declaration
<TemplatePartAttribute(Name := "PART_Image", Type := GetType(Image))> _
Public Class RibbonToggleButton _
    Inherits ToggleButton
[TemplatePartAttribute(Name = "PART_Image", Type = typeof(Image))]
public class RibbonToggleButton : ToggleButton
[TemplatePartAttribute(Name = L"PART_Image", Type = typeof(Image))]
public ref class RibbonToggleButton : public ToggleButton
[<TemplatePartAttribute(Name = "PART_Image", Type = typeof(Image))>]
type RibbonToggleButton =  
    class
        inherit ToggleButton
    end
public class RibbonToggleButton extends ToggleButton

The RibbonToggleButton type exposes the following members.

Constructors

  Name Description
Public method RibbonToggleButton Initializes a new instance of the RibbonToggleButton class.

Top

Properties

  Name Description
Public property ActualHeight Gets the rendered height of this element. (Inherited from FrameworkElement.)
Public property ActualWidth Gets the rendered width of this element. (Inherited from FrameworkElement.)
Public property AllowDrop Gets or sets a value indicating whether this element can be used as the target of a drag-and-drop operation. This is a dependency property. (Inherited from UIElement.)
Public property Background Gets or sets a brush that describes the background of a control. (Inherited from Control.)
Public property BindingGroup Gets or sets the BindingGroup that is used for the element. (Inherited from FrameworkElement.)
Public property BitmapEffect Obsolete. Gets or sets a bitmap effect that applies directly to the rendered content for this element. This is a dependency property. (Inherited from UIElement.)
Public property BitmapEffectInput Obsolete. Gets or sets an input source for the bitmap effect that applies directly to the rendered content for this element. This is a dependency property. (Inherited from UIElement.)
Public property BorderBrush Gets or sets a brush that describes the border background of a control. (Inherited from Control.)
Public property BorderThickness Gets or sets the border thickness of a control. (Inherited from Control.)
Public property CanAddToQuickAccessToolBarDirectly Gets or sets a value that indicates whether this control can be added directly to the Quick Access Toolbar.
Public property CheckedBackground Gets or sets the brush that is used to draw the background of the control when it is in the Checked state.
Public property CheckedBorderBrush Gets or sets the brush that is used to draw the outer border of the control when it is in the Checked state.
Public property ClickMode Gets or sets when the Click event occurs. (Inherited from ButtonBase.)
Public property Clip Gets or sets the geometry used to define the outline of the contents of an element. This is a dependency property. (Inherited from UIElement.)
Public property ClipToBounds Gets or sets a value indicating whether to clip the content of this element (or content coming from the child elements of this element) to fit into the size of the containing element. This is a dependency property. (Inherited from UIElement.)
Public property Command Gets or sets the command to invoke when this button is pressed. (Inherited from ButtonBase.)
Public property CommandBindings Gets a collection of CommandBinding objects associated with this element. A CommandBinding enables command handling for this element, and declares the linkage between a command, its events, and the handlers attached by this element. (Inherited from UIElement.)
Public property CommandParameter Gets or sets the parameter to pass to the Command property. (Inherited from ButtonBase.)
Public property CommandTarget Gets or sets the element on which to raise the specified command. (Inherited from ButtonBase.)
Public property Content Gets or sets the content of a ContentControl. (Inherited from ContentControl.)
Public property ContentStringFormat Gets or sets a composite string that specifies how to format the Content property if it is displayed as a string. (Inherited from ContentControl.)
Public property ContentTemplate Gets or sets the data template used to display the content of the ContentControl. (Inherited from ContentControl.)
Public property ContentTemplateSelector Gets or sets a template selector that enables an application writer to provide custom template-selection logic. (Inherited from ContentControl.)
Public property ContextMenu Gets or sets the context menu element that should appear whenever the context menu is requested through user interface (UI) from within this element. (Inherited from FrameworkElement.)
Public property ControlSizeDefinition Gets or sets the RibbonControlSizeDefinition for this control.
Public property CornerRadius Gets or sets a value that indicates the amount that the corners of a ribbon button are rounded.
Public property Cursor Gets or sets the cursor that displays when the mouse pointer is over this element. (Inherited from FrameworkElement.)
Public property DataContext Gets or sets the data context for an element when it participates in data binding. (Inherited from FrameworkElement.)
Protected property DefaultStyleKey Gets or sets the key to use to reference the style for this control, when theme styles are used or defined. (Inherited from FrameworkElement.)
Public property DependencyObjectType Gets the DependencyObjectType that wraps the CLR type of this instance.  (Inherited from DependencyObject.)
Public property DesiredSize Gets the size that this element computed during the measure pass of the layout process. (Inherited from UIElement.)
Public property Dispatcher Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public property Effect Gets or sets the bitmap effect to apply to the UIElement. This is a dependency property. (Inherited from UIElement.)
Public property FlowDirection Gets or sets the direction that text and other user interface (UI) elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.)
Public property Focusable Gets or sets a value that indicates whether the element can receive focus. This is a dependency property. (Inherited from UIElement.)
Public property FocusedBackground Gets or sets the brush that is used to draw the background of the control when it has focus.
Public property FocusedBorderBrush Gets or sets the brush that is used to draw the outer border of the control when it has focus.
Public property FocusVisualStyle Gets or sets a property that enables customization of appearance, effects, or other style characteristics that will apply to this element when it captures keyboard focus. (Inherited from FrameworkElement.)
Public property FontFamily Gets or sets the font family of the control. (Inherited from Control.)
Public property FontSize Gets or sets the font size. (Inherited from Control.)
Public property FontStretch Gets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control.)
Public property FontStyle Gets or sets the font style. (Inherited from Control.)
Public property FontWeight Gets or sets the weight or thickness of the specified font. (Inherited from Control.)
Public property ForceCursor Gets or sets a value that indicates whether this FrameworkElement should force the user interface (UI) to render the cursor as declared by the Cursor property. (Inherited from FrameworkElement.)
Public property Foreground Gets or sets a brush that describes the foreground color. (Inherited from Control.)
Protected property HandlesScrolling Gets a value that indicates whether a control supports scrolling. (Inherited from Control.)
Public property HasAnimatedProperties Gets a value indicating whether this element has any animated properties. (Inherited from UIElement.)
Public property HasContent Gets a value that indicates whether the ContentControl contains content. (Inherited from ContentControl.)
Public property Height Gets or sets the suggested height of the element. (Inherited from FrameworkElement.)
Public property HorizontalAlignment Gets or sets the horizontal alignment characteristics applied to this element when it is composed within a parent element, such as a panel or items control. (Inherited from FrameworkElement.)
Public property HorizontalContentAlignment Gets or sets the horizontal alignment of the control's content. (Inherited from Control.)
Protected property InheritanceBehavior Gets or sets the scope limits for property value inheritance, resource key lookup, and RelativeSource FindAncestor lookup. (Inherited from FrameworkElement.)
Public property InputBindings Gets the collection of input bindings associated with this element. (Inherited from UIElement.)
Public property InputScope Gets or sets the context for input used by this FrameworkElement. (Inherited from FrameworkElement.)
Public property IsArrangeValid Gets a value indicating whether the computed size and position of child elements in this element's layout are valid. (Inherited from UIElement.)
Public property IsChecked Gets or sets whether the ToggleButton is checked. (Inherited from ToggleButton.)
Public property IsEnabled Gets or sets a value indicating whether this element is enabled in the user interface (UI). This is a dependency property. (Inherited from UIElement.)
Protected property IsEnabledCore Gets the value of the IsEnabled property. (Inherited from ButtonBase.)
Public property IsFocused Gets a value that determines whether this element has logical focus. This is a dependency property. (Inherited from UIElement.)
Public property IsHitTestVisible Gets or sets a value that declares whether this element can possibly be returned as a hit test result from some portion of its rendered content. This is a dependency property. (Inherited from UIElement.)
Public property IsInControlGroup Gets a value that indicates whether the control is hosted in a RibbonControlGroup.
Public property IsInitialized Gets a value that indicates whether this element has been initialized, either during processing by a XAML processor, or by explicitly having its EndInit method called. (Inherited from FrameworkElement.)
Public property IsInputMethodEnabled Gets a value indicating whether an input method system, such as an Input Method Editor (IME), is enabled for processing the input to this element. (Inherited from UIElement.)
Public property IsInQuickAccessToolBar Gets a value that indicates whether the control is hosted in the Quick Access Toolbar.
Public property IsKeyboardFocused Gets a value indicating whether this element has keyboard focus. This is a dependency property. (Inherited from UIElement.)
Public property IsKeyboardFocusWithin Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. This is a dependency property. (Inherited from UIElement.)
Public property IsLoaded Gets a value that indicates whether this element has been loaded for presentation. (Inherited from FrameworkElement.)
Public property IsMeasureValid Gets a value indicating whether the current size returned by layout measure is valid. (Inherited from UIElement.)
Public property IsMouseCaptured Gets a value indicating whether the mouse is captured to this element. This is a dependency property. (Inherited from UIElement.)
Public property IsMouseCaptureWithin Gets a value that determines whether mouse capture is held by this element or by child elements in its visual tree. This is a dependency property. (Inherited from UIElement.)
Public property IsMouseDirectlyOver Gets a value that indicates whether the position of the mouse pointer corresponds to hit test results, which take element compositing into account. This is a dependency property. (Inherited from UIElement.)
Public property IsMouseOver Gets a value indicating whether the mouse pointer is located over this element (including child elements in the visual tree). This is a dependency property. (Inherited from UIElement.)
Public property IsPressed Gets a value that indicates whether a ButtonBase is currently activated. (Inherited from ButtonBase.)
Public property IsSealed Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
Public property IsStylusCaptured Gets a value indicating whether the stylus is captured by this element. This is a dependency property. (Inherited from UIElement.)
Public property IsStylusCaptureWithin Gets a value that determines whether stylus capture is held by this element, or an element within the element bounds and its visual tree. This is a dependency property. (Inherited from UIElement.)
Public property IsStylusDirectlyOver Gets a value that indicates whether the stylus position corresponds to hit test results, which take element compositing into account. This is a dependency property. (Inherited from UIElement.)
Public property IsStylusOver Gets a value indicating whether the stylus cursor is located over this element (including visual child elements). This is a dependency property. (Inherited from UIElement.)
Public property IsTabStop Gets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control.)
Public property IsThreeState Determines whether the control supports two or three states. (Inherited from ToggleButton.)
Public property IsVisible Gets a value indicating whether this element is visible in the user interface (UI). This is a dependency property. (Inherited from UIElement.)
Public property KeyTip Gets or sets the keyboard shortcut for the control.
Public property Label Gets or sets the text that is displayed next to or below the control.
Public property Language Gets or sets localization/globalization language information that applies to an element. (Inherited from FrameworkElement.)
Public property LargeImageSource Gets or sets the image that is displayed on the control when the image size is set to Large.
Public property LayoutTransform Gets or sets a graphics transformation that should apply to this element when layout is performed. (Inherited from FrameworkElement.)
Protected property LogicalChildren Gets an enumerator to the content control's logical child elements. (Inherited from ContentControl.)
Public property Margin Gets or sets the outer margin of an element. (Inherited from FrameworkElement.)
Public property MaxHeight Gets or sets the maximum height constraint of the element. (Inherited from FrameworkElement.)
Public property MaxWidth Gets or sets the maximum width constraint of the element. (Inherited from FrameworkElement.)
Public property MinHeight Gets or sets the minimum height constraint of the element. (Inherited from FrameworkElement.)
Public property MinWidth Gets or sets the minimum width constraint of the element. (Inherited from FrameworkElement.)
Public property MouseOverBackground Gets or sets the brush that is used to draw the background of the control when the mouse pointer is over it.
Public property MouseOverBorderBrush Gets or sets the brush that is used to draw the outer border of the control when the mouse pointer is over it.
Public property Name Gets or sets the identifying name of the element. The name provides a reference so that code-behind, such as event handler code, can refer to a markup element after it is constructed during processing by a XAML processor. (Inherited from FrameworkElement.)
Public property Opacity Gets or sets the opacity factor applied to the entire UIElement when it is rendered in the user interface (UI). This is a dependency property. (Inherited from UIElement.)
Public property OpacityMask Gets or sets an opacity mask, as a Brush implementation that is applied to any alpha-channel masking for the rendered content of this element. This is a dependency property. (Inherited from UIElement.)
Public property OverridesDefaultStyle Gets or sets a value that indicates whether this element incorporates style properties from theme styles. (Inherited from FrameworkElement.)
Public property Padding Gets or sets the padding inside a control. (Inherited from Control.)
Public property Parent Gets the logical parent element of this element. (Inherited from FrameworkElement.)
Public property PersistId Obsolete. Gets a value that uniquely identifies this element. (Inherited from UIElement.)
Public property PressedBackground Gets or sets the brush that is used to draw the background of the control when it is pressed.
Public property PressedBorderBrush Gets or sets the brush that is used to draw the outer border of the control when it is pressed.
Public property QuickAccessToolBarControlSizeDefinition Gets or sets the RibbonControlSizeDefinition for this control when it is hosted in the Quick Access Toolbar.
Public property QuickAccessToolBarId Gets or sets a unique identifier that links a ribbon control to a corresponding control in the Quick Access Toolbar.
Public property RenderSize Gets (or sets, but see Remarks) the final render size of this element. (Inherited from UIElement.)
Public property RenderTransform Gets or sets transform information that affects the rendering position of this element. This is a dependency property. (Inherited from UIElement.)
Public property RenderTransformOrigin Gets or sets the center point of any possible render transform declared by RenderTransform, relative to the bounds of the element. This is a dependency property. (Inherited from UIElement.)
Public property Resources Gets or sets the locally-defined resource dictionary. (Inherited from FrameworkElement.)
Public property Ribbon Gets a reference to the Ribbon that this control belongs to.
Public property ShowKeyboardCues Gets a value that indicates whether to show the keyboard focus visual for this control.
Public property SmallImageSource Gets or sets the image that is displayed on the control when the image size is set to Small.
Public property SnapsToDevicePixels Gets or sets a value that determines whether rendering for this element should use device-specific pixel settings during rendering. This is a dependency property. (Inherited from UIElement.)
Public property Style Gets or sets the style used by this element when it is rendered. (Inherited from FrameworkElement.)
Protected property StylusPlugIns Gets a collection of all stylus plug-in (customization) objects associated with this element. (Inherited from UIElement.)
Public property TabIndex Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by using the TAB key. (Inherited from Control.)
Public property Tag Gets or sets an arbitrary object value that can be used to store custom information about this element. (Inherited from FrameworkElement.)
Public property Template Gets or sets a control template. (Inherited from Control.)
Public property TemplatedParent Gets a reference to the template parent of this element. This property is not relevant if the element was not created through a template. (Inherited from FrameworkElement.)
Public property ToolTip Gets or sets the tool-tip object that is displayed for this element in the user interface (UI). (Inherited from FrameworkElement.)
Public property ToolTipDescription Gets or sets the descriptive text that is displayed in the ToolTip for this control.
Public property ToolTipFooterDescription Gets or sets the descriptive text that is displayed in the footer of the ToolTip for this control.
Public property ToolTipFooterImageSource Gets or sets the image that is displayed in the footer of the ToolTip for this control.
Public property ToolTipFooterTitle Gets or sets the title text that is displayed in the footer of the ToolTip for this control.
Public property ToolTipImageSource Gets or sets the image that is displayed in the ToolTip for this control.
Public property ToolTipTitle Gets or sets the title text that is displayed in the ToolTip for this control.
Public property Triggers Gets the collection of triggers established directly on this element, or in child elements. (Inherited from FrameworkElement.)
Public property Uid Gets or sets the unique identifier (for localization) for this element. This is a dependency property. (Inherited from UIElement.)
Public property VerticalAlignment Gets or sets the vertical alignment characteristics applied to this element when it is composed within a parent element such as a panel or items control. (Inherited from FrameworkElement.)
Public property VerticalContentAlignment Gets or sets the vertical alignment of the control's content. (Inherited from Control.)
Public property Visibility Gets or sets the user interface (UI) visibility of this element. This is a dependency property. (Inherited from UIElement.)
Protected property VisualBitmapEffect Obsolete. Gets or sets the BitmapEffect value for the Visual. (Inherited from Visual.)
Protected property VisualBitmapEffectInput Obsolete. Gets or sets the BitmapEffectInput value for the Visual. (Inherited from Visual.)
Protected property VisualBitmapScalingMode Gets or sets the BitmapScalingMode for the Visual. (Inherited from Visual.)
Protected property VisualChildrenCount Gets the number of visual child elements within this element. (Inherited from FrameworkElement.)
Protected property VisualClip Gets or sets the clip region of the Visual as a Geometry value. (Inherited from Visual.)
Protected property VisualEdgeMode Gets or sets the edge mode of the Visual as an EdgeMode value. (Inherited from Visual.)
Protected property VisualEffect Gets or sets the bitmap effect to apply to the Visual. (Inherited from Visual.)
Protected property VisualOffset Gets or sets the offset value of the visual object. (Inherited from Visual.)
Protected property VisualOpacity Gets or sets the opacity of the Visual. (Inherited from Visual.)
Protected property VisualOpacityMask Gets or sets the Brush value that represents the opacity mask of the Visual. (Inherited from Visual.)
Protected property VisualParent Gets the visual tree parent of the visual object. (Inherited from Visual.)
Protected property VisualTransform Gets or sets the Transform value for the Visual. (Inherited from Visual.)
Protected property VisualXSnappingGuidelines Gets or sets the x-coordinate (vertical) guideline collection. (Inherited from Visual.)
Protected property VisualYSnappingGuidelines Gets or sets the y-coordinate (horizontal) guideline collection. (Inherited from Visual.)
Public property Width Gets or sets the width of the element. (Inherited from FrameworkElement.)

Top

Methods

  Name Description
Protected method AddChild Adds a specified object as the child of a ContentControl. (Inherited from ContentControl.)
Public method AddHandler(RoutedEvent, Delegate) Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. (Inherited from UIElement.)
Public method AddHandler(RoutedEvent, Delegate, Boolean) Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.)
Protected method AddLogicalChild Adds the provided object to the logical tree of this element. (Inherited from FrameworkElement.)
Protected method AddText Adds a specified text string to a ContentControl. (Inherited from ContentControl.)
Public method AddToEventRoute Adds handlers to the specified EventRoute for the current UIElement event handler collection. (Inherited from UIElement.)
Protected method AddVisualChild Defines the parent-child relationship between two visuals. (Inherited from Visual.)
Public method ApplyAnimationClock(DependencyProperty, AnimationClock) Applies an animation to a specified dependency property on this element. Any existing animations are stopped and replaced with the new animation. (Inherited from UIElement.)
Public method ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior) Applies an animation to a specified dependency property on this element, with the ability to specify what happens if the property already has a running animation. (Inherited from UIElement.)
Public method ApplyTemplate Builds the current template's visual tree if necessary, and returns a value that indicates whether the visual tree was rebuilt by this call. (Inherited from FrameworkElement.)
Public method Arrange Positions child elements and determines a size for a UIElement. Parent elements call this method from their ArrangeCore implementation (or a WPF framework-level equivalent) to form a recursive layout update. This method constitutes the second pass of a layout update. (Inherited from UIElement.)
Protected method ArrangeCore Implements ArrangeCore (defined as virtual in UIElement) and seals the implementation. (Inherited from FrameworkElement.)
Protected method ArrangeOverride Called to arrange and size the content of a Control object. (Inherited from Control.)
Public method BeginAnimation(DependencyProperty, AnimationTimeline) Starts an animation for a specified animated property on this element. (Inherited from UIElement.)
Public method BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior) Starts a specific animation for a specified animated property on this element, with the option of specifying what happens if the property already has a running animation. (Inherited from UIElement.)
Public method BeginInit Starts the initialization process for this element. (Inherited from FrameworkElement.)
Public method BeginStoryboard(Storyboard) Begins the sequence of actions that are contained in the provided storyboard. (Inherited from FrameworkElement.)
Public method BeginStoryboard(Storyboard, HandoffBehavior) Begins the sequence of actions contained in the provided storyboard, with options specified for what should happen if the property is already animated. (Inherited from FrameworkElement.)
Public method BeginStoryboard(Storyboard, HandoffBehavior, Boolean) Begins the sequence of actions contained in the provided storyboard, with specified state for control of the animation after it is started. (Inherited from FrameworkElement.)
Public method BringIntoView() Attempts to bring this element into view, within any scrollable regions it is contained within. (Inherited from FrameworkElement.)
Public method BringIntoView(Rect) Attempts to bring the provided region size of this element into view, within any scrollable regions it is contained within. (Inherited from FrameworkElement.)
Public method CaptureMouse Attempts to force capture of the mouse to this element. (Inherited from UIElement.)
Public method CaptureStylus Attempts to force capture of the stylus to this element. (Inherited from UIElement.)
Public method CheckAccess Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public method ClearValue(DependencyProperty) Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
Public method ClearValue(DependencyPropertyKey) Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
Public method CoerceValue Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.)
Public method EndInit Indicates that the initialization process for the element is complete. (Inherited from FrameworkElement.)
Public method Equals Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FindCommonVisualAncestor Returns the common ancestor of two visual objects. (Inherited from Visual.)
Public method FindName Finds an element that has the provided identifier name. (Inherited from FrameworkElement.)
Public method FindResource Searches for a resource with the specified key, and throws an exception if the requested resource is not found. (Inherited from FrameworkElement.)
Public method Focus Attempts to set focus to this element. (Inherited from UIElement.)
Public method GetAnimationBaseValue Returns the base property value for the specified property on this element, disregarding any possible animated value from a running or stopped animation. (Inherited from UIElement.)
Public method GetBindingExpression Returns the BindingExpression that represents the binding on the specified property. (Inherited from FrameworkElement.)
Public method GetHashCode Gets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Protected method GetLayoutClip Returns a geometry for a clipping mask. The mask applies if the layout system attempts to arrange an element that is larger than the available display space. (Inherited from FrameworkElement.)
Public method GetLocalValueEnumerator Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Protected method GetTemplateChild Returns the named element in the visual tree of an instantiated ControlTemplate. (Inherited from FrameworkElement.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method GetUIParentCore Returns an alternative logical parent for this element if there is no visual parent. (Inherited from FrameworkElement.)
Public method GetValue Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Protected method GetVisualChild Overrides Visual.GetVisualChild, and returns a child at the specified index from a collection of child elements. (Inherited from FrameworkElement.)
Protected method HitTestCore(PointHitTestParameters) Implements HitTestCore to supply base element hit testing behavior (returning HitTestResult). (Inherited from UIElement.)
Protected method HitTestCore(GeometryHitTestParameters) Implements Visual.HitTestCore to supply base element hit testing behavior (returning GeometryHitTestResult). (Inherited from UIElement.)
Public method InputHitTest Returns the input element within the current element that is at the specified coordinates, relative to the current element's origin. (Inherited from UIElement.)
Public method InvalidateArrange Invalidates the arrange state (layout) for the element. After the invalidation, the element will have its layout updated, which will occur asynchronously unless subsequently forced by UpdateLayout. (Inherited from UIElement.)
Public method InvalidateMeasure Invalidates the measurement state (layout) for the element. (Inherited from UIElement.)
Public method InvalidateProperty Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Public method InvalidateVisual Invalidates the rendering of the element, and forces a complete new layout pass. OnRender is called after the layout cycle is completed. (Inherited from UIElement.)
Public method IsAncestorOf Determines whether the visual object is an ancestor of the descendant visual object. (Inherited from Visual.)
Public method IsDescendantOf Determines whether the visual object is a descendant of the ancestor visual object. (Inherited from Visual.)
Public method Measure Updates the DesiredSize of a UIElement. Parent elements call this method from their own MeasureCore implementations to form a recursive layout update. Calling this method constitutes the first pass (the "Measure" pass) of a layout update. (Inherited from UIElement.)
Protected method MeasureCore Implements basic measure-pass layout system behavior for FrameworkElement. (Inherited from FrameworkElement.)
Protected method MeasureOverride Called to remeasure a control. (Inherited from Control.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method MoveFocus Moves the keyboard focus away from this element and to another element in a provided traversal direction. (Inherited from FrameworkElement.)
Protected method OnAccessKey Responds when the AccessKey for this control is called. (Inherited from ButtonBase.)
Protected method OnActivatingKeyTip Called when the KeyTip or accelerator key is pressed.
Public method OnApplyTemplate Builds the visual tree for the RibbonToggleButton when a new template is applied. (Overrides FrameworkElement.OnApplyTemplate().)
Protected method OnChecked Called when a ToggleButton raises a Checked event. (Inherited from ToggleButton.)
Protected method OnChildDesiredSizeChanged Supports layout behavior when a child element is resized. (Inherited from UIElement.)
Protected method OnClick Handles the Click event and raises the RibbonControlService.DismissPopup attached event. (Overrides ToggleButton.OnClick().)
Protected method OnContentChanged Called when the Content property changes. (Inherited from ContentControl.)
Protected method OnContentStringFormatChanged Occurs when the ContentStringFormat property changes. (Inherited from ContentControl.)
Protected method OnContentTemplateChanged Called when the ContentTemplate property changes. (Inherited from ContentControl.)
Protected method OnContentTemplateSelectorChanged Called when the ContentTemplateSelector property changes. (Inherited from ContentControl.)
Protected method OnContextMenuClosing Invoked whenever an unhandled ContextMenuClosing routed event reaches this class in its route. Implement this method to add class handling for this event. (Inherited from FrameworkElement.)
Protected method OnContextMenuOpening Invoked whenever an unhandled ContextMenuOpening routed event reaches this class in its route. Implement this method to add class handling for this event. (Inherited from FrameworkElement.)
Protected method OnCreateAutomationPeer Creates a new RibbonToggleButtonAutomationPeer object for this control. (Overrides ToggleButton.OnCreateAutomationPeer().)
Protected method OnDragEnter Invoked when an unhandled DragDrop.DragEnter attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnDragLeave Invoked when an unhandled DragDrop.DragLeave attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnDragOver Invoked when an unhandled DragDrop.DragOver attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnDrop Invoked when an unhandled DragDrop.DragEnter attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnGiveFeedback Invoked when an unhandled DragDrop.GiveFeedback attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnGotFocus Invoked whenever an unhandled GotFocus event reaches this element in its route. (Inherited from FrameworkElement.)
Protected method OnGotKeyboardFocus Provides class handling for the GotKeyboardFocus event and enables the keyboard focus visual when this control gets keyboard focus. (Overrides UIElement.OnGotKeyboardFocus(KeyboardFocusChangedEventArgs).)
Protected method OnGotMouseCapture Invoked when an unhandled Mouse.GotMouseCapture attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnGotStylusCapture Invoked when an unhandled Stylus.GotStylusCapture attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnIndeterminate Called when a ToggleButton raises an Indeterminate event. (Inherited from ToggleButton.)
Protected method OnInitialized Raises the Initialized event. This method is invoked whenever IsInitialized is set to true internally. (Inherited from FrameworkElement.)
Protected method OnIsKeyboardFocusedChanged Invoked when an unhandled IsKeyboardFocusedChanged event is raised on this element. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnIsKeyboardFocusWithinChanged Invoked just before the IsKeyboardFocusWithinChanged event is raised by this element. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnIsMouseCapturedChanged Invoked when an unhandled IsMouseCapturedChanged event is raised on this element. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnIsMouseCaptureWithinChanged Invoked when an unhandled IsMouseCaptureWithinChanged event is raised on this element. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnIsMouseDirectlyOverChanged Invoked when an unhandled IsMouseDirectlyOverChanged event is raised on this element. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnIsPressedChanged Called when the IsPressed property changes. (Inherited from ButtonBase.)
Protected method OnIsStylusCapturedChanged Invoked when an unhandled IsStylusCapturedChanged event is raised on this element. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnIsStylusCaptureWithinChanged Invoked when an unhandled IsStylusCaptureWithinChanged event is raised on this element. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnIsStylusDirectlyOverChanged Invoked when an unhandled IsStylusDirectlyOverChanged event is raised on this element. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnKeyDown Provides class handling for the KeyDown routed event that occurs when the user presses a key while this control has focus. (Inherited from ButtonBase.)
Protected method OnKeyTipAccessed Called when the KeyTip or accelerator key is accessed.
Protected method OnKeyUp Provides class handling for the KeyUp routed event that occurs when the user releases a key while this control has focus. (Inherited from ButtonBase.)
Protected method OnLostFocus Raises the LostFocus routed event by using the event data that is provided. (Inherited from UIElement.)
Protected method OnLostKeyboardFocus Provides class handling for the LostKeyboardFocus event and disables the keyboard focus visual when this control loses keyboard focus. (Overrides ButtonBase.OnLostKeyboardFocus(KeyboardFocusChangedEventArgs).)
Protected method OnLostMouseCapture Provides class handling for the LostMouseCapture routed event that occurs when this control is no longer receiving mouse event messages. (Inherited from ButtonBase.)
Protected method OnLostStylusCapture Invoked when an unhandled Stylus.LostStylusCapture attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnMouseDoubleClick Raises the MouseDoubleClick routed event. (Inherited from Control.)
Protected method OnMouseDown Invoked when an unhandled Mouse.MouseDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnMouseEnter Provides class handling for the ClickMode routed event that occurs when the mouse enters this control. (Inherited from ButtonBase.)
Protected method OnMouseLeave Provides class handling for the MouseLeave routed event that occurs when the mouse leaves an element. (Inherited from ButtonBase.)
Protected method OnMouseLeftButtonDown Provides class handling for the MouseLeftButtonDown routed event to prevent the control from receiving keyboard focus. (Overrides ButtonBase.OnMouseLeftButtonDown(MouseButtonEventArgs).)
Protected method OnMouseLeftButtonUp Provides class handling for the MouseLeftButtonUp routed event that occurs when the left mouse button is released while the mouse pointer is over this control. (Inherited from ButtonBase.)
Protected method OnMouseMove Provides class handling for the MouseMove routed event that occurs when the mouse pointer moves while over this element. (Inherited from ButtonBase.)
Protected method OnMouseRightButtonDown Invoked when an unhandled MouseRightButtonDown routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnMouseRightButtonUp Invoked when an unhandled MouseRightButtonUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnMouseUp Invoked when an unhandled Mouse.MouseUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnMouseWheel Invoked when an unhandled Mouse.MouseWheel attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewDragEnter Invoked when an unhandled DragDrop.PreviewDragEnter attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewDragLeave Invoked when an unhandled DragDrop.PreviewDragLeave attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewDragOver Invoked when an unhandled DragDrop.PreviewDragOver attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewDrop Invoked when an unhandled DragDrop.PreviewDrop attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewGiveFeedback Invoked when an unhandled DragDrop.PreviewGiveFeedback attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewGotKeyboardFocus Invoked when an unhandled Keyboard.PreviewGotKeyboardFocus attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewKeyDown Invoked when an unhandled Keyboard.PreviewKeyDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewKeyUp Invoked when an unhandled Keyboard.PreviewKeyUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewLostKeyboardFocus Invoked when an unhandled Keyboard.PreviewKeyDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewMouseDoubleClick Raises the PreviewMouseDoubleClick routed event. (Inherited from Control.)
Protected method OnPreviewMouseDown Invoked when an unhandled Mouse.PreviewMouseDown attached routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewMouseLeftButtonDown Invoked when an unhandled PreviewMouseLeftButtonDown routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewMouseLeftButtonUp Invoked when an unhandled PreviewMouseLeftButtonUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewMouseMove Invoked when an unhandled Mouse.PreviewMouseMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewMouseRightButtonDown Invoked when an unhandled PreviewMouseRightButtonDown routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewMouseRightButtonUp Invoked when an unhandled PreviewMouseRightButtonUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewMouseUp Invoked when an unhandled Mouse.PreviewMouseUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewMouseWheel Invoked when an unhandled Mouse.PreviewMouseWheel attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewQueryContinueDrag Invoked when an unhandled DragDrop.PreviewQueryContinueDrag attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewStylusButtonDown Invoked when an unhandled Stylus.PreviewStylusButtonDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewStylusButtonUp Invoked when an unhandled Stylus.PreviewStylusButtonUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewStylusDown Invoked when an unhandled Stylus.PreviewStylusDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewStylusInAirMove Invoked when an unhandled Stylus.PreviewStylusInAirMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewStylusInRange Invoked when an unhandled Stylus.PreviewStylusInRange attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewStylusMove Invoked when an unhandled Stylus.PreviewStylusMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewStylusOutOfRange Invoked when an unhandled Stylus.PreviewStylusOutOfRange attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewStylusSystemGesture Invoked when an unhandled Stylus.PreviewStylusSystemGesture attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewStylusUp Invoked when an unhandled Stylus.PreviewStylusUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPreviewTextInput Invoked when an unhandled TextCompositionManager.PreviewTextInput attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnPropertyChanged Invoked whenever the effective value of any dependency property on this FrameworkElement has been updated. The specific dependency property that changed is reported in the arguments parameter. Overrides OnPropertyChanged. (Inherited from FrameworkElement.)
Protected method OnQueryContinueDrag Invoked when an unhandled DragDrop.QueryContinueDrag attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnQueryCursor Invoked when an unhandled Mouse.QueryCursor attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnRender When overridden in a derived class, participates in rendering operations that are directed by the layout system. The rendering instructions for this element are not used directly when this method is invoked, and are instead preserved for later asynchronous use by layout and drawing. (Inherited from UIElement.)
Protected method OnRenderSizeChanged Called when the rendered size of a control changes. (Inherited from ButtonBase.)
Protected method OnStyleChanged Invoked when the style in use on this element changes, which will invalidate the layout. (Inherited from FrameworkElement.)
Protected method OnStylusButtonDown Invoked when an unhandled Stylus.StylusButtonDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnStylusButtonUp Invoked when an unhandled Stylus.StylusButtonUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnStylusDown Invoked when an unhandled Stylus.StylusDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnStylusEnter Invoked when an unhandled Stylus.StylusEnter attached event is raised by this element. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnStylusInAirMove Invoked when an unhandled Stylus.StylusInAirMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnStylusInRange Invoked when an unhandled Stylus.StylusInRange attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnStylusLeave Invoked when an unhandled Stylus.StylusLeave attached event is raised by this element. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnStylusMove Invoked when an unhandled Stylus.StylusMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnStylusOutOfRange Invoked when an unhandled Stylus.StylusOutOfRange attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnStylusSystemGesture Invoked when an unhandled Stylus.StylusSystemGesture attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnStylusUp Invoked when an unhandled Stylus.StylusUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnTemplateChanged Called whenever the control's template changes. (Inherited from Control.)
Protected method OnTextInput Invoked when an unhandled TextCompositionManager.TextInput attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnToggle Called by the OnClick method to implement toggle behavior. (Inherited from ToggleButton.)
Protected method OnToolTipClosing Invoked whenever an unhandled ToolTipClosing routed event reaches this class in its route. Implement this method to add class handling for this event. (Inherited from FrameworkElement.)
Protected method OnToolTipOpening Invoked whenever the ToolTipOpening routed event reaches this class in its route. Implement this method to add class handling for this event. (Inherited from FrameworkElement.)
Protected method OnUnchecked Called when a ToggleButton raises an Unchecked event. (Inherited from ToggleButton.)
Protected method OnVisualChildrenChanged Called when the VisualCollection of the visual object is modified. (Inherited from Visual.)
Protected method OnVisualParentChanged Invoked when the parent of this element in the visual tree is changed. Overrides OnVisualParentChanged. (Inherited from FrameworkElement.)
Protected method ParentLayoutInvalidated Supports incremental layout implementations in specialized subclasses of FrameworkElement. ParentLayoutInvalidated is invoked when a child element has invalidated a property that is marked in metadata as affecting the parent's measure or arrange passes during layout. (Inherited from FrameworkElement.)
Public method PointFromScreen Converts a Point in screen coordinates into a Point that represents the current coordinate system of the Visual. (Inherited from Visual.)
Public method PointToScreen Converts a Point that represents the current coordinate system of the Visual into a Point in screen coordinates. (Inherited from Visual.)
Public method PredictFocus Determines the next element that would receive focus relative to this element for a provided focus movement direction, but does not actually move the focus. (Inherited from FrameworkElement.)
Public method RaiseEvent Raises a specific routed event. The RoutedEvent to be raised is identified within the RoutedEventArgs instance that is provided (as the RoutedEvent property of that event data). (Inherited from UIElement.)
Public method ReadLocalValue Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Public method RegisterName Provides an accessor that simplifies access to the NameScope registration method. (Inherited from FrameworkElement.)
Public method ReleaseMouseCapture Releases the mouse capture, if this element held the capture. (Inherited from UIElement.)
Public method ReleaseStylusCapture Releases the stylus device capture, if this element held the capture. (Inherited from UIElement.)
Public method RemoveHandler Removes the specified routed event handler from this element. (Inherited from UIElement.)
Protected method RemoveLogicalChild Removes the provided object from this element's logical tree. FrameworkElement updates the affected logical tree parent pointers to keep in sync with this deletion. (Inherited from FrameworkElement.)
Protected method RemoveVisualChild Removes the parent-child relationship between two visuals. (Inherited from Visual.)
Public method SetBinding(DependencyProperty, BindingBase) Attaches a binding to this element, based on the provided binding object. (Inherited from FrameworkElement.)
Public method SetBinding(DependencyProperty, String) Attaches a binding to this element, based on the provided source property name as a path qualification to the data source. (Inherited from FrameworkElement.)
Public method SetResourceReference Searches for a resource with the specified name and sets up a resource reference to it for the specified property. (Inherited from FrameworkElement.)
Public method SetValue(DependencyProperty, Object) Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
Public method SetValue(DependencyPropertyKey, Object) Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
Public method ShouldSerializeCommandBindings Returns whether serialization processes should serialize the contents of the CommandBindings property on instances of this class. (Inherited from UIElement.)
Public method ShouldSerializeContent Indicates whether the Content property should be persisted. (Inherited from ContentControl.)
Public method ShouldSerializeInputBindings Returns whether serialization processes should serialize the contents of the InputBindings property on instances of this class. (Inherited from UIElement.)
Protected method ShouldSerializeProperty Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public method ShouldSerializeResources Returns whether serialization processes should serialize the contents of the Resources property. (Inherited from FrameworkElement.)
Public method ShouldSerializeStyle Returns whether serialization processes should serialize the contents of the Style property. (Inherited from FrameworkElement.)
Public method ShouldSerializeTriggers Returns whether serialization processes should serialize the contents of the Triggers property. (Inherited from FrameworkElement.)
Public method ToString Returns the string representation of a ToggleButton object. (Inherited from ToggleButton.)
Public method TransformToAncestor(Visual) Returns a transform that can be used to transform coordinates from the Visual to the specified Visual ancestor of the visual object. (Inherited from Visual.)
Public method TransformToAncestor(Visual3D) Returns a transform that can be used to transform coordinates from the Visual to the specified Visual3D ancestor of the visual object. (Inherited from Visual.)
Public method TransformToDescendant Returns a transform that can be used to transform coordinates from the Visual to the specified visual object descendant. (Inherited from Visual.)
Public method TransformToVisual Returns a transform that can be used to transform coordinates from the Visual to the specified visual object. (Inherited from Visual.)
Public method TranslatePoint Translates a point relative to this element to coordinates that are relative to the specified element. (Inherited from UIElement.)
Public method TryFindResource Searches for a resource with the specified key, and returns that resource if found. (Inherited from FrameworkElement.)
Public method UnregisterName Simplifies access to the NameScope de-registration method. (Inherited from FrameworkElement.)
Public method UpdateLayout Ensures that all visual child elements of this element are properly updated for layout. (Inherited from UIElement.)
Public method VerifyAccess Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)

Top

Events

  Name Description
Public event Checked Occurs when a ToggleButton is checked. (Inherited from ToggleButton.)
Public event Click Occurs when a Button is clicked. (Inherited from ButtonBase.)
Public event ContextMenuClosing Occurs just before any context menu on the element is closed. (Inherited from FrameworkElement.)
Public event ContextMenuOpening Occurs when any context menu on the element is opened. (Inherited from FrameworkElement.)
Public event DataContextChanged Occurs when the data context for this element changes. (Inherited from FrameworkElement.)
Public event DragEnter Occurs when the input system reports an underlying drag event with this element as the drag target. (Inherited from UIElement.)
Public event DragLeave Occurs when the input system reports an underlying drag event with this element as the drag origin. (Inherited from UIElement.)
Public event DragOver Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.)
Public event Drop Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.)
Public event FocusableChanged Occurs when the value of the Focusable property changes. (Inherited from UIElement.)
Public event GiveFeedback Occurs when the input system reports an underlying drag-and-drop event that involves this element. (Inherited from UIElement.)
Public event GotFocus Occurs when this element gets logical focus. (Inherited from UIElement.)
Public event GotKeyboardFocus Occurs when the keyboard is focused on this element. (Inherited from UIElement.)
Public event GotMouseCapture Occurs when this element captures the mouse. (Inherited from UIElement.)
Public event GotStylusCapture Occurs when this element captures the stylus. (Inherited from UIElement.)
Public event Indeterminate Occurs when the state of a ToggleButton is neither on nor off. (Inherited from ToggleButton.)
Public event Initialized Occurs when this FrameworkElement is initialized. This event coincides with cases where the value of the IsInitialized property changes from false (or undefined) to true. (Inherited from FrameworkElement.)
Public event IsEnabledChanged Occurs when the value of the IsEnabled property on this element changes. (Inherited from UIElement.)
Public event IsHitTestVisibleChanged Occurs when the value of the IsHitTestVisible dependency property changes on this element. (Inherited from UIElement.)
Public event IsKeyboardFocusedChanged Occurs when the value of the IsKeyboardFocused property changes on this element. (Inherited from UIElement.)
Public event IsKeyboardFocusWithinChanged Occurs when the value of the IsKeyboardFocusWithinChanged property changes on this element. (Inherited from UIElement.)
Public event IsMouseCapturedChanged Occurs when the value of the IsMouseCaptured property changes on this element. (Inherited from UIElement.)
Public event IsMouseCaptureWithinChanged Occurs when the value of the IsMouseCaptureWithinProperty changes on this element. (Inherited from UIElement.)
Public event IsMouseDirectlyOverChanged Occurs when the value of the IsMouseDirectlyOver property changes on this element. (Inherited from UIElement.)
Public event IsStylusCapturedChanged Occurs when the value of the IsStylusCaptured property changes on this element. (Inherited from UIElement.)
Public event IsStylusCaptureWithinChanged Occurs when the value of the IsStylusCaptureWithin property changes on this element. (Inherited from UIElement.)
Public event IsStylusDirectlyOverChanged Occurs when the value of the IsStylusDirectlyOver property changes on this element. (Inherited from UIElement.)
Public event IsVisibleChanged Occurs when the value of the IsVisible property changes on this element. (Inherited from UIElement.)
Public event KeyDown Occurs when a key is pressed while focus is on this element. (Inherited from UIElement.)
Public event KeyUp Occurs when a key is released while focus is on this element. (Inherited from UIElement.)
Public event LayoutUpdated Occurs when the layout of the various visual elements associated with the current Dispatcher changes. (Inherited from UIElement.)
Public event Loaded Occurs when the element is laid out, rendered, and ready for interaction. (Inherited from FrameworkElement.)
Public event LostFocus Occurs when this element loses logical focus. (Inherited from UIElement.)
Public event LostKeyboardFocus Occurs when the keyboard is no longer focused on this element,. (Inherited from UIElement.)
Public event LostMouseCapture Occurs when this element loses mouse capture. (Inherited from UIElement.)
Public event LostStylusCapture Occurs when this element loses stylus capture. (Inherited from UIElement.)
Public event MouseDoubleClick Occurs when a mouse button is clicked two or more times. (Inherited from Control.)
Public event MouseDown Occurs when any mouse button is pressed while the pointer is over this element. (Inherited from UIElement.)
Public event MouseEnter Occurs when the mouse pointer enters the bounds of this element. (Inherited from UIElement.)
Public event MouseLeave Occurs when the mouse pointer leaves the bounds of this element. (Inherited from UIElement.)
Public event MouseLeftButtonDown Occurs when the left mouse button is pressed while the mouse pointer is over this element. (Inherited from UIElement.)
Public event MouseLeftButtonUp Occurs when the left mouse button is released while the mouse pointer is over this element. (Inherited from UIElement.)
Public event MouseMove Occurs when the mouse pointer moves while over this element. (Inherited from UIElement.)
Public event MouseRightButtonDown Occurs when the right mouse button is pressed while the mouse pointer is over this element. (Inherited from UIElement.)
Public event MouseRightButtonUp Occurs when the right mouse button is released while the mouse pointer is over this element. (Inherited from UIElement.)
Public event MouseUp Occurs when any mouse button is released over this element. (Inherited from UIElement.)
Public event MouseWheel Occurs when the user rotates the mouse wheel while the mouse pointer is over this element. (Inherited from UIElement.)
Public event PreviewDragEnter Occurs when the input system reports an underlying drag event with this element as the drag target. (Inherited from UIElement.)
Public event PreviewDragLeave Occurs when the input system reports an underlying drag event with this element as the drag origin. (Inherited from UIElement.)
Public event PreviewDragOver Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.)
Public event PreviewDrop Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.)
Public event PreviewGiveFeedback Occurs when a drag-and-drop operation is started. (Inherited from UIElement.)
Public event PreviewGotKeyboardFocus Occurs when the keyboard is focused on this element. (Inherited from UIElement.)
Public event PreviewKeyDown Occurs when a key is pressed while focus is on this element. (Inherited from UIElement.)
Public event PreviewKeyUp Occurs when a key is released while focus is on this element. (Inherited from UIElement.)
Public event PreviewLostKeyboardFocus Occurs when the keyboard is no longer focused on this element. (Inherited from UIElement.)
Public event PreviewMouseDoubleClick Occurs when a user clicks the mouse button two or more times. (Inherited from Control.)
Public event PreviewMouseDown Occurs when any mouse button is pressed while the pointer is over this element. (Inherited from UIElement.)
Public event PreviewMouseLeftButtonDown Occurs when the left mouse button is pressed while the mouse pointer is over this element. (Inherited from UIElement.)
Public event PreviewMouseLeftButtonUp Occurs when the left mouse button is released while the mouse pointer is over this element. (Inherited from UIElement.)
Public event PreviewMouseMove Occurs when the mouse pointer moves while the mouse pointer is over this element. (Inherited from UIElement.)
Public event PreviewMouseRightButtonDown Occurs when the right mouse button is pressed while the mouse pointer is over this element. (Inherited from UIElement.)
Public event PreviewMouseRightButtonUp Occurs when the right mouse button is released while the mouse pointer is over this element. (Inherited from UIElement.)
Public event PreviewMouseUp Occurs when any mouse button is released while the mouse pointer is over this element. (Inherited from UIElement.)
Public event PreviewMouseWheel Occurs when the user rotates the mouse wheel while the mouse pointer is over this element. (Inherited from UIElement.)
Public event PreviewQueryContinueDrag Occurs when there is a change in the keyboard or mouse button state during a drag-and-drop operation. (Inherited from UIElement.)
Public event PreviewStylusButtonDown Occurs when the stylus button is pressed while the pointer is over this element. (Inherited from UIElement.)
Public event PreviewStylusButtonUp Occurs when the stylus button is released while the pointer is over this element. (Inherited from UIElement.)
Public event PreviewStylusDown Occurs when the stylus touches the digitizer while it is over this element. (Inherited from UIElement.)
Public event PreviewStylusInAirMove Occurs when the stylus moves over an element without actually touching the digitizer. (Inherited from UIElement.)
Public event PreviewStylusInRange Occurs when the stylus is close enough to the digitizer to be detected, while over this element. (Inherited from UIElement.)
Public event PreviewStylusMove Occurs when the stylus moves while over the element. The stylus must move while being detected by the digitizer to raise this event, otherwise, PreviewStylusInAirMove is raised instead. (Inherited from UIElement.)
Public event PreviewStylusOutOfRange Occurs when the stylus is too far from the digitizer to be detected. (Inherited from UIElement.)
Public event PreviewStylusSystemGesture Occurs when a user performs one of several stylus gestures. (Inherited from UIElement.)
Public event PreviewStylusUp Occurs when the user raises the stylus off the digitizer while the stylus is over this element. (Inherited from UIElement.)
Public event PreviewTextInput Occurs when this element gets text in a device-independent manner. (Inherited from UIElement.)
Public event QueryContinueDrag Occurs when there is a change in the keyboard or mouse button state during a drag-and-drop operation. (Inherited from UIElement.)
Public event QueryCursor Occurs when the cursor is requested to display. This event is raised on an element each time that the mouse pointer moves to a new location, which means the cursor object might need to be changed based on its new position. (Inherited from UIElement.)
Public event RequestBringIntoView Occurs when BringIntoView is called on this element. (Inherited from FrameworkElement.)
Public event SizeChanged Occurs when either the ActualHeight or the ActualWidth properties change value on this element. (Inherited from FrameworkElement.)
Public event SourceUpdated Occurs when the source value changes for any existing property binding on this element. (Inherited from FrameworkElement.)
Public event StylusButtonDown Occurs when the stylus button is pressed while the pointer is over this element. (Inherited from UIElement.)
Public event StylusButtonUp Occurs when the stylus button is released while the pointer is over this element. (Inherited from UIElement.)
Public event StylusDown Occurs when the stylus touches the digitizer while the stylus is over this element. (Inherited from UIElement.)
Public event StylusEnter Occurs when the stylus enters the bounds of this element. (Inherited from UIElement.)
Public event StylusInAirMove Occurs when the stylus moves over an element without actually touching the digitizer. (Inherited from UIElement.)
Public event StylusInRange Occurs when the stylus is close enough to the digitizer to be detected, while over this element. (Inherited from UIElement.)
Public event StylusLeave Occurs when the stylus leaves the bounds of the element. (Inherited from UIElement.)
Public event StylusMove Occurs when the stylus moves over this element. The stylus must move while on the digitizer to raise this event. Otherwise, StylusInAirMove is raised instead. (Inherited from UIElement.)
Public event StylusOutOfRange Occurs when the stylus is too far from the digitizer to be detected, while over this element. (Inherited from UIElement.)
Public event StylusSystemGesture Occurs when a user performs one of several stylus gestures. (Inherited from UIElement.)
Public event StylusUp Occurs when the user raises the stylus off the digitizer while it is over this element. (Inherited from UIElement.)
Public event TargetUpdated Occurs when the target value changes for any property binding on this element. (Inherited from FrameworkElement.)
Public event TextInput Occurs when this element gets text in a device-independent manner. (Inherited from UIElement.)
Public event ToolTipClosing Occurs just before any tooltip on the element is closed. (Inherited from FrameworkElement.)
Public event ToolTipOpening Occurs when any tooltip on the element is opened. (Inherited from FrameworkElement.)
Public event Unchecked Occurs when a ToggleButton is unchecked. (Inherited from ToggleButton.)
Public event Unloaded Occurs when the element is removed from within an element tree of loaded elements. (Inherited from FrameworkElement.)

Top

Fields

  Name Description
Public fieldStatic member CanAddToQuickAccessToolBarDirectlyProperty Identifies the CanAddToQuickAccessToolBarDirectly dependency property.
Public fieldStatic member CheckedBackgroundProperty Identifies the CheckedBackground dependency property.
Public fieldStatic member CheckedBorderBrushProperty Identifies the CheckedBorderBrush dependency property.
Public fieldStatic member ControlSizeDefinitionProperty Identifies the ControlSizeDefinition dependency property.
Public fieldStatic member CornerRadiusProperty Identifies the CornerRadius dependency property.
Public fieldStatic member FocusedBackgroundProperty Identifies the FocusedBackground dependency property.
Public fieldStatic member FocusedBorderBrushProperty Identifies the FocusedBorderBrush dependency property.
Public fieldStatic member IsInControlGroupProperty Identifies the IsInControlGroup dependency property.
Public fieldStatic member IsInQuickAccessToolBarProperty Identifies the IsInQuickAccessToolBar dependency property.
Public fieldStatic member KeyTipProperty Identifies the KeyTip dependency property.
Public fieldStatic member LabelProperty Identifies the Label dependency property.
Public fieldStatic member LargeImageSourceProperty Identifies the LargeImageSource dependency property.
Public fieldStatic member MouseOverBackgroundProperty Identifies the MouseOverBackground dependency property.
Public fieldStatic member MouseOverBorderBrushProperty Identifies the MouseOverBorderBrush dependency property.
Public fieldStatic member PressedBackgroundProperty Identifies the PressedBackground dependency property.
Public fieldStatic member PressedBorderBrushProperty Identifies the PressedBorderBrush dependency property.
Public fieldStatic member QuickAccessToolBarControlSizeDefinitionProperty Identifies the QuickAccessToolBarControlSizeDefinition dependency property.
Public fieldStatic member QuickAccessToolBarIdProperty Identifies the QuickAccessToolBarId dependency property.
Public fieldStatic member RibbonProperty Identifies the Ribbon dependency property.
Public fieldStatic member ShowKeyboardCuesProperty Identifies the ShowKeyboardCues dependency property.
Public fieldStatic member SmallImageSourceProperty Identifies the SmallImageSource dependency property.
Public fieldStatic member ToolTipDescriptionProperty Identifies the ToolTipDescription dependency property.
Public fieldStatic member ToolTipFooterDescriptionProperty Identifies the ToolTipFooterDescription dependency property.
Public fieldStatic member ToolTipFooterImageSourceProperty Identifies the ToolTipFooterImageSource dependency property.
Public fieldStatic member ToolTipFooterTitleProperty Identifies the ToolTipFooterTitle dependency property.
Public fieldStatic member ToolTipImageSourceProperty Identifies the ToolTipImageSource dependency property.
Public fieldStatic member ToolTipTitleProperty Identifies the ToolTipTitle dependency property.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAddChild.AddChild This type or member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from ContentControl.)
Explicit interface implemetationPrivate method IAddChild.AddText This type or member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from ContentControl.)

Top

Remarks

The following illustration shows examples of RibbonToggleButton controls in large, medium, and small variations, and with no images.

Ribbon toggle button controls

Ribbon toggle button controls

The following illustration shows examples of RibbonToggleButton controls that are selected.

Ribbon toggle button controls that are selected

Ribbon toggle button controls that are selected

Examples

The following example shows the markup to create a RibbonToggleButton control with a large image, a small image, and a label.

<ribbon:RibbonToggleButton Label="Reminder"
                      Command="{Binding ReminderCommand}"
                      SmallImageSource="Images/Reminder16.png" 
                      LargeImageSource="Images/Reminder32.png"
                      KeyTip="R"/>

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Windows.Controls.Ribbon Namespace