RibbonControlService Class

Article
2013-02-04

Represents a service that provides properties and methods to control the display and behavior of Ribbon controls.

Inheritance Hierarchy

System.Object
Microsoft.Windows.Controls.Ribbon.RibbonControlService

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

Syntax

'Declaration
Public NotInheritable Class RibbonControlService

public static class RibbonControlService

public ref class RibbonControlService abstract sealed

[<AbstractClass>]
[<Sealed>]
type RibbonControlService =  class end

public final class RibbonControlService

The RibbonControlService type exposes the following members.

Attached Properties

	Name	Description
	CanAddToQuickAccessToolBarDirectly	Gets or sets a value that indicates whether this control can be added directly to the Quick Access Toolbar.
	CheckedBackground	Gets or sets the brush that is used to draw the background of the control when it is in the Checked state.
	CheckedBorderBrush	Gets or sets the brush that is used to draw the outer border of the control when it in the Checked state.
	ControlSizeDefinition	Gets or sets the RibbonControlSizeDefinition for this control.
	CornerRadius	Gets or sets a value that indicates the amount that the corners of a ribbon button are rounded.
	DefaultControlSizeDefinition	Gets or sets the default RibbonControlSizeDefinition for this control.
	FocusedBackground	Gets or sets the brush that is used to draw the background of the control when it has focus.
	FocusedBorderBrush	Gets or sets the brush that is used to draw the outer border of the control when it has focus.
	IsInControlGroup	Gets a value that indicates whether the control is hosted in a RibbonControlGroup.
	IsInQuickAccessToolBar	Gets a value that indicates whether the control is hosted in the Quick Access Toolbar.
	Label	Gets or sets the text that is displayed next to or below the control.
	LargeImageSource	Gets or sets the image that is displayed on the control when the image size is set to Large.
	MouseOverBackground	Gets or sets the brush that is used to draw the background of the control when the mouse pointer is over it.
	MouseOverBorderBrush	Gets or sets the brush that is used to draw the outer border of the control when the mouse pointer is over it.
	PressedBackground	Gets or sets the brush that is used to draw the background of the control when it is pressed.
	PressedBorderBrush	Gets or sets the brush that is used to draw the outer border of the control when it is pressed.
	QuickAccessToolBarControlSizeDefinition	Gets or sets the RibbonControlSizeDefinition for this control when it is hosted in the Quick Access Toolbar.
	QuickAccessToolBarId	Gets or sets a unique identifier that links a ribbon control to a corresponding control in the Quick Access Toolbar.
	Ribbon	Gets a reference to the Ribbon that this control belongs to.
	ShowKeyboardCues	Gets a value that indicates whether to show the keyboard focus visual for this control.
	SmallImageSource	Gets or sets the image that is displayed on the control when the image size is set to Small.
	ToolTipDescription	Gets or sets the descriptive text that is displayed in the ToolTip for this control.
	ToolTipFooterDescription	Gets or sets the descriptive text that is displayed in the footer of the ToolTip for this control.
	ToolTipFooterImageSource	Gets or sets the image that is displayed in the footer of the ToolTip for this control.
	ToolTipFooterTitle	Gets or sets the title text that is displayed in the footer of the ToolTip for this control.
	ToolTipImageSource	Gets or sets the image that is displayed in the ToolTip for this control.
	ToolTipTitle	Gets or sets the title text that is displayed in the ToolTip for this control.

Top

Methods

	Name	Description
	AddDismissPopupHandler	Adds a handler for the DismissPopup attached event.
	GetCanAddToQuickAccessToolBarDirectly	Gets the value of the CanAddToQuickAccessToolBarDirectly attached property for an object.
	GetCheckedBackground	Gets the value of the CheckedBackground attached property for an object.
	GetCheckedBorderBrush	Gets the value of the CheckedBorderBrush attached property for an object.
	GetControlSizeDefinition	Gets the value of the ControlSizeDefinition attached property for an object.
	GetCornerRadius	Gets the value of the CornerRadius attached property for an object.
	GetDefaultControlSizeDefinition	Gets the value of the DefaultControlSizeDefinition attached property for an object.
	GetFocusedBackground	Gets the value of the FocusedBackground attached property for an object.
	GetFocusedBorderBrush	Gets the value of the FocusedBorderBrush attached property for an object.
	GetIsInControlGroup	Gets the value of the IsInControlGroup attached property for an object.
	GetIsInQuickAccessToolBar	Gets the value of the IsInQuickAccessToolBar attached property for an object.
	GetLabel	Gets the value of the Label attached property for an object.
	GetLargeImageSource	Gets the value of the LargeImageSource attached property for an object.
	GetMouseOverBackground	Gets the value of the MouseOverBackground attached property for an object.
	GetMouseOverBorderBrush	Gets the value of the MouseOverBorderBrush attached property for an object.
	GetPressedBackground	Gets the value of the PressedBackground attached property for an object.
	GetPressedBorderBrush	Gets the value of the PressedBorderBrush attached property for an object.
	GetQuickAccessToolBarControlSizeDefinition	Gets the value of the QuickAccessToolBarControlSizeDefinition attached property for an object.
	GetQuickAccessToolBarId	Gets the value of the QuickAccessToolBarId attached property for an object.
	GetRibbon	Gets the value of the Ribbon attached property for an object.
	GetShowKeyboardCues	Gets the value of the ShowKeyboardCues attached property for an object.
	GetSmallImageSource	Gets the value of the SmallImageSource attached property for an object.
	GetToolTipDescription	Gets the value of the ToolTipDescription attached property for an object.
	GetToolTipFooterDescription	Gets the value of the ToolTipFooterDescription attached property for an object.
	GetToolTipFooterImageSource	Gets the value of the ToolTipFooterImageSource attached property for an object.
	GetToolTipFooterTitle	Gets the value of the ToolTipFooterTitle attached property for an object.
	GetToolTipImageSource	Gets the value of the ToolTipImageSource attached property for an object.
	GetToolTipTitle	Gets the value of the ToolTipTitle attached property for an object.
	RemoveDismissPopupHandler	Removes a handler for the DismissPopup attached event.
	SetCanAddToQuickAccessToolBarDirectly	Sets the value of the CanAddToQuickAccessToolBarDirectly attached property for an object.
	SetCheckedBackground	Sets the value of the CheckedBackground attached property for an object.
	SetCheckedBorderBrush	Sets the value of the CheckedBorderBrush attached property for an object.
	SetControlSizeDefinition	Sets the value of the ControlSizeDefinition attached property for an object.
	SetCornerRadius	Sets the value of the CornerRadius attached property for an object.
	SetDefaultControlSizeDefinition	Sets the value of the DefaultControlSizeDefinition attached property for an object.
	SetFocusedBackground	Sets the value of the FocusedBackground attached property for an object.
	SetFocusedBorderBrush	Sets the value of the FocusedBorderBrush attached property for an object.
	SetLabel	Sets the value of the Label attached property for an object.
	SetLargeImageSource	Sets the value of the LargeImageSource attached property for an object.
	SetMouseOverBackground	Sets the value of the MouseOverBackground attached property for an object.
	SetMouseOverBorderBrush	Sets the value of the MouseOverBorderBrush attached property for an object.
	SetPressedBackground	Sets the value of the PressedBackground attached property for an object.
	SetPressedBorderBrush	Sets the value of the PressedBorderBrush attached property for an object.
	SetQuickAccessToolBarControlSizeDefinition	Sets the value of the QuickAccessToolBarControlSizeDefinition attached property for an object.
	SetQuickAccessToolBarId	Sets the value of the QuickAccessToolBarId attached property for an object.
	SetSmallImageSource	Sets the value of the SmallImageSource attached property for an object.
	SetToolTipDescription	Sets the value of the ToolTipDescription attached property for an object.
	SetToolTipFooterDescription	Sets the value of the ToolTipFooterDescription attached property for an object.
	SetToolTipFooterImageSource	Sets the value of the ToolTipFooterImageSource attached property for an object.
	SetToolTipFooterTitle	Sets the value of the ToolTipFooterTitle attached property for an object.
	SetToolTipImageSource	Sets the value of the ToolTipImageSource attached property for an object.
	SetToolTipTitle	Sets the value of the ToolTipTitle attached property for an object.

Top

Attached Events

	Name	Description
	DismissPopup	Occurs when a ribbon popup is closed.

Top

Fields

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

Top

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.

Share via