Interfejs RibbonButton

Artykuł
05/08/2013

Reprezentuje przycisk na Wstążce niestandardowej.

Przestrzeń nazw: Microsoft.Office.Tools.Ribbon
Zestaw: Microsoft.Office.Tools.Common (w Microsoft.Office.Tools.Common.dll)

Składnia

'Deklaracja
<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

Typ RibbonButton uwidacznia następujące elementy członkowskie.

Właściwości

	Nazwa	Opis
	ControlSize	Pobiera lub ustawia rozmiar przycisku.
	Description	Pobiera lub ustawia tekst pojawiający się na ten przycisk w menu po ItemSize właściwość menu jest ustawiona na Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
	Enabled	Zwraca lub ustawia wartość, która wskazuje, czy to RibbonControl jest włączone. (Odziedziczone z RibbonControl).
	Id	Pobiera ciąg, który używa programu Microsoft Office, aby określić to RibbonControl obiektu. (Odziedziczone z RibbonControl).
	Image	Pobiera lub ustawia obraz, który jest wyświetlany na przycisku.
	ImageName	Pobiera lub ustawia nazwę, która służy do identyfikacji przycisku w LoadImage programu obsługi zdarzeń.
	KeyTip	Pobiera lub ustawia skrót klawiaturowy przycisku.
	Label	Pobiera lub ustawia tekst, który jest wyświetlany na przycisku.
	Name	Pobiera lub ustawia nazwę tego RibbonComponent. (Odziedziczone z RibbonComponent).
	OfficeImageId	Pobiera lub ustawia obraz wyświetlany na przycisku, aby użyć wbudowanego ikony programu Microsoft Office.
	Parent	Pobiera RibbonComponent , oznaczającą nadrzędny to RibbonComponent. (Odziedziczone z RibbonComponent).
	Position	Pobiera lub Ustawia położenie przycisku, jeśli jest przycisk menu programu Microsoft Office.
	Ribbon	Pobiera najwyższego poziomu Ribbon obiekt, który zawiera hierarchii kontrolek. (Odziedziczone z RibbonComponent).
	RibbonUI	Infrastruktura. Pobiera IRibbonUI instancji, która jest dostarczonej wraz z aplikacją Microsoft Office do kodu rozszerzalność wstążki. (Odziedziczone z RibbonComponent).
	ScreenTip	Pobiera lub ustawia tekst elementu tooltip, który pojawia się, kiedy użytkownik przesuwa wskaźnik myszy nad przyciskiem.
	ShowImage	Pobiera lub ustawia wartość, która wskazuje, czy obraz, który jest skojarzony z przyciskiem jest widoczny.
	ShowLabel	Pobiera lub ustawia wartość, która wskazuje, czy etykieta dla przycisku jest widoczny.
	Site	Zwraca lub ustawia ISite związane z IComponent. (Odziedziczone z IComponent).
	SuperTip	Pobiera lub ustawia tekst wielowierszowy porady, który pojawia się, gdy użytkownik przesuwa wskaźnik myszy nad przyciskiem.
	Tag	Pobiera lub ustawia dane specyficzne dla aplikacji, która jest skojarzona z tym RibbonComponent. (Odziedziczone z RibbonComponent).
	Visible	Zwraca lub ustawia wartość, która wskazuje, czy to RibbonControl jest widoczny. (Odziedziczone z RibbonControl).

Początek

Metody

	Nazwa	Opis
	Dispose	Wykonuje zadania zdefiniowane aplikacji skojarzonej z zwalniania, zwalnianie lub resetowanie niezarządzanych zasobów. (Odziedziczone z IDisposable).
	PerformDynamicLayout	Wywołania Microsoft.Office.Core.IRibbonUI.InvalidateControl metoda nadrzędnego kontroli, jeśli RibbonComponent ma element nadrzędny dynamicznych, takich jak menu dynamiczne, i układ nie jest zawieszony. (Odziedziczone z RibbonComponent).
	PerformLayout	Wywołania Microsoft.Office.Core.IRibbonUI.InvalidateControl Jeśli RibbonComponent ma element nadrzędny i układ nie jest zawieszony. (Odziedziczone z RibbonComponent).
	ResumeLayout()	Odwraca efekt SuspendLayout metoda. (Odziedziczone z RibbonComponent).
	ResumeLayout(Boolean)	Odwraca efekt SuspendLayout metoda. (Odziedziczone z RibbonComponent).
	SuspendLayout	Zapobiega zastosowaniu programu Microsoft Office z odświeżanie stan formantów na Wstążce. (Odziedziczone z RibbonComponent).

Początek

Zdarzenia

	Nazwa	Opis
	Click	Występuje, gdy użytkownik kliknie przycisk.
	Disposed	Metoda, która obsługuje reprezentuje Disposed zdarzeń składnika. (Odziedziczone z IComponent).

Początek

Uwagi

Visual Studio tworzy instancję klasy, który implementuje RibbonButton interfejs podczas przeciągania przycisk kontrolować z Formanty wstążki pakietu Office karta Przybornik na projektanta wstążki.

Można również utworzyć wystąpienie tego formantu w czasie wykonywania i dodać do menu dynamiczne.Menu jest dynamiczne, jeśli ustawisz jego Dynamic właściwość, aby true.

Niektóre właściwości tego formantu można ustawić, tylko w przypadku, przed załadowaniem wstążki do aplikacji pakietu Office lub zanim formant zostanie dodane do menu dynamiczne w czasie wykonywania.Aby uzyskać informacje o ustawianiu tych właściwości, zobacz Omówienie modelu obiektu wstążki.

Można utworzyć RibbonButton w czasie wykonywania za pomocą CreateRibbonButton metoda RibbonFactory obiektu.

Istnieją dwa sposoby dostępu do RibbonFactory obiekt:

Za pomocą Factory właściwość klasy wstążki.Użyć tej metody z kodu w klasie wstążki.
Za pomocą Globals.Factory.GetRibbonFactory metoda.Użyj tego podejścia od kodu poza klasy wstążki.

Typowe zadania

Poniższa lista zawiera elementy członkowskie, które są przydatne do wykonywania typowych zadań.

Zadanie	Członek
W czasie wykonywania, należy dodać przycisk do menu, które ma jego Dynamic właściwość jest ustawiona na wartość true.	Tworzenie instancji klasy, który implementuje RibbonButton interfejsu za pomocąCreateRibbonButton Metoda RibbonFactory klasy.Aby uzyskać więcej informacji, zobacz Globalny dostęp do obiektów w projektach pakietu Office. Dodawanie wystąpienia do menu Items kolekcji.
Zmienić rozmiar przycisku.	Ustaw ControlSize na wartość, która ma.Na przykład, za duży przycisk, ustaw ją na Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Wyświetlanie obrazu na przycisku.	Istnieją trzy sposoby wyświetlania obrazu: Użyj właściwości Image.Właściwość ta daje największą kontrolę. Ustaw OfficeImageId do Identyfikatora wbudowany obraz programu Microsoft Office, który ma być wyświetlany jako ikonę przycisku. Użycie ImageName właściwość wraz z LoadImage zdarzenia.Właściwość ta daje pewne korzyści w wydajności.
Wyłączanie lub ukrywanie przycisków.	Aby wyłączyć przycisk, ustaw Enabled do false. Aby ukryć przycisk, ustaw Visible do false.
Uruchomienie kodu, gdy użytkownik kliknie przycisk.	Dodaj kod, aby Click programu obsługi zdarzeń.

[!UWAGA]

Ten interfejs jest implementowany przez Visual Studio Tools for Office Runtime. Nie jest on przeznaczony do implementacji w kodzie. Aby uzyskać więcej informacji, zobacz Visual Studio Tools dla pakietu Office, omówienie Runtime.

Użycie

W dokumentacji opisano wersję typu używanego w projektach dla pakietu Office przeznaczonych do pracy z programem .NET Framework 4 i .NET Framework 4.5. W projektach przeznaczonych do pracy z programem .NET Framework 3.5 ten typ może mieć inne elementy członkowskie, a przykładowy kod podany dla tego typu może nie działać. Aby uzyskać dokumentację tego typu używanego w projektach przeznaczonych do działania z programem .NET Framework 3.5, zobacz następującą sekcję informacyjną w dokumentacji programu Visual Studio 2008: https://go.microsoft.com/fwlink/?LinkId=160658.

Przykłady

Poniższy przykład tworzy nowy przycisk, ustawia różne właściwości przycisku i następnie dodaje przycisk do menu.Aby uruchomić ten przykład kodu, należy najpierw wykonać następujące czynności:

Dodać wstążki (Visual Designer) element, aby projekt utworzony przy użyciu narzędzia programowania pakietu Office w programie Visual Studio.
Dodaj grupę do karty niestandardowe.
Dodawanie menu do grupy.
Ustaw dynamiczne właściwość menu Aby true.
Ustaw ItemSize właściwość menu Aby 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);

}