RibbonButton – rozhraní

Článek
01/03/2014

Představuje tlačítko na vlastní pás karet.

Obor názvů: Microsoft.Office.Tools.Ribbon
Sestavení: Microsoft.Office.Tools.Common (v Microsoft.Office.Tools.Common.dll)

Syntaxe

'Deklarace
<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 zveřejňuje následující členy.

Vlastnosti

	Název	Popis
	ControlSize	Získá nebo nastaví velikost tlačítka.
	Description	Získá nebo nastaví text zobrazený na toto tlačítko v nabídce, když ItemSize nabídky je nastavena na Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
	Enabled	Získá nebo nastaví hodnotu, která označuje, zda tento RibbonControl je povoleno. (Zděděno z RibbonControl.)
	Id	Získá řetězec, který aplikace Microsoft Office používá k identifikaci tohoto RibbonControl objektu. (Zděděno z RibbonControl.)
	Image	Získá nebo nastaví bitová kopie zobrazený na tlačítku.
	ImageName	Získá nebo nastaví název používaný k identifikaci tlačítka v LoadImage obslužnou rutinu události.
	KeyTip	Získá nebo nastaví klávesová tlačítka.
	Label	Získá nebo nastaví text zobrazený na tlačítku.
	Name	Získá nebo nastaví název tohoto RibbonComponent. (Zděděno z RibbonComponent.)
	OfficeImageId	Získá nebo nastaví obrázek zobrazit na tlačítko, pokud chcete použít integrovanou ikonu Microsoft Office.
	Parent	Získá RibbonComponent , která představuje nadřazené tohoto RibbonComponent. (Zděděno z RibbonComponent.)
	Position	Získá nebo nastaví umístění tlačítka, pokud je tlačítko v nabídce Microsoft Office.
	Ribbon	Získá nejvyšší úrovně Ribbon objekt, který obsahuje hierarchii ovládacích prvků. (Zděděno z RibbonComponent.)
	RibbonUI	Infrastruktura. Získá IRibbonUI instance, která je k dispozici kódu rozšiřitelnost pásu karet aplikace Microsoft Office. (Zděděno z RibbonComponent.)
	ScreenTip	Získá nebo nastaví text popisku, který se zobrazí, když uživatel přesune ukazatel myši nad tlačítko.
	ShowImage	Získá nebo nastaví hodnotu, která označuje, zda je zobrazen obrázek, který je přidružen k tlačítku.
	ShowLabel	Získá nebo nastaví hodnotu, která označuje, zda je zobrazen popisek tlačítka.
	Site	Získá nebo nastaví ISite přidružené IComponent. (Zděděno z IComponent.)
	SuperTip	Získá nebo nastaví text víceřádkové tip, který se zobrazí, když uživatel přesune ukazatel myši nad tlačítko.
	Tag	Získá nebo nastaví specifická data spojená s tímto RibbonComponent. (Zděděno z RibbonComponent.)
	Visible	Získá nebo nastaví hodnotu, která označuje, zda tento RibbonControl je viditelná. (Zděděno z RibbonControl.)

Nahoru

Metody

	Název	Popis
	Dispose	Provádí úkoly definované aplikací, které jsou spojeny s uvolněním nebo obnovením nespravovaných prostředků. (Zděděno z IDisposable.)
	PerformDynamicLayout	Volání Microsoft.Office.Core.IRibbonUI.InvalidateControl metoda nadřazené řízení, pokud RibbonComponent má dynamické nadřazené, například dynamické nabídky a rozložení není pozastaven. (Zděděno z RibbonComponent.)
	PerformLayout	Volání Microsoft.Office.Core.IRibbonUI.InvalidateControl -li RibbonComponent s nadřízenou a rozložení není pozastaven. (Zděděno z RibbonComponent.)
	ResumeLayout()	Účinek se obrátí SuspendLayout metody. (Zděděno z RibbonComponent.)
	ResumeLayout(Boolean)	Účinek se obrátí SuspendLayout metody. (Zděděno z RibbonComponent.)
	SuspendLayout	Zabrání aktualizaci stavu ovládací prvky na pásu karet aplikace Microsoft Office. (Zděděno z RibbonComponent.)

Nahoru

Události

	Název	Popis
	Click	Dochází, když uživatel klepne na tlačítko.
	Disposed	Představuje metodu, která zpracovává Disposed události komponenty. (Zděděno z IComponent.)

Nahoru

Poznámky

Visual Studio vytvoří instanci třídy, která implementuje RibbonButton rozhraní při přetažení tlačítko ovládacího prvku Office pás karet prvky karty nástrojů na pás karet Designer.

Můžete také vytvořit instanci tohoto ovládacího prvku v době běhu a přidat do dynamické nabídky.Nabídka je dynamická, nastavíte-li jeho Dynamic vlastnost true.

Některé vlastnosti tohoto ovládacího prvku lze nastavit pouze před pásu je načten do aplikace Office nebo před přidáním do dynamické nabídky ovládacího prvku v době běhu.Informace o nastavení těchto vlastností naleznete v tématu Přehled modelu objektů pásu karet.

Můžete vytvořit RibbonButton za běhu pomocí CreateRibbonButton metoda RibbonFactory objektu.

Existují dva způsoby přístupu RibbonFactory objekt:

Při použití Factory vlastnosti třídy pásu karet.Použijte tento přístup z kódu ve vaší třídě pásu karet.
Při použití Globals.Factory.GetRibbonFactory metody.Použijte tento přístup z kódu mimo danou třídu pásu karet.

Obecné úlohy

Následující tabulka uvádí členy, které jsou vhodné pro běžné úkoly.

Úloha	Člen
V době běhu, přidání tlačítka do nabídky, která má své Dynamic vlastnost nastavena na hodnotu true.	Vytvořit instanci třídy, která implementuje RibbonButton rozhraní pomocíCreateRibbonButton Metoda RibbonFactory třídy.Další informace naleznete v tématu Globální přístup k objektům v projektech pro systém Office. Do nabídky přidat instanci Items kolekce.
Změna velikosti tlačítka.	Nastavit ControlSize na hodnotu, kterou chcete.Například pro velké tlačítko, nastavte ji na Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Zobrazení obrázku na tlačítku.	Chcete-li obrázek zobrazit třemi způsoby: Použijte vlastnost Image.Tato vlastnost poskytuje maximální kontrolu. Nastavit OfficeImageId na ID předdefinovaný obrázkových Microsoft Office, který chcete zobrazit jako ikonu tlačítka. Použití ImageName spolu s vlastností LoadImage události.Tato vlastnost poskytuje některé výkony.
Zakázat nebo skrýt tlačítka.	Chcete-li zakázat tlačítko, nastavte Enabled k false. Chcete-li skrýt tlačítko, nastavte Visible k false.
Když uživatel klepne na tlačítko spusťte kód.	Přidejte kód, který Click obslužnou rutinu události.

[!POZNÁMKA]

Toto rozhraní je implementováno modulem Visual Studio Tools for Office Runtime. Rozhraní není určeno k implementaci do vašeho kódu. Další informace naleznete v tématu Přehled nástrojů Visual Studio Tools for Office runtime.

Použití

Tato dokumentace popisuje verzi tohoto typu, který je používán v projektech systému Office cílených pro rozhraní .NET Framework 4 a .NET Framework 4.5. V projektech cílených pro rozhraní .NET Framework 3.5 může mít tento typ jiné členy a ukázky kódu, poskytnuté pro tento typ, nemusejí fungovat. Dokumentaci k tomuto typu projektů cílených na rozhraní .NET Framework 3.5 naleznete v následující informační části dokumentace k sadě Visual Studio 2008: https://go.microsoft.com/fwlink/?LinkId=160658.

Příklady

Následující příklad vytvoří nové tlačítko, nastaví různé vlastnosti na tlačítko a potom přidá tlačítko do nabídky.Chcete-li spustit příklad kódu, musíte nejprve provést následující kroky:

Přidat pásu karet (vizuální návrhář) položku do projektu vytvořeného pomocí vývojářských nástrojů sady Office v aplikaci Visual Studio.
Přidání skupiny do vlastní karty.
Přidání do skupiny nabídky.
Nastavit dynamický vlastnost v nabídce true.
Nastavit ItemSize vlastnost v nabídce 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);

}