Model obiektu Wstążka ― Omówienie

Artykuł
06/10/2015

Visual Studio Tools for Office Runtime Udostępnia jednoznaczny model obiektu, którego można użyć, aby uzyskać i ustawić właściwości formanty wstążki w czasie wykonywania.Na przykład można dynamicznie wypełnianie formantów menu lub Pokaż i kontekstowego ukrywa formanty.Do wstążki, ale tylko przed wstążki jest ładowany przez aplikację pakietu Office, można dodać kart, grup i formanty.Aby uzyskać informacje, zobacz Ustawienie właściwości że stają się przemieszczanej.

Zastosowanie: Informacje przedstawione w tym temacie mają zastosowanie do projektów na poziomie dokumentu i aplikacji dla następujących aplikacji: Excel 2013 i Excel 2010; InfoPath 2013 i InfoPath 2010; Outlook 2013 i Outlook 2010; PowerPoint 2013 i PowerPoint 2010; Project 2013 i Project 2010; Visio 2013 i Visio 2010; Word 2013 i Word 2010. Aby uzyskać więcej informacji, zobacz Funkcje dostępne w aplikacjach pakietu Office i typ projektu.

Modelu obiektowego Wstążka składa się głównie z Klasy wstążki, Zdarzenia wstążki, i Klasy kontroli wstążki.

Klasa wstążki

Podczas dodawania nowego wstążki (Visual Designer) przedmiotu do projektu Visual Studio dodaje Ribbon klasy do projektu.Ribbon Klasa dziedziczy z RibbonBase klasy.

Ta klasa jest wyświetlany jako częściowej klasy, która jest podzielona między plikiem kod Wstążki i pliku kodu projektanta wstążki.

Zdarzenia wstążki

Ribbon Klasa zawiera następujące trzy zdarzenia:

Zdarzenie	Opis
RibbonBase.Load	Wywoływane podczas ładowania aplikacji Office dostosowania wstążki.Load Program obsługi zdarzeń jest automatycznie dodawany do pliku kodu wstążki.Ta procedura obsługi zdarzeń umożliwia uruchomienie niestandardowego kodu po załadowaniu wstążki.
RibbonBase.LoadImage	Umożliwia pamięci podręcznej obrazów w dostosowania wstążki, po załadowaniu wstążki.Niewielki przyrost wydajności można uzyskać, jeśli piszesz kod obrazów wstążki w tej obsłudze zdarzeń w pamięci podręcznej.Aby uzyskać więcej informacji, zobacz LoadImage.
RibbonBase.Close	Wywoływane, gdy zamyka wystąpienie wstążki.

Formanty Wstążki

Microsoft.Office.Tools.Ribbon Nazw zawiera typ dla każdego formantu, który widać w Formanty wstążki Office grupy Przybornik.

W poniższej tabeli przedstawiono dla każdego typu Ribbon kontroli.Opis każdego formantu, zobacz Wstążka ― Omówienie.

Nazwa formantu	Nazwa klasy
Pole	RibbonBox
Przycisk	RibbonButton
Grupa przycisków	RibbonButtonGroup
Pole wyboru	RibbonCheckBox
Składnik ComboBox	RibbonComboBox
Lista rozwijana	RibbonDropDown
Pole edycji	RibbonEditBox
Galeria	RibbonGallery
Grupa	RibbonGroup
Etykieta	RibbonLabel
Menu	RibbonMenu
Separator	RibbonSeparator
Przycisk podziału	RibbonSplitButton
Tab	RibbonTab
ToggleButton	RibbonToggleButton

Microsoft.Office.Tools.Ribbon Obszaru nazw używa prefiksu "Wstążka" dla tych typów w celu uniknięcia kolizji nazw z nazwami klas kontroli w System.Windows.Forms obszaru nazw.

Po dodaniu formantu do projektanta wstążki projektanta wstążki deklarowana jako pola w pliku kodu projektanta wstążki klasy dla tego formantu.

Typowe zadania za pomocą właściwości formanty wstążki

Każdy Ribbon formant zawiera właściwości, które można użyć do wykonywania różnych zadań, takich jak przypisywanie etykiety do formantu, lub ukrywanie i pokazywanie formantów.

W niektórych przypadkach właściwości stają się tylko do odczytu po załadowaniu Wstążki lub po dodaniu formantu do menu dynamiczne.Aby uzyskać więcej informacji, zobacz Ustawienie właściwości tego Zostań w trybie tylko do odczytu.

W poniższej tabeli opisano niektóre z zadań, które można wykonać przy użyciu Ribbon właściwości formantu.

Dla tego zadania:	Wykonaj następujące czynności:
Ukryć lub pokazać formant.	Użyj właściwości Visible.
Włączanie lub wyłączanie formantu.	Użyj właściwości Enabled.
Ustaw rozmiar formantu.	Użyj właściwości ControlSize.
Pobierz obraz wyświetlany w formancie.	Użyj właściwości Image.
Zmienić etykiety formantu.	Użyj właściwości Label.
Dodawanie danych zdefiniowane przez użytkownika do formantu.	Użyj właściwości Tag.
Get the items in a RibbonBox, RibbonDropDown, RibbonGallery, or RibbonSplitButtonformant.	Użyj właściwości Items.
Add items to a RibbonComboBox, RibbonDropDown, or RibbonGallery control.	Użyj właściwości Items.
Dodać formanty do RibbonMenu.	Użyj właściwości Items. Aby dodać formanty do RibbonMenu po wstążki jest ładowany do aplikacji pakietu Office, należy ustawić Dynamic właściwość, aby true przed załadowaniem wstążki do aplikacji pakietu Office.Aby uzyskać informacje, zobacz Ustawienie właściwości że stają się przemieszczanej.
Pobierz zaznaczonego elementu RibbonComboBox, RibbonDropDown, or RibbonGallery.	Użyj właściwości SelectedItem.Dla RibbonComboBox, użyj Text właściwości.
Uzyskiwanie grup RibbonTab.	Użyj właściwości Groups.
Określ liczbę wierszy i kolumn, które pojawiają się w RibbonGallery.	Użycie RowCount i ColumnCount właściwości.

Ustawianie właściwości, które stają się tylko do odczytu

Niektóre właściwości można ustawić tylko przed załadowaniem wstążki.Istnieją trzy miejsca, aby ustawić te właściwości:

W programie Visual Studio Właściwości okna.
W Konstruktorze Ribbon klasy.
W CreateRibbonExtensibilityObject metody ThisAddin, ThisWorkbook, lub ThisDocument klasy projektu.

Dynamicznych menu ustanowić niektóre wyjątki.Można utworzyć nowe formanty, ustawiać ich właściwości i następnie dodać je do menu dynamiczne w czasie wykonywania, nawet po załadowaniu wstążką, który zawiera menu.

Właściwości formantów, które można dodać do menu dynamiczne można ustawić w dowolnym momencie.

Aby uzyskać więcej informacji, zobacz się, że tylko do odczytu właściwości.

Ustawianie właściwości w Konstruktorze wstążki

Można ustawić właściwości Ribbon kontroli w Konstruktorze Ribbon klasy.Kod ten musi być umieszczony po wywołaniu InitializeComponent metody.W następującym przykładzie dodano nowy przycisk do grupy, jeśli jest bieżąca godzina 17:00 czasu pacyficznego (UTC-8) lub nowszym.

Dodaj następujący kod.

<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);
    }
}

W środowisku Visual C# projektów, które przeprowadzono uaktualnienie z programu Visual Studio 2008 konstruktora pojawia się w pliku kodu wstążki.

Projekty języka Visual Basic lub Visual C# projektów, które zostały utworzone w Visual Studio 2013, konstruktora pojawia się w pliku kodu projektanta wstążki.Ten plik nosi nazwę YourRibbonItem.Designer.cs narzędzie lub YourRibbonItem.Designer.VB.Aby wyświetlić ten plik w projekty języka Visual Basic, należy najpierw kliknąć Pokaż wszystkie pliki przycisk w oknie Solution Explorer.

Ustawianie właściwości w metodzie CreateRibbonExtensibilityObject

Można ustawić właściwości Ribbon kontrolować, kiedy można zastąpić CreateRibbonExtensibilityObject metoda w ThisAddin, ThisWorkbook, lub ThisDocument klasy projektu.Aby uzyskać więcej informacji o CreateRibbonExtensibilityObject metoda, zobacz Wstążka ― Omówienie.

W następującym przykładzie ustawiono właściwości wstążki CreateRibbonExtensibilityObject metody ThisWorkbook klasy projekcie skoroszytu programu Excel.

Dodaj następujący kod.

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 });
    }
}

Właściwości, które stają się tylko do odczytu

W poniższej tabeli przedstawiono właściwości, które można ustawić tylko przed załadowaniem wstążki.

[!UWAGA]

Właściwości formantów na dynamicznych menu można ustawić w dowolnym momencie.W takim przypadku nie ma zastosowania w tej tabeli.

Właściwość	Klasa sterowania wstążki
BoxStyle	RibbonBox
Właściwości ButtonType	RibbonSplitButton
ColumnCount	RibbonGallery
Właściwości ControlId	RibbonTab
DialogLauncher	RibbonGroup
Dynamiczne	RibbonMenu
Globalny	OfficeRibbon
Grupy	RibbonTab
Nazwa_obrazu	RibbonButton RibbonComboBox RibbonDialogLauncher RibbonDropDown RibbonEditBox RibbonGallery RibbonMenu RibbonSplitButton RibbonToggleButton
ItemSize	RibbonMenu RibbonSplitButton
Element MaxLength	RibbonComboBox RibbonEditBox
Nazwa	RibbonComponent
Stanowisko	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
Tytuł	RibbonSeparator

Ustawianie właściwości dla taśmy, które pojawiają się w inspektorzy programu Outlook

Nowe wystąpienie wstążki jest tworzony każdorazowo użytkownik otworzy inspektora, w którym pojawia się wstążki.Jednak można ustawić właściwości wymienionych w powyższej tabeli wyłącznie, przed utworzeniem pierwszego wystąpienia wstążki.Po pierwsze wystąpienie jest tworzony, właściwości te stają się tylko do odczytu, ponieważ przede wszystkim określa plik XML, który program Outlook używa do załadowania na Wstążce.

Jeśli masz warunkowe logiki, która ustawia żadnej z tych właściwości na inną wartość, gdy są tworzone inne wystąpienia wstążki, ten kod nie wpłyną.

[!UWAGA]

Zapewnienia, że Nazwa właściwość jest ustawiona dla każdego formantu, który można dodać do Wstążki programu Outlook.Jeśli dodasz formant do Wstążki programu Outlook w czasie wykonywania, należy ustawić tej właściwości, w kodzie.Jeśli formant zostanie dodany do Wstążki programu Outlook w czasie projektowania, Name właściwość jest ustawiana automatycznie.

Zdarzenia formantu wstążki

Każda klasa sterowania zawiera jedno lub więcej zdarzeń.W poniższej tabeli opisano te zdarzenia.

Zdarzenie	Opis
Click	Występuje, gdy formant zostanie kliknięty.
TextChanged	Występuje po zmianie tekstu w pole tekstowe lub pole kombi.
ItemsLoading	Występuje, gdy Items kolekcji formantu jest wymagany przez urząd.Pamięci podręczne Office Items kolekcji aż do kodu zmienia właściwości formantu lub wywołać IRibbonUI.InvalidateControl metody.
ButtonClick	Występuje, gdy przycisk w RibbonGallery lub RibbonDropDown zostanie kliknięty.
SelectionChanged	Występuje, gdy zaznaczenie w RibbonDropDown lub RibbonGallery zmiany.
DialogLauncherClick	Występuje po kliknięciu ikony otwierający okno dialogowe w prawym dolnym rogu grupy.

Programy obsługi zdarzeń dla zdarzenia te mają następujące dwa parametry.

Parametr	Opis
sender	Object Reprezentująca formant, który spowodował zdarzenie.
e	A RibbonControlEventArgs that contains a IRibbonControl.Ten formant umożliwia dostęp do każdej właściwości, której nie jest dostępne w modelu obiektowym wstążki, dostarczonych przez Visual Studio Tools for Office Runtime.

Zobacz też

Udostępnij za pośrednictwem