Přehled modelu objektů pásu karet

Visual Studio Tools for Office runtime Poskytuje model silně typový objekt, který lze použít k získání a nastavení vlastností ovládacích prvků pás karet za běhu.Například můžete dynamicky naplnění prvků menu nebo zobrazit a skrýt ovládací prvky kontextově.Také můžete přidat karet, skupin a ovládací prvky pásu karet, ale pouze před pásu je načten v aplikaci Office.Informace naleznete v tématu Pouze pro nastavení vlastnosti, že se stanou čtení.

Platí pro: Informace v tomto tématu se vztahují na projekty na úrovni dokumentu i na úrovni aplikace v těchto aplikacích: Excel 2013 a Excel 2010, InfoPath 2013 a InfoPath 2010, Outlook 2013 a Outlook 2010, PowerPoint 2013 a PowerPoint 2010, Project 2013 a Project 2010, Visio 2013 a Visio 2010, Word 2013 a Word 2010. Další informace najdete v tématu Dostupné funkce podle aplikací systému Office a typů projektu.

Tento objektový model pás karet se skládá převážně z Pás karet třída, Pásu karet událostí, a Tříd ovládacích prvků pás karet.

Pás karet třída

Při přidávání nového pásu karet (vizuální návrhář) položek do projektu aplikace Visual Studio přidá Ribbon třídy do projektu.Ribbon Třída dědí z RibbonBase třídy.

Do této třídy se zobrazí jako dílčí třídy, které je rozděleno mezi pásu soubor kódu a soubor s kódem Návrhář pásu karet.

Události na pásu karet

Ribbon Třída obsahuje tři následující události:

Událost

Description

RibbonBase.Load

Je aktivována při načtení přizpůsobení pásu karet aplikace sady Office.Load Obslužná rutina události je automaticky přidán do souboru kódu pásu karet.Umožňuje spustit vlastní kód, který načte pásu tuto obslužnou rutinu události.

RibbonBase.LoadImage

Umožňuje mezipaměť obrazy ve vlastní nastavení pásu karet při načtení pás karet.Lehké výkon můžete získat, pokud píšete kód do mezipaměti pásu obrázky v této obslužné rutině události.Další informace naleznete v tématu LoadImage.

RibbonBase.Close

Vyvolána, když ukončí instanci pásu karet.

Ovládací prvky pásu karet

Microsoft.Office.Tools.Ribbon Názvů obsahuje typ pro každý ovládací prvek, který je uveden v Office pás karet prvky skupinu nástrojů.

Následující tabulka obsahuje pro každý typ Ribbon ovládacího prvku.Popis každého ovládacího prvku naleznete v tématu Přehled pásu karet.

Název ovládacího prvku

Název třídy

Pole

RibbonBox

Tlačítko

RibbonButton

Skupina tlačítek

RibbonButtonGroup

CheckBox

RibbonCheckBox

ComboBox

RibbonComboBox

Rozevírací seznam

RibbonDropDown

Textové pole

RibbonEditBox

Galerie

RibbonGallery

Skupina

RibbonGroup

Popisek

RibbonLabel

Nabídka

RibbonMenu

Oddělovač

RibbonSeparator

Tlačítko rozdělení

RibbonSplitButton

TAB

RibbonTab

Přepínací tlačítko

RibbonToggleButton

Microsoft.Office.Tools.Ribbon Oboru názvů používá předponu "Pásu" pro tyto typy pro zamezení kolize názvů s názvy tříd ovládacích prvků v System.Windows.Forms obor názvů.

Při přidání ovládacího prvku na pásu karet Designer, Návrhář pásu karet deklaruje třída pro ovládací prvek jako pole v souboru kódu Návrhář pásu karet.

Běžné úlohy pomocí vlastností ovládacích prvků pás karet

Každý Ribbon ovládací prvek obsahuje vlastnosti, které můžete provádět různé úkoly, například přiřadit popisek ovládacího prvku, nebo skrytím a zobrazením ovládacích prvků.

V některých případech stát vlastnosti jen pro čtení po načtení pásu nebo ovládací prvek je přidán do dynamické nabídky.Další informace naleznete v tématu Nastavení vlastností se stát jen pro čtení.

Následující tabulka popisuje některé úkoly, které lze provést pomocí Ribbon vlastnosti ovládacího prvku.

Pro tento úkol:

Postupujte následujícím způsobem:

Skrytí nebo zobrazení ovládacího prvku.

Použijte vlastnost Visible.

Povolení nebo zakázání ovládacího prvku.

Použijte vlastnost Enabled.

Nastavte velikost ovládacího prvku.

Použijte vlastnost ControlSize.

Načtení obrázku, který se zobrazí v ovládacím prvku.

Použijte vlastnost Image.

Změna popisku ovládacího prvku.

Použijte vlastnost Label.

Přidáte ovládací prvek dat definované uživatelem.

Použijte vlastnost Tag.

Get the items in a RibbonBox, RibbonDropDown, RibbonGallery, or

Ovládací prvek RibbonSplitButton.

Použijte vlastnost Items.

Add items to a RibbonComboBox, RibbonDropDown, or RibbonGallery control.

Použijte vlastnost Items.

Přidat ovládací prvky a RibbonMenu.

Použijte vlastnost Items.

Chcete-li přidat ovládací prvky a RibbonMenu po pásu je načten do aplikace sady Office, je nutné nastavit Dynamic vlastnost true před načtením pás karet do aplikace Office.Informace naleznete v tématu Pouze pro nastavení vlastnosti, že se stanou čtení.

Načíst vybrané položky RibbonComboBox,

RibbonDropDown, or RibbonGallery.

Použijte vlastnost SelectedItem.Pro RibbonComboBox, použít Text vlastnost.

Získat skupiny RibbonTab.

Použijte vlastnost Groups.

Určete počet řádků a sloupců, které se zobrazují v RibbonGallery.

Použití RowCount a ColumnCount vlastnosti.

Nastavení vlastností, které se stanou jen pro čtení

Některé vlastnosti lze nastavit pouze před pásu karet.Existují tři místa, chcete-li nastavit tyto vlastnosti:

  • V aplikaci Visual Studio Vlastnosti okno.

  • V konstruktoru Ribbon třídy.

  • V CreateRibbonExtensibilityObject metoda ThisAddin, ThisWorkbook, nebo ThisDocument třídy do projektu.

Dynamické nabídky umožňují určité výjimky.Vytvořit nové ovládací prvky, nastavte jejich vlastnosti a poté je přidejte do dynamické nabídky v době běhu i po načtení pás karet, který obsahuje nabídku.

Kdykoli můžete nastavit vlastnosti ovládacích prvků, které přidáte do dynamické nabídky.

Další informace naleznete v tématu se stát jen pro čtení vlastnosti.

Nastavení vlastností v konstruktoru pásu karet

Můžete nastavit vlastnosti Ribbon řízení v konstruktoru Ribbon třídy.Tento kód musí být po volání InitializeComponent metody.Následující příklad přidá nové tlačítko ke skupině, pokud je aktuální čas 17:00 tichomořského času (UTC-8) nebo novější.

Přidejte následující kód.

<System.Diagnostics.DebuggerNonUserCode()> _
Public Sub New()
    MyBase.New(Globals.Factory.GetRibbonFactory())

    'This call is required by the Component Designer.
    InitializeComponent()
    Dim MyButton As Microsoft.Office.Tools.Ribbon.RibbonButton = _
        Me.Factory.CreateRibbonButton()
    MyButton.Label = "New Button" 
    If System.DateTime.Now.Hour > 16 Then
        Group1.Items.Add(MyButton)
    End If 

End Sub
public Ribbon1()
    : base(Globals.Factory.GetRibbonFactory())
{
    InitializeComponent();
    if (System.DateTime.Now.Hour > 16)
    {
        Microsoft.Office.Tools.Ribbon.RibbonButton button =
            this.Factory.CreateRibbonButton();
        button.Label = "New Button";
        group1.Items.Add(button);
    }
}

V jazyce Visual C# projekty, které jste provedli upgrade ze sady Visual Studio 2008 konstruktor se zobrazí v souboru s kódem pásu karet.

Projekty jazyka Visual Basic nebo Visual C# projekty, které jste vytvořili v Visual Studio 2013, konstruktor se zobrazí v souboru kódu Návrhář pásu karet.Název tohoto souboru je YourRibbonItem.Designer.cs nebo YourRibbonItem.Designer.vb.Chcete-li zobrazit tento soubor v projektech jazyka Visual Basic, musíte nejprve klepnout Zobrazit všechny soubory tlačítko v okně Průzkumník řešení.

Nastavení vlastností v CreateRibbonExtensibilityObject metody

Můžete nastavit vlastnosti Ribbon řízení při přepsání CreateRibbonExtensibilityObject metoda ThisAddin, ThisWorkbook, nebo ThisDocument třídy do projektu.Další informace o metodě CreateRibbonExtensibilityObject naleznete v tématu Přehled pásu karet.

Následující příklad nastaví vlastnosti pásu karet CreateRibbonExtensibilityObject metoda ThisWorkbook třídy projektu sešitu aplikace Excel.

Přidejte následující kód.

Protected Overrides Function CreateRibbonExtensibilityObject() _
    As Microsoft.Office.Core.IRibbonExtensibility
    Dim myCondition As Boolean = True 
    If myCondition = True Then 
        Dim tempRibbon As New Ribbon1()
        tempRibbon.Tab1.ControlId.ControlIdType = _
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office
        tempRibbon.Tab1.ControlId.OfficeId = "TabHome" 
        Return Globals.Factory.GetRibbonFactory.CreateRibbonManager _
            (New Microsoft.Office.Tools.Ribbon.IRibbonExtension() {tempRibbon})
    Else 
        Dim tempRibbon As New Ribbon2()
        tempRibbon.Tab1.ControlId.ControlIdType = _
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office
        tempRibbon.Tab1.ControlId.OfficeId = "TabInsert" 
        Return Globals.Factory.GetRibbonFactory.CreateRibbonManager _
            (New Microsoft.Office.Tools.Ribbon.IRibbonExtension() {tempRibbon})
    End If 
End Function
protected override Microsoft.Office.Core.IRibbonExtensibility
    CreateRibbonExtensibilityObject()
{
    bool myCondition = false;
    if (myCondition == true)
    {
        Ribbon1 tempRibbon = new Ribbon1();
        tempRibbon.tab1.ControlId.ControlIdType =
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office;
        tempRibbon.tab1.ControlId.OfficeId = "TabHome";
        return Globals.Factory.GetRibbonFactory().CreateRibbonManager( 
            new Microsoft.Office.Tools.Ribbon.IRibbonExtension[]
             { tempRibbon });
    }
    else
    {
        Ribbon2 tempRibbon = new Ribbon2();
        tempRibbon.tab1.ControlId.ControlIdType =
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office;
        tempRibbon.tab1.ControlId.OfficeId = "TabInsert";
        return Globals.Factory.GetRibbonFactory().CreateRibbonManager(
                            new Microsoft.Office.Tools.Ribbon.IRibbonExtension[] { tempRibbon });
    }
}

Vlastnosti, které se stanou jen pro čtení

Následující tabulka obsahuje vlastnosti, které lze nastavit pouze před pásu karet.

[!POZNÁMKA]

Kdykoli můžete nastavit vlastnosti ovládacích prvků na dynamické nabídky.Tuto tabulku nelze použít v tomto případě.

Property

Třída ovládacího prvku pásu karet

BoxStyle

RibbonBox

ButtonType

RibbonSplitButton

Počet sloupců

RibbonGallery

ControlId

RibbonTab

DialogLauncher

RibbonGroup

Dynamické

RibbonMenu

Globální

OfficeRibbon

Skupiny

RibbonTab

ImageName

RibbonButton

RibbonComboBox

RibbonDialogLauncher

RibbonDropDown

RibbonEditBox

RibbonGallery

RibbonMenu

RibbonSplitButton

RibbonToggleButton

ItemSize

RibbonMenu

RibbonSplitButton

Hodnota MaxLength

RibbonComboBox

RibbonEditBox

Název

RibbonComponent

Pozice

RibbonButton

RibbonCheckBox

RibbonGallery

RibbonGroup

RibbonMenu

RibbonSeparator

RibbonSplitButton

RibbonTab

RibbonToggleButton

RibbonType

OfficeRibbon

RowCount

RibbonGallery

ShowItemImage

RibbonComboBox

RibbonDropDown

RibbonGallery

ShowItemLabel

RibbonDropDown

RibbonGallery

ShowItemSelection

RibbonGallery

SizeString

RibbonComboBox

RibbonDropDown

RibbonEditBox

StartFromScratch

OfficeRibbon

Karty

OfficeRibbon

Title

RibbonSeparator

Nastavení vlastností pro pásy karet, které se zobrazí v aplikaci Outlook inspektorů

Pokaždé, když uživatel otevře inspektor se zobrazí na pásu karet je vytvořena nová instance na pásu karet.Však můžete nastavit vlastnosti uvedené v tabulce uvedené dříve, než je vytvořen první výskyt na pásu karet.Po prvním je vytvořena instance, tyto vlastnosti se stanou jen pro čtení, protože definuje první instance XML soubor, který aplikace Outlook používá k načtení pás karet.

Pokud máte podmíněné logiky, nastavující kterékoli z těchto vlastností na jinou hodnotu při vytváření dalších instancí pásu, tento kód bude mít žádný účinek.

[!POZNÁMKA]

Zajistit, aby jméno je nastavena pro každý ovládací prvek, který přidáte do pásu karet aplikace Outlook.Pokud přidáte ovládací prvek do pásu karet aplikace Outlook v době spuštění, musíte tuto vlastnost nastavit v kódu.Při přidání ovládacího prvku pásu karet aplikace Outlook v době návrhu Name je nastavena automaticky.

Události ovládacích prvků pás karet

Každá třída ovládací prvek obsahuje jeden nebo více událostí.Následující tabulka popisuje tyto události.

Událost

Description

Click

Vyvolá se při klepnutí na ovládací prvek.

TextChanged

Vyvolá se při změně textu textového pole nebo pole se seznamem.

ItemsLoading

Dochází při Items Office žádá kolekce ovládacího prvku.Mezipaměti Office Items kolekce, dokud váš kód změní vlastnosti ovládacího prvku nebo můžete zavolat IRibbonUI.InvalidateControl metody.

ButtonClick

Dojde-li na tlačítko RibbonGallery nebo RibbonDropDown po kliknutí na.

SelectionChanged

Dochází při výběru v RibbonDropDown nebo RibbonGallery změny.

DialogLauncherClick

Vyvolá se při klepnutí na ikonu spouštěč dialogového okna v pravém dolním rohu skupiny.

Obslužné rutiny událostí pro tyto události mají následující dva parametry.

Parametr

Description

sender

Object , Která představuje ovládací prvek, který událost vyvolal.

e

A RibbonControlEventArgs that contains a IRibbonControl.Tento ovládací prvek použít pro jakoukoliv vlastnost, která není k dispozici v objektovém modelu pásu karet poskytuje přístup Visual Studio Tools for Office runtime.

Viz také

Úkoly

Postupy: Začínáme s přizpůsobením pásu karet

Návod: Vytvoření vlastní karty pomocí návrháře pásu karet

Návod: Aktualizace ovládacích prvků na pásu karet za běhu

Postupy: Přizpůsobení předdefinované karty

Postupy: Přidání ovládacích prvků do zobrazení Backstage

Postupy: Export pásu karet z návrháře pásu karet do kódu XML pásu karet

Postupy: Zobrazení chyb uživatelského rozhraní doplňku

Referenční dokumentace

Microsoft.Office.Tools.Ribbon

Koncepty

Přístup k pásu karet za běhu

Návrhář pásu karet

Přizpůsobení pásu karet pro aplikaci Outlook

Další zdroje

Přehled pásu karet