RibbonButton Interfejs

Odwołanie

Definicja

Przestrzeń nazw:: Microsoft.Office.Tools.Ribbon

Zestaw:: Microsoft.Office.Tools.Common.dll

Ważne

Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.

Reprezentuje przycisk na niestandardowej wstążce.

public interface class RibbonButton : IDisposable, Microsoft::Office::Tools::Ribbon::RibbonControl, System::ComponentModel::IComponent

[System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")>]
type RibbonButton = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonButton
Implements IComponent, IDisposable, RibbonControl

Atrybuty: GuidAttribute

Implementuje: RibbonComponent RibbonControl IComponent IDisposable

Przykłady

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

Dodaj element wstążki (Visual Projektant) do projektu utworzonego przy użyciu narzędzi programistycznych pakietu Office w programie Visual Studio.
Dodaj grupę do niestandardowej karty.
Dodaj menu do grupy.
Ustaw właściwość Dynamic menu na truewartość .
Ustaw właściwość ItemSize menu na RibbonControlSizeLarge.

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);

}

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

Uwagi

Program Visual Studio tworzy wystąpienie klasy, która implementuje RibbonButton interfejs podczas przeciągania kontrolki Przycisk z karty Kontrolki wstążki pakietu Office przybornika na Projektant wstążki.

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

Niektóre właściwości tej kontrolki można ustawić tylko przed załadowaniem wstążki do aplikacji pakietu Office lub przed dodaniu kontrolki do menu dynamicznego w czasie wykonywania. Aby uzyskać informacje na temat ustawiania tych właściwości, zobacz Temat Omówienie modelu obiektów wstążki.

Obiekt można utworzyć RibbonButton w czasie wykonywania przy użyciu CreateRibbonButton metody RibbonFactory obiektu .

Istnieją dwa sposoby uzyskiwania RibbonFactory dostępu do obiektu:

Za pomocą Factory właściwości klasy Wstążki. Użyj podejścia z kodu w klasie wstążki.
Przy użyciu Globals.Factory.GetRibbonFactory metody . Użyj podejścia do kodu spoza klasy wstążki.

Typowe zadania

W poniższej tabeli wymieniono elementy członkowskie, które są przydatne w przypadku typowych zadań.

Zadanie	Członek
W czasie wykonywania dodaj przycisk do menu, które ma ustawioną Dynamic właściwość true.	Tworzenie wystąpienia klasy implementujące RibbonButton interfejs przy użyciu elementu CreateRibbonButton RibbonFactory metoda klasy . Aby uzyskać więcej informacji, zobacz Globalny dostęp do obiektów w projektach pakietu Office. Dodaj wystąpienie do kolekcji `Items` menu.
Zmień rozmiar przycisku.	Ustaw ControlSize odpowiednią wartość. Na przykład w przypadku dużego przycisku ustaw go na `Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge`wartość .
Wyświetl obraz na przycisku.	Istnieją trzy sposoby wyświetlania obrazu: - Użyj Image właściwości . Ta właściwość zapewnia największą kontrolę. — Ustaw OfficeImageId identyfikator wbudowanego obrazu pakietu Microsoft Office, który chcesz wyświetlić jako ikonę przycisku. - Użyj ImageName właściwości wraz ze zdarzeniem LoadImage . Ta właściwość zapewnia pewne korzyści z wydajności.
Wyłącza lub ukrywa przyciski.	Aby wyłączyć przycisk, ustaw wartość Enabled`false`. Aby ukryć przycisk, ustaw wartość Visible`false`.
Uruchom kod, gdy użytkownik kliknie przycisk.	Dodaj kod do programu obsługi zdarzeń Click .

Uwaga

Ten interfejs jest wdrażany przy użyciu programu Visual Studio Tools for Office Runtime. Nie jest on przeznaczony do implementacji w kodzie. Aby uzyskać więcej informacji, zobacz omówienie środowiska uruchomieniowego Visual Studio Tools dla pakietu Office.

Użycie

W tej dokumentacji opisano wersję tego typu używaną tylko w projektach pakietu Office przeznaczonych dla platformy .NET Framework 4 i nowszych. 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ę dotyczącą tego typu projektów przeznaczonych dla .NET Framework 3.5, zobacz następującą sekcję referencyjną w dokumentacji programu Visual Studio 2008: http://go.microsoft.com/fwlink/?LinkId=160658.

Właściwości

ControlSize	Pobiera lub ustawia rozmiar przycisku.
Description	Pobiera lub ustawia tekst wyświetlany na tym przycisku w menu, gdy ItemSize właściwość menu jest ustawiona na Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Enabled	Pobiera lub ustawia wartość wskazującą, czy jest to RibbonControl włączone. (Odziedziczone po RibbonControl)
Id	Pobiera ciąg używany przez pakiet Microsoft Office do identyfikowania tego RibbonControl obiektu. (Odziedziczone po RibbonControl)
Image	Pobiera lub ustawia obraz wyświetlany na przycisku.
ImageName	Pobiera lub ustawia nazwę, której można użyć do identyfikowania przycisku w procedurze obsługi zdarzeń LoadImage .
KeyTip	Pobiera lub ustawia skrót klawiaturowy przycisku.
Label	Pobiera lub ustawia tekst wyświetlany na przycisku.
Name	Pobiera lub ustawia nazwę tego RibbonComponentelementu . (Odziedziczone po RibbonComponent)
OfficeImageId	Pobiera lub ustawia obraz do wyświetlenia na przycisku, jeśli chcesz użyć wbudowanej ikony pakietu Microsoft Office.
Parent	Pobiera element RibbonComponent reprezentujący element nadrzędny tego RibbonComponentobiektu . (Odziedziczone po RibbonComponent)
Position	Pobiera lub ustawia położenie przycisku, jeśli przycisk znajduje się w menu pakietu Microsoft Office.
Ribbon	Pobiera obiekt najwyższego poziomu Ribbon zawierający hierarchię sterowania. (Odziedziczone po RibbonComponent)
RibbonUI	Pobiera wystąpienie IRibbonUI udostępniane przez aplikację pakietu Microsoft Office do kodu rozszerzalności wstążki. (Odziedziczone po RibbonComponent)
ScreenTip	Pobiera lub ustawia tekst etykietki narzędzia wyświetlany podczas przesuwania wskaźnika przez przycisk.
ShowImage	Pobiera lub ustawia wartość wskazującą, czy obraz skojarzony z przyciskiem jest widoczny.
ShowLabel	Pobiera lub ustawia wartość wskazującą, czy etykieta przycisku jest widoczna.
SuperTip	Pobiera lub ustawia tekst wielowierszowej porady, który pojawia się, gdy użytkownik przesuwa wskaźnik nad przyciskiem.
Tag	Pobiera lub ustawia dane specyficzne dla aplikacji, które są skojarzone z tym RibbonComponent. (Odziedziczone po RibbonComponent)
Visible	Pobiera lub ustawia wartość wskazującą, czy jest ona RibbonControl widoczna. (Odziedziczone po RibbonControl)

Metody

PerformDynamicLayout()	Wywołuje metodę Microsoft.Office.Core.IRibbonUI.InvalidateControl kontrolki nadrzędnej, jeśli RibbonComponent obiekt ma dynamiczny element nadrzędny, taki jak menu dynamiczne, i układ nie jest zawieszony. (Odziedziczone po RibbonComponent)
PerformLayout()	Wywołuje element Microsoft.Office.Core.IRibbonUI.InvalidateControl, jeśli RibbonComponent obiekt ma element nadrzędny i układ nie jest zawieszony. (Odziedziczone po RibbonComponent)
ResumeLayout()	Odwraca efekt SuspendLayout() metody . (Odziedziczone po RibbonComponent)
ResumeLayout(Boolean)	Odwraca efekt SuspendLayout() metody . (Odziedziczone po RibbonComponent)
SuspendLayout()	Uniemożliwia aplikacji pakietu Microsoft Office odświeżanie stanu kontrolek na wstążce. (Odziedziczone po RibbonComponent)

Zdarzenia

Click

Występuje, gdy użytkownik kliknie przycisk.

Dotyczy

Udostępnij przez