RibbonButton 介面

發行項
08/12/2011

表示自訂功能區上的按鈕。

命名空間： Microsoft.Office.Tools.Ribbon
組件： Microsoft.Office.Tools.Common (在 Microsoft.Office.Tools.Common.dll 中)

語法

'宣告
<GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")> _
Public Interface RibbonButton _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

RibbonButton 型別會公開下列成員。

屬性

	名稱	說明
	ControlSize	取得或設定按鈕的大小。
	Description	取得或設定當功能表的 ItemSize 屬性設定為 Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge 時，顯示在功能表的這個按鈕上的文字。
	Enabled	取得或設定值，指出此 RibbonControl 是否已啟用。 (繼承自 RibbonControl)。
	Id	取得 Microsoft Office 用來識別這個 RibbonControl 物件的字串。 (繼承自 RibbonControl)。
	Image	取得或設定顯示在按鈕上的影像。
	ImageName	取得或設定可在 LoadImage 事件處理常式中用來識別按鈕的名稱。
	KeyTip	取得或設定按鈕的鍵盤快速鍵。
	Label	取得或設定顯示在按鈕上的文字。
	Name	取得或設定這個 RibbonComponent 的名稱。 (繼承自 RibbonComponent)。
	OfficeImageId	取得或設定要顯示在按鈕上的影像 (如果您想要使用內建 Microsoft Office 圖示的話)。
	Parent	取得 RibbonComponent，表示這個 RibbonComponent 的父代 (Parent)。 (繼承自 RibbonComponent)。
	Position	取得或設定按鈕的位置 (如果按鈕在 Microsoft Office 功能表上的話)。
	Ribbon	取得包含控制項階層架構的最上層 Ribbon 物件。 (繼承自 RibbonComponent)。
	RibbonUI	基礎架構。取得 Microsoft Office 應用程式提供給功能區擴充性程式碼的 IRibbonUI 執行個體。 (繼承自 RibbonComponent)。
	ScreenTip	取得或設定當使用者將游標移至按鈕上方時所顯示的工具提示文字。
	ShowImage	取得或設定值，指出與按鈕關聯的影像是否可見。
	ShowLabel	取得或設定值，指出按鈕的標籤是否可見。
	Site	取得或設定與 IComponent 相關聯的 ISite。 (繼承自 IComponent)。
	SuperTip	取得或設定當使用者將游標移至按鈕上方時所顯示的多行提示文字。
	Tag	取得或設定與這個 RibbonComponent 關聯的應用程式特定資料。 (繼承自 RibbonComponent)。
	Visible	取得或設定值，指出此 RibbonControl 是否為可見的。 (繼承自 RibbonControl)。

回頁首

方法

	名稱	說明
	Dispose	執行與釋放 (Free)、釋放 (Release) 或重設 Unmanaged 資源相關聯之應用程式定義的工作。 (繼承自 IDisposable)。
	PerformDynamicLayout	如果 RibbonComponent 具有像是動態功能表的動態父代 (Parent)，而且配置未暫止，請呼叫父控制項的 Microsoft.Office.Core.IRibbonUI.InvalidateControl 方法。 (繼承自 RibbonComponent)。
	PerformLayout	如果 RibbonComponent 具有父代且配置未暫止，則會呼叫 Microsoft.Office.Core.IRibbonUI.InvalidateControl。 (繼承自 RibbonComponent)。
	ResumeLayout()	回復 SuspendLayout 方法的效果。 (繼承自 RibbonComponent)。
	ResumeLayout(Boolean)	回復 SuspendLayout 方法的效果。 (繼承自 RibbonComponent)。
	SuspendLayout	防止 Microsoft Office 應用程式重新整理功能區上控制項的狀態。 (繼承自 RibbonComponent)。

回頁首

事件

	名稱	說明
	Click	會在使用者按一下按鈕時發生。
	Disposed	表示處理元件的 Disposed 事件的方法。 (繼承自 IComponent)。

回頁首

備註

當您將 [按鈕] 控制項從 [工具箱] 的 [Office 功能區控制項] 索引標籤拖曳至功能區設計工具時，Visual Studio 會建立實作 RibbonButton 介面的類別執行個體。

您也可以在執行階段時建立這個控制項的執行個體，並加入至動態功能表中。如果您將功能表的 Dynamic 屬性設定為 true，就是動態的功能表。

這個控制項的某些屬性只能在功能區載入至 Office 應用程式前進行設定，或在執行階段控制項加入至動態功能表之前進行設定。如需這些屬性的設定資訊，請參閱功能區物件模型概觀。

您可以在執行階段中使用 RibbonFactory 物件的 CreateRibbonButton 方法建立 RibbonButton。

有兩種方法可以存取 RibbonFactory 物件：

使用功能區類別的 Factory 屬性。請從功能區類別中的程式碼使用此方法。
使用 Globals.Factory.GetRibbonFactory 方法。請從功能區類別外的程式碼使用此方法。

一般工作

下表列出適用於一般工作的成員。

工作	成員
在執行階段，將按鈕加入至其 Dynamic 屬性設定為 true 的功能表。	建立類別的執行個體，該類別會使用 CreateRibbonButton 來實作 RibbonButton 介面。 RibbonFactory 類別的方法。如需詳細資訊，請參閱全域存取 Office 專案中的物件。將執行個體加入至功能表的 Items 集合。
變更按鈕的大小。	將 ControlSize 設定為您想要的值。例如，對於大型按鈕，將它設定為 Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge。
在按鈕上顯示影像。	有三種方式可以顯示影像：使用 Image 屬性。這個屬性提供最大的控制能力。將 OfficeImageId 設定為您要當做按鈕圖示顯示之內建 Microsoft Office 影像的 ID。將 ImageName 屬性與 LoadImage 事件一起使用。這個屬性可以提升一些效能。
停用或隱藏按鈕。	若要停用按鈕，請將 Enabled 設定為 false。若要隱藏按鈕，請將 Visible 設定為 false。
在使用者按一下按鈕時執行程式碼。	將程式碼加入至 Click 事件處理常式。

注意事項
此介面是由 Visual Studio Tools for Office Runtime 所實作，並不能實作於您的程式碼中。如需詳細資訊，請參閱 Visual Studio Tools for Office Runtime 概觀。

使用方式

本文件說明此型別用於以 .NET Framework 4 為目標之 Office 專案的版本。在以 .NET Framework 3.5 為目標的專案中，此型別可能會有不同的成員，而為此型別提供的程式碼範例可能無法運作。如需此型別在以 .NET Framework 3.5 為目標之專案中的相關文件，請參閱下列 Visual Studio 2008 文件中的參考章節：https://go.microsoft.com/fwlink/?LinkId=160658 (英文)。

範例

下列範例會建立新按鈕、設定按鈕的各種屬性，然後將按鈕加入至功能表。若要執行這個程式碼範例，您必須先執行下列步驟：

將 [功能區 (視覺化設計工具)] 項目加入至在 Visual Studio 中使用 Office 開發工具建立的專案。
將群組加入至自訂索引標籤。
將功能表加入至群組。
將功能表的 [Dynamic] 屬性設定為 true。
將功能表的 [ItemSize] 屬性設定為 RibbonControlSizeLarge。

Private Sub AddButtonsToMenu()
    Dim tempButton = Me.Factory.CreateRibbonButton()
    tempButton.Label = "Button 1"
    tempButton.ControlSize = _
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge
    tempButton.Description = "My Ribbon Button"
    tempButton.ShowImage = True
    tempButton.ShowImage = True
    tempButton.Image = My.Resources.Image1
    tempButton.Image = My.Resources.Image2
    tempButton.KeyTip = "A1"
    menu1.Items.Add(tempButton)
End Sub

private void AddButtonsToMenu()
{
    RibbonButton tempButton = this.Factory.CreateRibbonButton();
    tempButton.Label = "Button 1";
    tempButton.ControlSize =
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge;
    tempButton.Description = "My Ribbon Button";
    tempButton.ShowImage = true;
    tempButton.ShowImage = true;
    tempButton.Image = Properties.Resources.Image1;
    tempButton.Image = Properties.Resources.Image2;
    tempButton.KeyTip = "A1";
    menu1.Items.Add(tempButton);

}