XML — Wstążka

Artykuł
10/10/2023

Element wstążki (XML) umożliwia dostosowanie wstążki przy użyciu kodu XML. Użyj elementu wstążki (XML), jeśli chcesz dostosować wstążkę w sposób, który nie jest obsługiwany przez element wstążki (Visual Designer). Aby zapoznać się z porównaniem czynności, które można wykonać z każdym elementem, zobacz Omówienie wstążki.

Dotyczy: informacje w tym temacie dotyczą projektów na poziomie dokumentu i projektów dodatków VSTO dla następujących aplikacji: Excel; InfoPath 2013 i InfoPath 2010; Programu outlook; PowerPoint; Projekt; Visio; Słowo. Aby uzyskać więcej informacji, zobacz Funkcje dostępne przez aplikacja pakietu Office lication i typ projektu.

Dodawanie elementu wstążki (XML) do projektu

Element wstążki (XML) można dodać do dowolnego projektu pakietu Office w oknie dialogowym Dodawanie nowego elementu . Program Visual Studio automatycznie dodaje następujące pliki do projektu:

Plik XML wstążki. Ten plik definiuje interfejs użytkownika wstążki. Użyj tego pliku, aby dodać elementy interfejsu użytkownika, takie jak karty, grupy i kontrolki. Aby uzyskać szczegółowe informacje, zobacz Dokumentację pliku XML wstążki w dalszej części tego tematu.
Plik kodu wstążki. Ten plik zawiera klasę wstążki. Ta klasa ma nazwę określoną dla elementu wstążki (XML) w oknie dialogowym Dodawanie nowego elementu . Microsoft aplikacja pakietu Office lications używają wystąpienia tej klasy do ładowania niestandardowej wstążki. Aby uzyskać szczegółowe informacje, zobacz Informacje o klasie wstążki w dalszej części tego tematu.

Domyślnie te pliki dodają grupę niestandardową na karcie Dodatki na wstążce.

Wyświetlanie wstążki niestandardowej w aplikacja pakietu Office licacji firmy Microsoft

Po dodaniu elementu wstążki (XML) do projektu należy dodać kod do klasy ThisAddin, ThisWorkbook lub ThisDocument, która zastępuje CreateRibbonExtensibilityObject metodę i zwraca klasę XML wstążki do aplikacja pakietu Office licacji.

Poniższy przykład kodu zastępuje metodę CreateRibbonExtensibilityObject i zwraca klasę XML wstążki o nazwie MyRibbon.

protected override Microsoft.Office.Core.IRibbonExtensibility CreateRibbonExtensibilityObject()
{
    return new MyRibbon();
}

Protected Overrides Function CreateRibbonExtensibilityObject() As  _
Microsoft.Office.Core.IRibbonExtensibility
    Return New MyRibbon()
End Function

Definiowanie zachowania niestandardowej wstążki

Możesz odpowiedzieć na akcje użytkownika, takie jak kliknięcie przycisku na wstążce, tworząc metody wywołania zwrotnego. Metody wywołania zwrotnego przypominają zdarzenia w kontrolkach formularzy systemu Windows, ale są one identyfikowane przez atrybut w kodzie XML elementu interfejsu użytkownika. Metody są zapisywane w klasie Wstążki, a kontrolka wywołuje metodę o takiej samej nazwie jak wartość atrybutu. Można na przykład utworzyć metodę wywołania zwrotnego wywoływaną, gdy użytkownik kliknie przycisk na wstążce. Do utworzenia metody wywołania zwrotnego wymagane są dwa kroki:

Przypisz atrybut do kontrolki w pliku XML wstążki, który identyfikuje metodę wywołania zwrotnego w kodzie.
Zdefiniuj metodę wywołania zwrotnego w klasie Wstążki.

Uwaga

Program Outlook wymaga dodatkowego kroku. Aby uzyskać więcej informacji, zobacz Dostosowywanie wstążki dla programu Outlook.

Aby zapoznać się z przewodnikiem, który pokazuje, jak zautomatyzować aplikację na wstążce, zobacz Przewodnik: tworzenie karty niestandardowej przy użyciu kodu XML wstążki.

Przypisywanie metod wywołania zwrotnego do kontrolek

Aby przypisać metodę wywołania zwrotnego do kontrolki w pliku XML wstążki, dodaj atrybut określający typ metody wywołania zwrotnego i nazwę metody . Na przykład poniższy element definiuje przycisk przełącznika, który ma metodę wywołania zwrotnego onAction o nazwie OnToggleButton1.

<toggleButton id="toggleButton1" onAction="OnToggleButton1" />

onAction jest wywoływany, gdy użytkownik wykonuje główne zadanie skojarzone z określoną kontrolką. Na przykład metoda wywołania zwrotnego onAction przycisku przełącznika jest wywoływana, gdy użytkownik kliknie przycisk.

Metoda określona w atrybucie może mieć dowolną nazwę. Jednak musi być zgodna z nazwą metody zdefiniowanej w pliku kodu wstążki.

Istnieje wiele różnych typów metod wywołania zwrotnego, które można przypisać do kontrolek wstążki. Aby uzyskać pełną listę metod wywołania zwrotnego dostępnych dla każdej kontrolki, zobacz artykuł techniczny Dostosowywanie interfejsu użytkownika wstążki pakietu Office (2007) dla deweloperów (część 3 z 3).

Definiowanie metod wywołania zwrotnego

Zdefiniuj metody wywołania zwrotnego w klasie Wstążki w pliku kodu wstążki. Metoda wywołania zwrotnego ma kilka wymagań:

Musi być zadeklarowana jako publiczna.
Jego nazwa musi odpowiadać nazwie metody wywołania zwrotnego przypisanej do kontrolki w pliku XML wstążki.
Jego podpis musi odpowiadać podpisowi typu metody wywołania zwrotnego dostępnego dla skojarzonej kontrolki wstążki.

Aby uzyskać pełną listę sygnatur metody wywołania zwrotnego dla kontrolek wstążki, zobacz artykuł techniczny Dostosowywanie interfejsu użytkownika wstążki pakietu Office (2007) dla deweloperów (część 3 z 3). Program Visual Studio nie zapewnia obsługi funkcji IntelliSense dla metod wywołania zwrotnego tworzonych w pliku kodu wstążki. Jeśli utworzysz metodę wywołania zwrotnego, która nie jest zgodna z prawidłowym podpisem, kod zostanie skompilowany, ale nic nie wystąpi, gdy użytkownik kliknie kontrolkę.

Wszystkie metody wywołania zwrotnego mają IRibbonControl parametr reprezentujący kontrolkę, która nazwała metodę . Tego parametru można użyć do ponownego użycia tej samej metody wywołania zwrotnego dla wielu kontrolek. Poniższy przykład kodu przedstawia metodę wywołania zwrotnego onAction , która wykonuje różne zadania w zależności od tego, które kontroluje kliknięcia użytkownika.
- C#
- VB
```
public void OnActionCallback(Office.IRibbonControl control, bool isPressed)
{
    if (control.Id == "checkBox1")
    {
        MessageBox.Show("You clicked " + control.Id);
    }
    else
    {
        MessageBox.Show("You clicked a different control.");
    }
}
```
```
Public Sub OnActionCallback(ByVal control As Office.IRibbonControl, _
    ByVal isPressed As Boolean)

    If (control.Id = "checkBox1") Then
        MessageBox.Show("You clicked " + control.Id)
    Else
        MessageBox.Show("You clicked a different control.")
    End If

End Sub
```

Odwołanie do pliku XML wstążki

Możesz zdefiniować niestandardową wstążkę, dodając elementy i atrybuty do pliku XML wstążki. Domyślnie plik XML wstążki zawiera następujący kod XML.

<?xml version="1.0" encoding="UTF-8"?>
<customUI xmlns="http://schemas.microsoft.com/office/2006/01/customui" onLoad="OnLoad">
  <ribbon>
    <tabs>
      <tab idMso="TabAddIns">
        <group id="MyGroup"
               label="My Group">
        </group>
      </tab>
    </tabs>
  </ribbon>
</customUI>

W poniższej tabeli opisano domyślne elementy w pliku XML wstążki.

Element	opis
customUI	Reprezentuje wstążkę niestandardową w projekcie dodatku VSTO.
wstążka	Reprezentuje wstążkę.
Karty	Reprezentuje zestaw kart wstążki.
zakładka	Reprezentuje pojedynczą kartę wstążki.
grupa	Reprezentuje grupę kontrolek na karcie Wstążki.

Te elementy mają atrybuty, które określają wygląd i zachowanie niestandardowej wstążki. W poniższej tabeli opisano atrybuty domyślne w pliku XML wstążki.

Atrybut	Element nadrzędny	opis
onLoad	customUI	Identyfikuje metodę wywoływaną podczas ładowania wstążki przez aplikację.
idMso	zakładka	Identyfikuje wbudowaną kartę do wyświetlenia na wstążce.
id	grupa	Identyfikuje grupę.
etykieta	grupa	Określa tekst wyświetlany w grupie.

Domyślne elementy i atrybuty w pliku XML wstążki są małym podzbiorem elementów i atrybutów, które są dostępne. Aby uzyskać pełną listę dostępnych elementów i atrybutów, zobacz artykuł techniczny Dostosowywanie interfejsu użytkownika wstążki pakietu Office (2007) dla deweloperów (część 2 z 3).

Odwołanie do klasy wstążki

Program Visual Studio generuje klasę wstążki w pliku kodu wstążki. Dodaj metody wywołania zwrotnego dla kontrolek na wstążce do tej klasy. Ta klasa implementuje IRibbonExtensibility interfejs.

W poniższej tabeli opisano metody domyślne w tej klasie.

Metoda	opis
`GetCustomUI`	Zwraca zawartość pliku XML wstążki. Microsoft aplikacja pakietu Office lications wywołaj tę metodę, aby uzyskać ciąg XML definiujący interfejs użytkownika niestandardowej wstążki. Ta metoda implementuje metodę GetCustomUI . Uwaga: `GetCustomUI` należy zaimplementować tylko w celu zwrócenia zawartości pliku XML wstążki. Nie należy jej używać do inicjowania dodatku VSTO. W szczególności nie należy próbować wyświetlać okien dialogowych ani innych okien w `GetCustomUI` implementacji. W przeciwnym razie niestandardowa wstążka może nie zachowywać się poprawnie. Jeśli musisz uruchomić kod, który inicjuje dodatek VSTO, dodaj kod do procedury obsługi zdarzeń `ThisAddIn_Startup` .
`OnLoad`	IRibbonControl Przypisuje parametr do `Ribbon` pola. Microsoft aplikacja pakietu Office lications wywołać tę metodę podczas ładowania niestandardowej wstążki. To pole umożliwia dynamiczne aktualizowanie niestandardowej wstążki. Aby uzyskać więcej informacji, zobacz artykuł techniczny Dostosowywanie interfejsu użytkownika wstążki pakietu Office (2007) dla deweloperów (część 1 z 3).
`GetResourceText`	Wywoływana przez metodę `GetCustomUI` w celu uzyskania zawartości pliku XML wstążki.

Udostępnij za pośrednictwem

XML — Wstążka

Dodawanie elementu wstążki (XML) do projektu

Wyświetlanie wstążki niestandardowej w aplikacja pakietu Office licacji firmy Microsoft

Definiowanie zachowania niestandardowej wstążki

Przypisywanie metod wywołania zwrotnego do kontrolek

Definiowanie metod wywołania zwrotnego

Odwołanie do pliku XML wstążki

Odwołanie do klasy wstążki

Opinia

Dodatkowe zasoby

Udostępnij za pośrednictwem

XML — Wstążka

Dodawanie elementu wstążki (XML) do projektu

Wyświetlanie wstążki niestandardowej w aplikacja pakietu Office licacji firmy Microsoft

Definiowanie zachowania niestandardowej wstążki

Przypisywanie metod wywołania zwrotnego do kontrolek

Definiowanie metod wywołania zwrotnego

Odwołanie do pliku XML wstążki

Odwołanie do klasy wstążki

Powiązana zawartość

Opinia

Dodatkowe zasoby