Export (0) Print
Expand All

RibbonCheckBox Interface

Represents a check box control on a Ribbon.

Namespace:  Microsoft.Office.Tools.Ribbon
Assembly:  Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)

[GuidAttribute("2119eecb-0ee2-4a64-8b87-b76bd1fa395e")]
public interface RibbonCheckBox : RibbonControl, 
	RibbonComponent, IComponent, IDisposable

The RibbonCheckBox type exposes the following members.

  NameDescription
Public propertyCheckedGets or sets a value that indicates whether this RibbonCheckBox is checked.
Public propertyDescriptionGets or sets a description for this RibbonCheckBox that appears when its parent control's ItemSize property is set to RibbonControlSizeLarge.
Public propertyEnabledGets or sets a value that indicates whether this RibbonControl is enabled. (Inherited from RibbonControl.)
Public propertyIdGets a string that Microsoft Office uses to identify this RibbonControl object. (Inherited from RibbonControl.)
Public propertyKeyTipGets or sets the keyboard shortcut for this RibbonCheckBox.
Public propertyLabelGets or sets the text that appears on this RibbonCheckBox.
Public propertyNameGets or sets the name of this RibbonComponent. (Inherited from RibbonComponent.)
Public propertyParentGets a RibbonComponent that represents the parent of this RibbonComponent. (Inherited from RibbonComponent.)
Public propertyPositionGets or sets the position of the check box, if the checkbox is on the Microsoft Office Menu.
Public propertyRibbonGets the top-level Ribbon object that contains the control hierarchy. (Inherited from RibbonComponent.)
Public propertyRibbonUIInfrastructure. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code. (Inherited from RibbonComponent.)
Public propertyScreenTipGets or sets tip text that appears when the user moves the pointer over the RibbonCheckBox.
Public propertySiteGets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public propertySuperTipGets or sets multiline tip text that appears when the user moves the pointer over the RibbonCheckBox.
Public propertyTagGets or sets application-specific data that is associated with this RibbonComponent. (Inherited from RibbonComponent.)
Public propertyVisibleGets or sets a value that indicates whether this RibbonControl is visible. (Inherited from RibbonControl.)
Top

  NameDescription
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public methodPerformDynamicLayoutCalls the Microsoft.Office.Core.IRibbonUI.InvalidateControl method of the parent control if the RibbonComponent has a dynamic parent, such as a dynamic menu, and layout is not suspended. (Inherited from RibbonComponent.)
Public methodPerformLayoutCalls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended. (Inherited from RibbonComponent.)
Public methodResumeLayout()Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.)
Public methodResumeLayout(Boolean)Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.)
Public methodSuspendLayoutPrevents the Microsoft Office application from refreshing the state of controls on the Ribbon. (Inherited from RibbonComponent.)
Top

  NameDescription
Public eventClickOccurs when a user clicks the check box.
Public eventDisposedRepresents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Top

You can create an instance of this control at run time and add it to a dynamic menu. A menu is dynamic if you set its Dynamic property to true.

Some properties of this control can be set only before the Ribbon is loaded into the Office application or before the control is added to a dynamic menu at run time. For information about setting these properties, see Ribbon Object Model Overview.

You can create a RibbonCheckBox at run time by using the CreateRibbonCheckBox method of the RibbonFactory object.

There are two ways to access the RibbonFactory object:

  • By using the Factory property of the Ribbon class. Use this approach from code in your Ribbon class.

  • By using the Globals.Factory.GetRibbonFactory method. Use this approach from code outside your Ribbon class.

NoteNote

This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.

Usage

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: http://go.microsoft.com/fwlink/?LinkId=160658.

Community Additions

ADD
Show:
© 2014 Microsoft