Interfejs RibbonButton

Artykuł
01/08/2014

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	Zwraca 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	Pobiera lub ustawia wartość wskazującą, czy to RibbonControl jest włączona. (Odziedziczone z RibbonControl).
	Id	Pobiera ciąg, program Microsoft Office używa się do identyfikacji, 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 program obsługi zdarzeń.
	KeyTip	Pobiera lub ustawia skrót klawiaturowy przycisku.
	Label	Pobiera lub ustawia tekst wyświetlany na przycisku.
	Name	Pobiera lub ustawia nazwę tego RibbonComponent. (Odziedziczone z RibbonComponent).
	OfficeImageId	Pobiera lub ustawia obraz wyświetlany na przycisku, jeśli chcesz użyć wbudowanego ikonę programu Microsoft Office.
	Parent	Pobiera RibbonComponent reprezentująca nadrzędny to RibbonComponent. (Odziedziczone z RibbonComponent).
	Position	Pobiera lub ustawia pozycję przycisku, jeśli przycisk jest w Menu programu Microsoft Office.
	Ribbon	Pobiera najwyższego poziomu Ribbon obiekt, który zawiera hierarchię kontroli. (Odziedziczone z RibbonComponent).
	RibbonUI	Infrastruktura. Pobiera IRibbonUI instancji, która jest dostarczana przez aplikacji Microsoft Office do kodu rozszerzalność wstążki. (Odziedziczone z RibbonComponent).
	ScreenTip	Pobiera lub ustawia tekst etykietki narzędzia, która pojawia się, gdy użytkownik przesuwa wskaźnik nad przyciskiem.
	ShowImage	Pobiera lub ustawia wartość wskazującą, czy jest widoczny obraz skojarzony z przyciskiem.
	ShowLabel	Pobiera lub ustawia wartość wskazującą, czy etykiety 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 nad przyciskiem.
	Tag	Pobiera lub ustawia dane specyficzne dla aplikacji, która jest skojarzona z tym RibbonComponent. (Odziedziczone z RibbonComponent).
	Visible	Pobiera lub ustawia wartość wskazującą, czy to RibbonControl jest widoczny. (Odziedziczone z RibbonControl).

Początek

Metody

	Nazwa	Opis
	Dispose	Wykonuje zadania zdefiniowane przez aplikację skojarzone z uwalnianiem, zwalnianiem lub resetowaniem 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()	Cofa efekt SuspendLayout metody. (Odziedziczone z RibbonComponent).
	ResumeLayout(Boolean)	Cofa efekt SuspendLayout metody. (Odziedziczone z RibbonComponent).
	SuspendLayout	Zapobiega aplikacji Microsoft Office odświeżania stanu 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óra implementuje RibbonButton interfejsu podczas przeciągania przycisk sterowania z Formanty wstążki Office na karcie Przybornik na projektanta wstążki.

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

Niektóre właściwości tego formantu można ustawić tylko przed Wstążka jest ładowany 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 Model obiektu Wstążka ― Omówienie.

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żyj tego podejścia do kodu w klasie wstążki.
Za pomocą Globals.Factory.GetRibbonFactory metody.Użyj tego podejścia do 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 jej Dynamic właściwość jest ustawiona na wartość true.	Tworzenie instancji klasy, która 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.
Zmienianie rozmiaru przycisku.	Ustaw ControlSize ma wartość.Na przykład, dla dużych przycisków, ustaw ją na Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Wyświetlić obraz 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 to identyfikator wbudowanego obrazu Microsoft Office, który chcesz wyświetlić jako ikonę przycisku. Użycie ImageName właściwość wraz z LoadImage zdarzenia.Właściwość ta daje niektórych zalet związanych z wydajnością.
Wyłączyć lub ukryć przyciski.	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 program 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 for Office Runtime ― Przegląd.

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:

Dodaj wstążki (wizualnego projektowania) element do projektu utworzone za pomocą narzędzi programistycznych pakietu Office w programie Visual Studio.
Dodaj grupę na karcie 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);

}