RibbonButton – rozhraní

Článek
05/14/2013

Představuje tlačítko na vlastní pásu 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, který se na toto tlačítko v nabídce, když ItemSize nabídky vlastnost Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
	Enabled	Získá nebo nastaví hodnotu, která označuje, zda to RibbonControl je povoleno. (Zděděno z RibbonControl.)
	Id	Získá řetězec, který používá aplikaci Microsoft Office k identifikaci tohoto RibbonControl objektu. (Zděděno z RibbonControl.)
	Image	Získá nebo nastaví obrázek, který je zobrazen na tlačítku.
	ImageName	Získá nebo nastaví název používaný pro 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, který je 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, chcete-li 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í pozici tlačítko, je-li tlačítko v nabídce Microsoft Office.
	Ribbon	Získá nejvyšší Ribbon objekt, který obsahuje hierarchii ovládacích prvků. (Zděděno z RibbonComponent.)
	RibbonUI	Infrastruktura. Získá IRibbonUI instanci, která je součástí aplikace Microsoft Office kódu rozšiřitelnost pásu karet. (Zděděno z RibbonComponent.)
	ScreenTip	Získá nebo nastaví text popisu tlačítka, 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 spojen s tlačítka.
	ShowLabel	Získá nebo nastaví hodnotu, která označuje, zda se zobrazí 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, který je spojen s tímto RibbonComponent. (Zděděno z RibbonComponent.)
	Visible	Získá nebo nastaví hodnotu, která označuje, zda to RibbonControl je zobrazen. (Zděděno z RibbonControl.)

Nahoru

Metody

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

Nahoru

Události

	Název	Popis
	Click	Vyvolá se, když uživatel klikne 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 Ovládací prvky pásu karet Office kartě nástrojů na Návrhář pásu karet.

Můžete také vytvořit instanci tohoto ovládacího prvku v době běhu a přidat 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 karet je načten do aplikace sady Office nebo předtím, než ovládací prvek je přidán do dynamické nabídky v době běhu.Informace o nastavení těchto vlastností naleznete v tématu Přehled modelu objektu pásu karet.

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

Existují dva způsoby, jak získat přístup RibbonFactory objekt:

Při použití Factory vlastnost 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 metoda.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 užitečné 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 Office. Do nabídky přidat instanci Items kolekce.
Změna velikosti tlačítka.	Set 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. Set OfficeImageId ID předdefinovaný obrázkových Microsoft Office, který chcete zobrazit jako ikonu tlačítka. Použití ImageName vlastnost spolu s LoadImage události.Tato vlastnost poskytuje některé výhody výkonu.
Zakázat nebo skrýt tlačítka.	Chcete-li zakázat tlačítko nastavit Enabled na false. Chcete-li skrýt tlačítko, nastavte Visible na false.
Spusťte kód, když uživatel klikne na tlačítko.	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 Visual Studio Tools pro přehled Runtime sady Office.

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 v projektech cílených na rozhraní .NET Framework 3.5 naleznete v následující informační části dokumentace k aplikaci 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í nejprve provést následující kroky:

Přidat pásu karet (vizuální návrhář) položky do projektu vytvořeného pomocí nástrojů pro vývoj Office v sadě Visual Studio.
Přidání skupiny do vlastní kartu.
Do nabídky přidáte do skupiny.
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);

}