RibbonButton Rozhraní

Reference

Definice

Obor názvů:: Microsoft.Office.Tools.Ribbon

Sestavení:: Microsoft.Office.Tools.Common.dll

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

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

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

Atributy: GuidAttribute

Implementuje: RibbonComponent RibbonControl IComponent IDisposable

Příklady

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

Přidejte položku pásu karet (Visual Designer) do projektu vytvořeného pomocí vývojových nástrojů Office v sadě Visual Studio.
Přidání skupiny na vlastní kartu
Přidejte do skupiny nabídku.
Vlastnost Dynamic nabídky nastavte na true.
Nastavte vlastnost ItemSize nabídky 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

Poznámky

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

Můžete také vytvořit instanci tohoto ovládacího prvku za běhu a přidat ji do dynamické nabídky. Nabídka je dynamická, pokud nastavíte její Dynamic vlastnost na true.

Některé vlastnosti tohoto ovládacího prvku je možné nastavit pouze před načtením pásu karet do aplikace Office nebo před tím, než se ovládací prvek přidá do dynamické nabídky za běhu. Informace o nastavení těchto vlastností najdete v tématu Přehled objektového modelu pásu karet.

Za běhu CreateRibbonButton můžete vytvořit RibbonButton pomocí metody objektuRibbonFactory.

Existují dva způsoby přístupu k objektu RibbonFactory :

Pomocí Factory vlastnosti třídy Pás karet. Použijte tento přístup z kódu ve své třídě pásu karet.
Pomocí Globals.Factory.GetRibbonFactory metody. Použijte tento přístup z kódu mimo svou třídu pásu karet.

Obecné úlohy

V následující tabulce jsou uvedeny členy, které jsou užitečné pro běžné úlohy.

Úkol	Člen
Za běhu přidejte tlačítko do nabídky, která má vlastnost Dynamic nastavenou na true.	Vytvořte instanci třídy, která implementuje RibbonButton rozhraní pomocí CreateRibbonButton RibbonFactory metody třídy. Další informace najdete v tématu Globální přístup k objektům v projektech Office. Přidejte instanci do kolekce nabídky `Items` .
Změňte velikost tlačítka.	Nastavte ControlSize na požadovanou hodnotu. Například pro velké tlačítko nastavte na `Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge`.
Zobrazení obrázku na tlačítku	Obrázek můžete zobrazit třemi způsoby: - Použijte Image vlastnost. Tato vlastnost poskytuje největší kontrolu. – Nastavte OfficeImageId na ID integrovaného obrázku Microsoft Office, který chcete zobrazit jako ikonu tlačítka. - Použijte ImageName vlastnost společně s událostí LoadImage . Tato vlastnost poskytuje určité výhody z hlediska výkonu.
Zakázání nebo skrytí tlačítek	Pokud chcete tlačítko zakázat, nastavte Enabled na `false`. Pokud chcete tlačítko skrýt, nastavte Visible na `false`.
Když uživatel klikne na tlačítko, spusťte kód.	Přidejte kód do obslužné rutiny Click 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 najdete v tématu přehled modulu Visual Studio Tools for Office Runtime.

Využití

Tato dokumentace popisuje verzi tohoto typu, který se používá v projektech Office cílených na rozhraní .NET Framework 4 nebo novější. 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, které cílí na rozhraní .NET Framework 3.5, naleznete v následující referenční části v dokumentaci k sadě Visual Studio 2008: http://go.microsoft.com/fwlink/?LinkId=160658.

Vlastnosti

ControlSize	Získá nebo nastaví velikost tlačítka.
Description	Získá nebo nastaví text, který se zobrazí na tomto tlačítku v nabídce, když ItemSize je vlastnost nabídky nastavena na Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Enabled	Získá nebo nastaví hodnotu, která označuje, zda je povolena RibbonControl . (Zděděno od RibbonControl)
Id	Získá řetězec, který Microsoft Office používá k identifikaci tohoto RibbonControl objektu. (Zděděno od RibbonControl)
Image	Získá nebo nastaví obrázek, který se zobrazí na tlačítku.
ImageName	Získá nebo nastaví název, který můžete použít k identifikaci tlačítka v obslužné rutině LoadImage události.
KeyTip	Získá nebo nastaví klávesovou zkratku tlačítka.
Label	Získá nebo nastaví text, který se zobrazí na tlačítku.
Name	Získá nebo nastaví název tohoto RibbonComponent. (Zděděno od RibbonComponent)
OfficeImageId	Získá nebo nastaví obrázek tak, aby se zobrazil na tlačítku, pokud chcete použít integrovanou ikonu Microsoft Office.
Parent	Získá objekt RibbonComponent , který představuje nadřazený objekt tohoto RibbonComponentobjektu . (Zděděno od RibbonComponent)
Position	Získá nebo nastaví pozici tlačítka, pokud je tlačítko v nabídce Microsoft Office.
Ribbon	Získá objekt nejvyšší úrovně Ribbon , který obsahuje hierarchii ovládacích prvků. (Zděděno od RibbonComponent)
RibbonUI	Získá IRibbonUI instance, která je poskytována aplikace Microsoft Office do kódu rozšiřitelnosti pásu karet. (Zděděno od RibbonComponent)
ScreenTip	Získá nebo nastaví text popisu, který se zobrazí, když uživatel přesune ukazatel na tlačítko.
ShowImage	Získá nebo nastaví hodnotu, která označuje, zda obrázek, který je přidružen k tlačítku je viditelný.
ShowLabel	Získá nebo nastaví hodnotu, která označuje, zda je popisek pro tlačítko viditelný.
SuperTip	Získá nebo nastaví text víceřádkového tipu, který se zobrazí, když uživatel přesune ukazatel na tlačítko.
Tag	Získá nebo nastaví data specifická pro aplikaci, která je přidružena k tomuto RibbonComponent. (Zděděno od RibbonComponent)
Visible	Získá nebo nastaví hodnotu, která označuje, zda RibbonControl je viditelný. (Zděděno od RibbonControl)

Metody

PerformDynamicLayout()	Zavolá Microsoft.Office.Core.IRibbonUI.InvalidateControl metodu nadřazeného ovládacího prvku, pokud RibbonComponent má dynamický nadřazený prvek, například dynamickou nabídku, a rozložení není pozastaveno. (Zděděno od RibbonComponent)
PerformLayout()	Zavolá Microsoft.Office.Core.IRibbonUI.InvalidateControl, pokud RibbonComponent má nadřazený a rozložení není pozastaveno. (Zděděno od RibbonComponent)
ResumeLayout()	Vrátí účinek SuspendLayout() metody. (Zděděno od RibbonComponent)
ResumeLayout(Boolean)	Vrátí účinek SuspendLayout() metody. (Zděděno od RibbonComponent)
SuspendLayout()	Zabrání aplikaci Microsoft Office v aktualizaci stavu ovládacích prvků na pásu karet. (Zděděno od RibbonComponent)

Událost

Click

Nastane, když uživatel klikne na tlačítko.

Platí pro

Sdílet prostřednictvím