RibbonSplitButton Interface

A Ribbon control that combines a button or a toggle button and a drop-down menu.

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

Syntax

'Declaration
<GuidAttribute("9d4c5611-01e0-4ad2-9614-8b9edaf6fe2c")> _
Public Interface RibbonSplitButton _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable
[GuidAttribute("9d4c5611-01e0-4ad2-9614-8b9edaf6fe2c")]
public interface RibbonSplitButton : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

The RibbonSplitButton type exposes the following members.

Properties

  Name Description
Public property ButtonEnabled Gets or sets a value that indicates whether the button on the RibbonSplitButton is enabled.
Public property ButtonType Gets or sets the type of the button on the RibbonSplitButton.
Public property Checked Gets or sets a value that indicates whether RibbonSplitButton is pressed or not pressed.
Public property ControlSize Gets or sets the size of the RibbonSplitButton control.
Public property Description Gets or sets the text that appears on this RibbonSplitButton control in a drop-down menu.
Public property Enabled Gets or sets a value that indicates whether this RibbonControl is enabled. (Inherited from RibbonControl.)
Public property Id Gets a string that Microsoft Office uses to identify this RibbonControl object. (Inherited from RibbonControl.)
Public property Image Gets or sets the image that is displayed on the control.
Public property ImageName Gets or sets the name that you can use in the E:Microsoft.Office.Tools.Ribbon.LoadImage event handler to identify an image for the control.
Public property Items Gets the collection of controls that are on this RibbonSplitButton.
Public property ItemSize Gets or sets the size of the controls on the RibbonSplitButton drop-down menu.
Public property KeyTip Gets or sets the keyboard shortcut of the RibbonSplitButton control.
Public property Label Gets or sets the text on the RibbonSplitButton control.
Public property Name Gets or sets the name of this RibbonComponent. (Inherited from RibbonComponent.)
Public property OfficeImageId Gets or sets the image to display on the RibbonSplitButton control, if you want to use a built-in Microsoft Office icon.
Public property Parent Gets a RibbonComponent that represents the parent of this RibbonComponent. (Inherited from RibbonComponent.)
Public property Position Gets or sets the position of the RibbonSplitButton control, if the control is on the Microsoft Office Menu.
Public property Ribbon Gets the top-level Ribbon object that contains the control hierarchy. (Inherited from RibbonComponent.)
Public property RibbonUI Infrastructure. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code. (Inherited from RibbonComponent.)
Public property ScreenTip Gets or sets tooltip text that appears when the user moves the pointer over the RibbonSplitButton control.
Public property ShowLabel Gets or sets a value that indicates whether the label for the RibbonSplitButton control is visible.
Public property Site Gets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public property SuperTip Gets or sets multiline tooltip text that appears when the user moves the pointer over the RibbonSplitButton control.
Public property Tag Gets or sets application-specific data that is associated with this RibbonComponent. (Inherited from RibbonComponent.)
Public property Title Gets or sets the title that appears on top of the RibbonSplitButton control if the control is on the Microsoft Office Menu.
Public property Visible Gets or sets a value that indicates whether this RibbonControl is visible. (Inherited from RibbonControl.)

Top

Methods

  Name Description
Public method Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method PerformDynamicLayout Calls 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 method PerformLayout Calls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended. (Inherited from RibbonComponent.)
Public method ResumeLayout() Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.)
Public method ResumeLayout(Boolean) Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.)
Public method SuspendLayout Prevents the Microsoft Office application from refreshing the state of controls on the Ribbon. (Inherited from RibbonComponent.)

Top

Events

  Name Description
Public event Click Occurs when the user clicks the RibbonSplitButton control.
Public event Disposed Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)

Top

Remarks

A RibbonSplitButton control combines a button or a toggle button and a drop-down menu. To choose between the button and toggle button, use the ButtonType property.

Unlike the RibbonMenu control, the RibbonSplitButton control does not have the Dynamic property, so contents of the Items collection cannot be changed at run time.

You can create a RibbonSplitButton at run time by using the CreateRibbonSplitButton 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.

Note

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.

See Also

Reference

Microsoft.Office.Tools.Ribbon Namespace

Other Resources

Ribbon Overview

Ribbon Designer

Ribbon Object Model Overview

How to: Get Started Customizing the Ribbon