Omówienie modelu obiektu wstążki
Visual Studio 2010 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łnić menu sterowania, lub pokazać i ukryć formanty kontekstowego.Karty, grupy i formanty można dodać również do wstążki, ale tylko przed Wstążka jest ładowany przez aplikację pakietu Office.Aby uzyskać informacje, zobacz Ustawienie właściwości że stają się tylko.
Dotyczy: Informacje przedstawione w tym temacie dotyczą projektów na poziomie dokumentu i projektów na poziomie 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 aplikacji pakietu Office i typ projektu.
Modelu obiektowego Wstążka składa się głównie z Wstążki klasy, Zdarzenia wstążki, i Klasy kontroli wstążki.
Klasa wstążki
Podczas dodawania nowego wstążki (Visual Designer) element z projektem programu Visual Studio dodaje Ribbon klasy do projektu.Ribbon Dziedziczy po klasie RibbonBase klasy.
Klasa ta pojawia się jako częściowej klasy, która jest podzielona między pliku kodu Wstążki i pliku kodu projektanta wstążki.
Wstążka wydarzenia
Ribbon Klasa zawiera następujące trzy zdarzenia:
Zdarzenie |
Opis |
---|---|
Wywoływane, gdy aplikacja pakietu Office ładuje dostosowania wstążki.Load Programu obsługi zdarzeń jest automatycznie dodawany do pliku kod wstążki.Ta procedura obsługi zdarzeń można użyć, aby uruchomić kod niestandardowy, po załadowaniu wstążki. |
|
Umożliwia do 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 tym obsługa zdarzeń w pamięci podręcznej.Aby uzyskać więcej informacji, zobacz LoadImage. |
|
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 typu dla każdego Ribbon kontroli.Opis każdego formantu, zobacz Omówienie wstążki.
Nazwa formantu |
Nazwa klasy |
---|---|
Pole |
|
Przycisk |
|
Grupa przycisków |
|
Pole wyboru |
|
Składnik ComboBox |
|
Lista rozwijana |
|
Pole edycji |
|
Galeria |
|
Grupa |
|
Etykieta |
|
Menu |
|
Separator |
|
Przycisk podziału |
|
Tab |
|
ToggleButton |
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 deklaruje klasy dla tego formantu jako pole w pliku kodu projektanta wstążki.
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żywać do wykonywania różnych zadań, takich jak przypisywanie etykietę z formantem, lub ukrywanie i pokazywanie formantów.
W niektórych przypadkach właściwości się tylko do odczytu po załadowaniu Wstążki lub po dodaniu formantu do dynamicznych menu.Aby uzyskać więcej informacji, zobacz Ustawienie właściwości się, że tylko do odczytu.
W poniższej tabeli opisano niektóre z zadań, które można wykonać za pomocą Ribbon do 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łączyć lub wyłączyć formant. |
Użyj właściwości Enabled. |
Ustaw rozmiar formantu. |
Użyj właściwości ControlSize. |
Pobierz obraz wyświetlany na formancie. |
Użyj właściwości Image. |
Zmienić etykietę formantu. |
Użyj właściwości Label. |
Dodawanie użytkownika danych 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ążka 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ę tylko. |
Pobierz wybranego elementu z RibbonComboBox, |
Użyj właściwości SelectedItem.Dla RibbonComboBox, użyj Text właściwość. |
Uzyskać grupy 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 w przypadku, 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 metoda ThisAddin, ThisWorkbook, lub ThisDocument klasy projektu.
Dynamicznych menu zapewnić pewne wyjątki.Można utworzyć nowe formanty, ustawianie ich właściwości i 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.Ten kod musi być umieszczony po wywołaniu InitializeComponent metoda.Poniższy przykład dodaje nowy przycisk do grupy, jeśli 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 Visual C# projektów, które zostały uaktualnione z Visual Studio 2008 Konstruktor pojawia się w pliku kodu wstążki.
W projekty języka Visual Basic lub Visual C# projektów, które utworzono w Visual Studio 2012, Konstruktor pojawia się w pliku kodu projektanta wstążki.Ten plik o nazwie 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 Omówienie wstążki.
W poniższym przykładzie ustawiono właściwości wstążki CreateRibbonExtensibilityObject metoda ThisWorkbook klasy projektu 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 każdej chwili można ustawić właściwości formantów dynamicznych menu.W tej tabeli nie ma zastosowania w takim przypadku.
Właściwość |
Klasa sterowania wstążki |
---|---|
BoxStyle |
|
Właściwości ButtonType |
|
ColumnCount |
|
Właściwości ControlId |
|
DialogLauncher |
|
Dynamiczne |
|
Globalne |
|
Grupy |
|
Nazwa_obrazu |
|
ItemSize |
|
Element MaxLength |
|
Nazwa |
|
Stanowisko |
|
RibbonType |
|
RowCount |
|
ShowItemImage |
|
ShowItemLabel |
|
ShowItemSelection |
|
SizeString |
|
StartFromScratch |
|
Tabulatory |
|
Tytuł |
Ustawianie właściwości dla taśmy, które pojawiają się w inspektorzy programu Outlook
Nowe wystąpienie Wstążka jest tworzony za każdym razem, gdy użytkownik otworzy inspektora, w którym pojawia się wstążki.Można jednak ustawić właściwości wymienione w powyższej tabeli, tylko, przed utworzeniem pierwszego wystąpienia wstążki.Po pierwsze wystąpienie jest tworzony, właściwości te stają się tylko do odczytu, ponieważ pierwsze wystąpienie określa plik XML, który program Outlook używa do ładowania na Wstążce.
Jeśli masz logikę warunkową, która ustawia żadnej z tych właściwości na inną wartość, gdy są tworzone inne wystąpienia wstążki, kod ten będzie nie mają wpływu.
[!UWAGA]
Zapewnienia, że Nazwa właściwość jest ustawiona dla każdego formantu, który dodano do Wstążki programu Outlook.Jeśli formant zostanie dodany do Wstążki programu Outlook w czasie wykonywania, należy ustawić tej właściwości w kodzie.Jeśli dodać formant 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 po kliknięciu formantu. |
TextChanged |
Występuje po zmianie tekstu w pole tekstowe lub pole kombi. |
ItemsLoading |
Występuje, gdy Items kolekcja formantu jest zgłoszony przez urząd.Bufory Office Items kolekcji, dopóki kod zmienia właściwości formantu lub wywołać IRibbonUI.InvalidateControl metoda. |
ButtonClick |
Występuje, gdy przycisk w RibbonGallery lub RibbonDropDown po kliknięciu. |
SelectionChanged |
Występuje, gdy wybór w RibbonDropDown lub RibbonGallery zmiany. |
DialogLauncherClick |
Występuje po kliknięciu ikony przycisk Uruchom okno dialogowe w prawym dolnym rogu grupy. |
Programy obsługi zdarzeń dla zdarzenia te mają następujące dwa parametry.
Parametr |
Opis |
---|---|
sender |
Object , Oznaczającą formantu, który spowodował zdarzenie. |
e |
A RibbonControlEventArgs that contains a Microsoft.Office.Core.IRibbonControl.Ten formant umożliwia dostęp do dowolnej właściwości, które nie są dostępne w modelu wstążki dostarczonych przez Visual Studio 2010 Tools for Office Runtime. |
Zobacz też
Zadania
Jak: rozpocząć dostosowywanie wstążki
Instruktaż: Tworzenie kartę niestandardowe przy użyciu projektanta wstążki
Instruktaż: Aktualizowanie formanty na Wstążce w czasie wykonywania
Jak: Dostosowywanie wbudowane karty
Jak: dodawanie formantów do widoku Backstage
Jak: eksportowanie wstążki z projektanta wstążki wstęgę XML
Jak: Pokaż błędy interfejsu użytkownika dodatku
Informacje
Koncepcje
Uzyskiwanie dostępu do Wstążki w czasie wykonywania
Dostosowywanie Wstążki programu Outlook