Bagikan melalui

XML Pita

  • Artikel

Item Pita (XML) memungkinkan Anda mengkustomisasi pita dengan menggunakan XML. Gunakan item Pita (XML) jika Anda ingin mengkustomisasi pita dengan cara yang tidak didukung oleh item Pita (Visual Designer). Untuk perbandingan apa yang bisa Anda lakukan dengan setiap item, lihat Gambaran umum pita.

Berlaku untuk: Informasi dalam topik ini berlaku untuk proyek tingkat dokumen dan proyek Add-in VSTO untuk aplikasi berikut: Excel; InfoPath 2013 dan InfoPath 2010; Outlook; PowerPoint; Proyek; Visio; Kata. Untuk informasi selengkapnya, lihat Fitur yang tersedia berdasarkan aplikasi Office likasi dan jenis proyek.

Menambahkan item Pita (XML) ke proyek

Anda bisa menambahkan item Pita (XML) ke proyek Office mana pun dari kotak dialog Tambahkan Item Baru. Visual Studio secara otomatis menambahkan file berikut ke proyek Anda:

  • File XML Pita. File ini mendefinisikan antarmuka pengguna Pita (UI). Gunakan file ini untuk menambahkan elemen UI seperti tab, grup, dan kontrol. Untuk detailnya, lihat Referensi file XML pita nanti dalam topik ini.

  • File kode Pita. File ini berisi kelas Pita. Kelas ini memiliki nama yang Anda tentukan untuk item Pita (XML) dalam kotak dialog Tambahkan Item Baru. Microsoft aplikasi Office lications menggunakan instans kelas ini untuk memuat pita kustom. Untuk detailnya, lihat Referensi kelas pita nanti dalam topik ini.

    Secara default, file-file ini menambahkan grup kustom ke tab Add-In di pita.

Menampilkan pita kustom dalam microsoft aplikasi Office lication

Setelah Menambahkan item Pita (XML) ke proyek, Anda harus menambahkan kode ke kelas ThisAddin, ThisWorkbook, atau ThisDocument yang mengambil alih CreateRibbonExtensibilityObject metode dan mengembalikan kelas XML Pita ke aplikasi Office likasi.

Contoh kode berikut mengambil alih CreateRibbonExtensibilityObject metode dan mengembalikan kelas XML Pita bernama MyRibbon.

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

Menentukan perilaku pita kustom

Anda bisa merespons tindakan pengguna, seperti mengklik tombol pada pita, dengan membuat metode panggilan balik. Metode panggilan balik menyerupai peristiwa dalam kontrol Formulir Windows, tetapi diidentifikasi oleh atribut dalam XML elemen UI. Anda menulis metode di kelas Pita, dan kontrol memanggil metode yang memiliki nama yang sama dengan nilai atribut. Misalnya, Anda dapat membuat metode panggilan balik yang dipanggil saat pengguna mengklik tombol pada pita. Dua langkah diperlukan untuk membuat metode panggilan balik:

  • Tetapkan atribut ke kontrol dalam file XML Pita yang mengidentifikasi metode panggilan balik dalam kode Anda.

  • Tentukan metode panggilan balik di kelas Pita.

Catatan

Outlook memerlukan langkah tambahan. Untuk informasi selengkapnya, lihat Mengkustomisasi pita untuk Outlook.

Untuk panduan yang menunjukkan cara mengotomatiskan aplikasi dari pita, lihat Panduan: Membuat tab kustom dengan menggunakan XML Pita.

Menetapkan metode panggilan balik ke kontrol

Untuk menetapkan metode panggilan balik ke kontrol dalam file XML Pita, tambahkan atribut yang menentukan jenis metode panggilan balik dan nama metode . Misalnya, elemen berikut mendefinisikan tombol pengalih yang memiliki metode panggilan balik onAction bernama OnToggleButton1.

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

onAction dipanggil ketika pengguna melakukan tugas utama yang terkait dengan kontrol tertentu. Misalnya, metode panggilan balik onAction dari tombol pengalih dipanggil saat pengguna mengklik tombol .

Metode yang Anda tentukan dalam atribut dapat memiliki nama apa pun. Namun, metode harus cocok dengan nama metode yang Anda tentukan dalam file kode Pita.

Ada berbagai jenis metode panggilan balik yang bisa Anda tetapkan ke kontrol Pita. Untuk daftar lengkap metode panggilan balik yang tersedia untuk setiap kontrol, lihat artikel teknis Mengkustomisasi antarmuka pengguna Pita Office (2007) untuk pengembang (Bagian 3 dari 3).

Menentukan metode panggilan balik

Tentukan metode panggilan balik Anda di kelas Pita dalam file kode Pita. Metode panggilan balik memiliki beberapa persyaratan:

  • Ini harus dinyatakan sebagai publik.

  • Namanya harus cocok dengan nama metode panggilan balik yang Anda tetapkan ke kontrol dalam file XML Pita.

  • Tanda tangannya harus cocok dengan tanda tangan tipe metode panggilan balik yang tersedia untuk kontrol Pita terkait.

    Untuk daftar lengkap tanda tangan metode panggilan balik untuk kontrol Pita, lihat artikel teknis Mengkustomisasi antarmuka pengguna Pita Office (2007) untuk pengembang (Bagian 3 dari 3). Visual Studio tidak menyediakan dukungan IntelliSense untuk metode panggilan balik yang Anda buat dalam file kode Pita. Jika Anda membuat metode panggilan balik yang tidak cocok dengan tanda tangan yang valid, kode akan dikompilasi, tetapi tidak ada yang akan terjadi ketika pengguna mengklik kontrol.

    Semua metode panggilan balik memiliki IRibbonControl parameter yang mewakili kontrol yang memanggil metode . Anda dapat menggunakan parameter ini untuk menggunakan kembali metode panggilan balik yang sama untuk beberapa kontrol. Contoh kode berikut menunjukkan metode panggilan balik onAction yang melakukan tugas yang berbeda tergantung pada kontrol klik pengguna.

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

Referensi file XML pita

Anda bisa menentukan pita kustom Anda dengan menambahkan elemen dan atribut ke file XML Pita. Secara default, file XML Pita berisi XML berikut.

<?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>

Tabel berikut ini menjelaskan elemen default dalam file XML Pita.

Elemen Deskripsi
customUI Mewakili pita kustom dalam proyek Add-in VSTO.
pita Mewakili pita.
Tab Mewakili sekumpulan tab Pita.
Tab Mewakili satu tab Pita.
grup Mewakili grup kontrol pada tab Pita.

Elemen-elemen ini memiliki atribut yang menentukan tampilan dan perilaku pita kustom. Tabel berikut ini menjelaskan atribut default dalam file XML Pita.

Atribut elemen induk Deskripsi
onLoad customUI Mengidentifikasi metode yang dipanggil saat aplikasi memuat pita.
idMso Tab Mengidentifikasi tab bawaan untuk ditampilkan di pita.
id grup Mengidentifikasi grup.
label grup Menentukan teks yang muncul di grup.

Elemen dan atribut default dalam file XML Pita adalah subset kecil dari elemen dan atribut yang tersedia. Untuk daftar lengkap elemen dan atribut yang tersedia, lihat artikel teknis Mengkustomisasi antarmuka pengguna Pita Office (2007) untuk pengembang (Bagian 2 dari 3).

Referensi kelas pita

Visual Studio menghasilkan kelas Pita dalam file kode Pita. Tambahkan metode panggilan balik untuk kontrol pada pita ke kelas ini. Kelas ini menerapkan antarmuka IRibbonExtensibility.

Tabel berikut menjelaskan metode default di kelas ini.

Metode Deskripsi
GetCustomUI Mengembalikan konten file XML Pita. Microsoft aplikasi Office lications memanggil metode ini untuk mendapatkan string XML yang menentukan antarmuka pengguna pita kustom Anda. Metode ini mengimplementasikan GetCustomUI metode . Catatan: GetCustomUI harus diimplementasikan hanya untuk mengembalikan konten file XML Pita; tidak boleh digunakan untuk menginisialisasi Add-in VSTO Anda. Secara khusus, Anda tidak boleh mencoba menampilkan kotak dialog atau jendela lain dalam implementasi Anda GetCustomUI . Jika tidak, pita kustom mungkin tidak berulah dengan benar. Jika Anda harus menjalankan kode yang menginisialisasi Add-in VSTO Anda, tambahkan kode ke penanganan ThisAddIn_Startup aktivitas.
OnLoad IRibbonControl Menetapkan parameter ke Ribbon bidang . Microsoft aplikasi Office lications memanggil metode ini saat memuat pita kustom. Anda bisa menggunakan bidang ini untuk memperbarui pita kustom secara dinamis. Untuk informasi selengkapnya, lihat artikel teknis Mengkustomisasi antarmuka pengguna Pita Office (2007) untuk pengembang (Bagian 1 dari 3).
GetResourceText Dipanggil oleh GetCustomUI metode untuk mendapatkan konten file XML Pita.

Konten terkait