RibbonButton – rozhraní

Článek
08/11/2011

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, který se na toto tlačítko nabídka při ItemSize nabídkavlastnost nastavena na Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
	Enabled	Získá nebo nastaví hodnotu, která označuje, zda tento RibbonControl povolena. (Zděděno z RibbonControl.)
	Id	Načte řetězec, který se používá k identifikaci tohoto systém Microsoft Office RibbonControl objekt. (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 LoadImageobslužnou rutinuudálost .
	KeyTip	Získá nebo nastaví klávesové zástupce 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í bitová kopie zobrazit na tlačítku, pokud chcete použít předdefinovaný ikonu systém Microsoft Office .
	Parent	Získává RibbonComponent , představuje to rodiče RibbonComponent. (Zděděno z RibbonComponent.)
	Position	Získá nebo nastaví pozici tlačítka, pokud je tlačítko systém Microsoft Office nabídce.
	Ribbon	Získá nejvyšší Ribbon objekt , který obsahuje hierarchii řízení. (Zděděno z RibbonComponent.)
	RibbonUI	Infrastruktura. Získává IRibbonUI instance poskytovanéaplikace systém Microsoft Officekód rozšiřitelnosti Pás karet . (Zděděno z RibbonComponent.)
	ScreenTip	Získá nebo nastaví text popisku, který se zobrazí, když uživatel přesune ukazatel nad tlačítkem.
	ShowImage	Získá nebo nastaví hodnotu, která označuje, zda je bitová kopie přidružený tlačítko viditelné.
	ShowLabel	Získá nebo nastaví hodnotu, která označuje, zda je zobrazen jmenovka tlačítka.
	Site	Získá nebo nastaví ISite přidružené IComponent. (Zděděno z IComponent.)
	SuperTip	Získá nebo nastaví víceřádkové tip text, který se zobrazí, když uživatel přesune ukazatel nad tlačítkem.
	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.)

Na začátek

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é řízení, pokud RibbonComponent má dynamické nadřazené, například dynamické nabídkaa rozložení není pozastaven. (Zděděno z RibbonComponent.)
	PerformLayout	Volání Microsoft.Office.Core.IRibbonUI.InvalidateControl Pokud RibbonComponent s nadřízenou a rozložení není pozastaven. (Zděděno z RibbonComponent.)
	ResumeLayout()	Účinek obrátí SuspendLayout metody. (Zděděno z RibbonComponent.)
	ResumeLayout(Boolean)	Účinek obrátí SuspendLayout metody. (Zděděno z RibbonComponent.)
	SuspendLayout	Zabrání aktualizaci stavu ovládací prvky na Pás karetaplikace sady systém Microsoft Office. (Zděděno z RibbonComponent.)

Na začátek

Události

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

Na začátek

Poznámky

Visual Studio vytvoří instanci třída , která implementuje RibbonButton rozhraní při přetažení tlačítko ovládací prvek z Office Pás karet prvky kartě nástrojů na Pás karet Designer.

Můžete také vytvořit instanci tohoto ovládacího prvku při běhu a přidat dynamické nabídka. nabídka je dynamické, pokud nastavíte jeho Dynamicvlastnost true.

Některé vlastnosti tohoto ovládacího prvku lze nastavit pouze před načtením Pás karet do aplikace Office nebo před přidáním ovládacího prvku do dynamické nabídka v době běhu. Informace o nastavení těchto vlastností v Ribbon Object Model Overview.

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

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

Pomocí Factoryvlastnosttřída Pás karet. Použít tento přístup z Pás karet třídav kódu.
Pomocí Globals.Factory.GetRibbonFactory metoda. Použít tento přístup z kódu mimotřída Pás karet.

Běžné úkoly

Členy, které jsou užitečné pro běžné úkoly v následující tabulce.

Úloha	Člen
Přidat tlačítko nabídka má za běhu, jeho Dynamic vlastnost nastavena na hodnotu true.	Vytvořit instanci třída , která implementuje RibbonButtonpomocírozhraní CreateRibbonButton metoda RibbonFactory třída. Další informace naleznete v tématu Global Access to Objects in Office Projects. Přidat instance nabídka Items kolekce.
Změnit velikosti tlačítka.	Nastavit ControlSize na hodnotu můžete chtít. Například pro velké tlačítko, nastavte ji na Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Zobrazení bitová kopie na tlačítku.	bitová kopiezobrazit třemi způsoby: Použití Image vlastnost. Tato vlastnost poskytuje nejvíce kontrolu. Nastavit OfficeImageId ID vestavěné systém Microsoft Office bitová kopie , kterou chcete zobrazit jako ikonu tlačítka. Použít ImageNamespolu svlastnost LoadImageudálost. Tato vlastnost poskytuje výkon .
Zakázat nebo skrýt tlačítka.	Chcete-li zakázat tlačítko Nastavit Enabled na false. skrýt tlačítko, nastavte Visible na false.
Spustit kód, když uživatel klepne na tlačítko.	Přidat kód Clickobslužnou rutinuudálost .

Poznámka

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

Použití

Tato dokumentace popisuje verzi tohoto typu, který je používán v projektech systému Office cílených na rozhraní .NET Framework 4. V projektech cílených na rozhraní .NET Framework 3.5 může mít tento typ rozdílné členy a příklady kódů pro tento typ nemusí 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 tlačítka a přidá tlačítko do nabídka. Chcete-li spustit příklad kódu je musí provést následující kroky:

Přidat Pás karet (vizuální Návrhář) položka projekt vytvořený pomocí nástroje Office vývoj v Visual Studio.
Přidat na kartu vlastní skupinu.
Přidat do skupiny nabídka .
Nastavit dynamické vlastnost v nabídka true.
Nastavit ItemSize vlastnost v nabídka 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);

}