RibbonButton Antarmuka
Definisi
Penting
Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.
Mewakili tombol pada Pita kustom.
public interface class RibbonButton : IDisposable, Microsoft::Office::Tools::Ribbon::RibbonControl, System::ComponentModel::IComponent
[System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent
[<System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")>]
type RibbonButton = interface
interface RibbonControl
interface RibbonComponent
interface IComponent
interface IDisposable
Public Interface RibbonButton
Implements IComponent, IDisposable, RibbonControl
- Atribut
- Penerapan
Contoh
Contoh berikut membuat tombol baru, mengatur berbagai properti tombol, lalu menambahkan tombol ke menu. Untuk menjalankan contoh kode ini, Anda harus terlebih dahulu melakukan langkah-langkah berikut:
Tambahkan item Pita (Visual Designer) ke proyek yang dibuat dengan menggunakan alat pengembangan Office di Visual Studio.
Tambahkan grup ke tab kustom.
Tambahkan menu ke grup.
Atur properti Dinamis menu ke
true
.Atur properti Ukuran Item menu ke RibbonControlSizeLarge.
private void AddButtonsToMenu()
{
RibbonButton tempButton = this.Factory.CreateRibbonButton();
tempButton.Label = "Button 1";
tempButton.ControlSize =
Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge;
tempButton.Description = "My Ribbon Button";
tempButton.ShowImage = true;
tempButton.ShowImage = true;
tempButton.Image = Properties.Resources.Image1;
tempButton.Image = Properties.Resources.Image2;
tempButton.KeyTip = "A1";
menu1.Items.Add(tempButton);
}
Private Sub AddButtonsToMenu()
Dim tempButton = Me.Factory.CreateRibbonButton()
tempButton.Label = "Button 1"
tempButton.ControlSize = _
Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge
tempButton.Description = "My Ribbon Button"
tempButton.ShowImage = True
tempButton.ShowImage = True
tempButton.Image = My.Resources.Image1
tempButton.Image = My.Resources.Image2
tempButton.KeyTip = "A1"
menu1.Items.Add(tempButton)
End Sub
Keterangan
Visual Studio membuat instans kelas yang mengimplementasikan RibbonButton antarmuka saat Anda menyeret kontrol Tombol dari tab Kontrol Pita Office dari Kotak Alat ke Designer Pita.
Anda juga dapat membuat instans kontrol ini pada durasi dan menambahkannya ke menu dinamis. Menu bersifat dinamis jika Anda mengatur propertinya Dynamic ke true
.
Beberapa properti kontrol ini bisa diatur hanya sebelum Pita dimuat ke dalam aplikasi Office atau sebelum kontrol ditambahkan ke menu dinamis pada durasi. Untuk informasi tentang pengaturan properti ini, lihat Gambaran Umum Model Objek Pita.
Anda dapat membuat RibbonButton pada durasi dengan menggunakan CreateRibbonButton metode RibbonFactory objek .
Ada dua cara untuk mengakses RibbonFactory objek:
Dengan menggunakan
Factory
properti kelas Pita. Gunakan pendekatan ini dari kode di kelas Pita Anda.Dengan menggunakan
Globals.Factory.GetRibbonFactory
metode . Gunakan pendekatan ini dari kode di luar kelas Pita Anda.
Tugas umum
Tabel berikut ini mencantumkan anggota yang berguna untuk tugas umum.
Tugas | Anggota |
---|---|
Pada durasi, tambahkan tombol ke menu yang propertinya Dynamic diatur ke true. | Membuat instans RibbonButton kelas yang mengimplementasikan antarmuka dengan menggunakan CreateRibbonButton RibbonFactory metode kelas . Untuk informasi selengkapnya, lihat Akses Global ke Objek di Proyek Office. Tambahkan instans ke koleksi menu Items . |
Ubah ukuran tombol. | Atur ControlSize ke nilai yang Anda inginkan. Misalnya, untuk tombol besar, atur ke Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge . |
Tampilkan gambar pada tombol. | Ada tiga cara untuk menampilkan gambar: - Gunakan Image properti . Properti ini memberikan kontrol paling besar. - Atur OfficeImageId ke ID gambar Microsoft Office bawaan yang ingin Anda tampilkan sebagai ikon untuk tombol tersebut. - Gunakan ImageName properti bersama dengan LoadImage peristiwa. Properti ini memberikan beberapa manfaat performa. |
Nonaktifkan atau sembunyikan tombol. | Untuk menonaktifkan tombol, atur Enabled ke false .Untuk menyembunyikan tombol, atur Visible ke false . |
Jalankan kode saat pengguna mengklik tombol . | Tambahkan kode ke penanganan Click aktivitas. |
Catatan
Antarmuka ini diimplementasikan oleh runtime Visual Studio Tools for Office. Ini tidak dimaksudkan untuk diimplementasikan dalam kode Anda. Untuk informasi selengkapnya, lihat Gambaran Umum Visual Studio Tools for Office Runtime.
Penggunaan
Dokumentasi ini menjelaskan versi tipe ini yang digunakan dalam proyek Office yang menargetkan .NET Framework 4 atau yang lebih baru. Dalam proyek yang menargetkan .NET Framework 3.5, jenis ini mungkin memiliki anggota yang berbeda dan contoh kode yang disediakan untuk jenis ini mungkin tidak berfungsi. Untuk dokumentasi tentang jenis ini dalam proyek yang menargetkan .NET Framework 3.5, lihat bagian referensi berikut di dokumentasi Visual Studio 2008: http://go.microsoft.com/fwlink/?LinkId=160658.
Properti
ControlSize |
Mendapatkan atau mengatur ukuran tombol. |
Description |
Mendapatkan atau mengatur teks yang muncul pada tombol ini di menu saat ItemSize properti menu diatur ke Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge. |
Enabled |
Mendapatkan atau menetapkan nilai yang menunjukkan apakah ini RibbonControl diaktifkan. (Diperoleh dari RibbonControl) |
Id |
Mendapatkan string yang digunakan Microsoft Office untuk mengidentifikasi objek ini RibbonControl . (Diperoleh dari RibbonControl) |
Image |
Mendapatkan atau mengatur gambar yang ditampilkan pada tombol. |
ImageName |
Mendapatkan atau mengatur nama yang dapat Anda gunakan untuk mengidentifikasi tombol di penanganan LoadImage aktivitas. |
KeyTip |
Mendapatkan atau mengatur pintasan keyboard tombol. |
Label |
Mendapatkan atau mengatur teks yang ditampilkan pada tombol. |
Name |
Mendapatkan atau menetapkan nama ini RibbonComponent. (Diperoleh dari RibbonComponent) |
OfficeImageId |
Mendapatkan atau mengatur gambar untuk ditampilkan pada tombol, jika Anda ingin menggunakan ikon Microsoft Office bawaan. |
Parent |
RibbonComponent Mendapatkan yang mewakili induk dari iniRibbonComponent. (Diperoleh dari RibbonComponent) |
Position |
Mendapatkan atau mengatur posisi tombol, jika tombol berada di Menu Microsoft Office. |
Ribbon |
Mendapatkan objek tingkat Ribbon atas yang berisi hierarki kontrol. (Diperoleh dari RibbonComponent) |
RibbonUI |
Mendapatkan instans IRibbonUI yang disediakan oleh aplikasi Microsoft Office ke kode ekstensibilitas Pita. (Diperoleh dari RibbonComponent) |
ScreenTip |
Mendapatkan atau mengatur teks tipsalat yang muncul saat pengguna memindahkan penunjuk ke atas tombol. |
ShowImage |
Mendapatkan atau menetapkan nilai yang menunjukkan apakah gambar yang terkait dengan tombol terlihat. |
ShowLabel |
Mendapatkan atau mengatur nilai yang menunjukkan apakah label untuk tombol terlihat. |
SuperTip |
Mendapatkan atau mengatur teks tip multibaris yang muncul saat pengguna memindahkan penunjuk ke atas tombol. |
Tag |
Mendapatkan atau mengatur data khusus aplikasi yang terkait dengan ini RibbonComponent. (Diperoleh dari RibbonComponent) |
Visible |
Mendapatkan atau menetapkan nilai yang menunjukkan apakah ini RibbonControl terlihat. (Diperoleh dari RibbonControl) |
Metode
PerformDynamicLayout() |
Memanggil metode Microsoft.Office.Core.IRibbonUI.InvalidateControl dari kontrol induk jika RibbonComponent memiliki induk dinamis, seperti menu dinamis, dan tata letak tidak ditangguhkan. (Diperoleh dari RibbonComponent) |
PerformLayout() |
Memanggil Microsoft.Office.Core.IRibbonUI.InvalidateControl jika RibbonComponent memiliki induk dan tata letak tidak ditangguhkan. (Diperoleh dari RibbonComponent) |
ResumeLayout() |
Membalikkan efek SuspendLayout() metode . (Diperoleh dari RibbonComponent) |
ResumeLayout(Boolean) |
Membalikkan efek SuspendLayout() metode . (Diperoleh dari RibbonComponent) |
SuspendLayout() |
Mencegah aplikasi Microsoft Office menyegarkan status kontrol pada Pita. (Diperoleh dari RibbonComponent) |
Acara
Click |
Terjadi ketika pengguna mengklik tombol . |