Dela via


RibbonButton Members (2007 System)

Include Protected Members
Include Inherited Members

Represents a button on a custom Ribbon.

The RibbonButton type exposes the following members.

Constructors

 

Name

Description

Public method

RibbonButton

Initializes a new instance of the RibbonButton class.

Top

Methods

 

Name

Description

Public method

CreateObjRef

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)

Public method

Dispose

Overloaded. Releases the resources used by the Component.

Public method

Equals

Determines whether the specified Object is equal to the current Object. (Inherited from Object.)

Protected method

Finalize

Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)

Public method

GetHashCode

Serves as a hash function for a particular type. (Inherited from Object.)

Public method

GetLifetimeService

Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)

Protected method

GetService

Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)

Public method

GetType

Gets the type of the current instance. (Inherited from Object.)

Public method

InitializeLifetimeService

Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)

Protected method

MemberwiseClone

Overloaded.

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

Overloaded. Reverses the effect of the SuspendLayout method.

Public method

SuspendLayout

Prevents the Microsoft Office application from refreshing the state of controls on the Ribbon. (Inherited from RibbonComponent.)

Public method

ToString

Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)

Top

Properties

 

Name

Description

Protected property

CanRaiseEvents

Gets a value indicating whether the component can raise an event. (Inherited from Component.)

Public property

Container

Gets the IContainer that contains the Component. (Inherited from Component.)

Public property

ControlSize

Gets or sets the size of the button.

Public property

Description

Gets or sets the text that appears on this button in a menu when the ItemSize property of the menu is set to Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.

Protected property

DesignMode

Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)

Public property

Enabled

Gets or sets a value that indicates whether this RibbonControl is enabled. (Inherited from RibbonControl.)

Protected property

Events

Gets the list of event handlers that are attached to this Component. (Inherited from Component.)

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 button.

Public property

ImageName

Gets or sets the name that you can use to identify the button in the LoadImage event handler.

Public property

KeyTip

Gets or sets the keyboard shortcut of the button.

Public property

Label

Gets or sets the text that is displayed on the button.

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 button, 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 button, if the button 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 button.

Public property

ShowImage

Gets or sets a value that indicates whether the image that is associated with the button is visible.

Public property

ShowLabel

Gets or sets a value that indicates whether the label for the button is visible.

Public property

Site

Gets or sets the ISite of the Component. (Inherited from Component.)

Public property

SuperTip

Gets or sets multiline tip text that appears when the user moves the pointer over the button.

Public property

Tag

Gets or sets application-specific data that is associated with this RibbonComponent. (Inherited from RibbonComponent.)

Public property

Visible

Gets or sets a value that indicates whether this RibbonControl is visible. (Inherited from RibbonControl.)

Top

Events

 

Name

Description

Public event

Click

Occurs when the user clicks the button.

Public event

Disposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

Top

See Also

Reference

RibbonButton Class

Microsoft.Office.Tools.Ribbon Namespace