Bagikan melalui


Panel tugas kustom

Panel tugas adalah panel antarmuka pengguna yang biasanya ditampar ke satu sisi jendela di Microsoft aplikasi Office lication. Panel tugas kustom memberi Anda cara untuk membuat panel tugas Anda sendiri dan memberi pengguna antarmuka yang familier untuk mengakses fitur solusi Anda. Misalnya, antarmuka dapat berisi kontrol yang menjalankan kode untuk memodifikasi dokumen atau menampilkan data dari sumber data.

Berlaku untuk: Informasi dalam topik ini berlaku untuk proyek Add-in VSTO untuk Outlook. Untuk informasi selengkapnya, lihat Fitur yang tersedia berdasarkan aplikasi Office likasi dan jenis proyek.

Catatan

Panel tugas kustom berbeda dari panel tindakan. Panel tindakan adalah bagian dari kustomisasi tingkat dokumen untuk Microsoft Office Word dan Microsoft Office Excel. Untuk informasi selengkapnya, lihat Gambaran umum panel Tindakan.

Manfaat panel tugas kustom

Panel tugas kustom memungkinkan Anda mengintegrasikan fitur Anda ke dalam antarmuka pengguna yang sudah dikenal. Anda dapat membuat panel tugas kustom dengan cepat menggunakan alat Visual Studio.

Antarmuka pengguna yang familier

Pengguna aplikasi dalam sistem Microsoft Office sudah terbiasa menggunakan panel tugas seperti panel tugas Gaya dan Pemformatan di Word. Panel tugas kustom berulah seperti panel tugas lain dalam sistem Microsoft Office. Pengguna dapat menambatkan panel tugas kustom ke sisi yang berbeda dari jendela aplikasi, atau mereka dapat menyeret panel tugas kustom ke lokasi mana pun di jendela. Anda dapat membuat Add-in VSTO yang menampilkan beberapa panel tugas kustom secara bersamaan, dan pengguna dapat mengontrol setiap panel tugas satu per satu.

Dukungan formulir Windows

Antarmuka pengguna panel tugas kustom yang Anda buat dengan menggunakan alat pengembangan Office di Visual Studio didasarkan pada kontrol Formulir Windows. Anda bisa menggunakan perancang Formulir Windows yang sudah dikenal untuk merancang antarmuka pengguna untuk panel tugas kustom. Anda juga bisa menggunakan dukungan pengikatan data di Formulir Windows untuk mengikat sumber data ke kontrol pada panel tugas.

Membuat panel tugas kustom

Anda bisa membuat panel tugas kustom dasar dalam dua langkah:

  1. Buat antarmuka pengguna untuk panel tugas kustom Anda dengan menambahkan kontrol Formulir Windows ke UserControl objek.

  2. Buat instans panel tugas kustom dengan meneruskan kontrol pengguna ke CustomTaskPaneCollection objek di Add-in VSTO Anda. Koleksi ini mengembalikan objek baru CustomTaskPane yang bisa Anda gunakan untuk mengubah tampilan panel tugas dan merespons peristiwa pengguna.

    Untuk informasi selengkapnya, lihat Cara: Menambahkan panel tugas kustom ke aplikasi.

Membuat antarmuka pengguna

Semua panel tugas kustom yang dibuat dengan menggunakan alat pengembangan Office di Visual Studio berisi UserControl objek. Kontrol pengguna ini menyediakan antarmuka pengguna panel tugas kustom Anda. Anda dapat membuat kontrol pengguna pada waktu desain atau pada waktu proses. Jika Anda membuat kontrol pengguna pada waktu desain, Anda bisa menggunakan Formulir Windows Designer untuk membangun antarmuka pengguna panel tugas Anda.

Membuat instans panel tugas kustom

Setelah Anda membuat kontrol pengguna yang berisi antarmuka pengguna panel tugas kustom, Anda harus membuat instans CustomTaskPane. Untuk melakukan ini, teruskan kontrol pengguna ke CustomTaskPaneCollection di Add-in VSTO Anda dengan memanggil salah Add satu metode. Koleksi ini diekspos sebagai CustomTaskPanes bidang ThisAddIn kelas. Contoh kode berikut dimaksudkan untuk dijalankan dari ThisAddIn kelas .

myUserControl1 = new MyUserControl();
myCustomTaskPane = this.CustomTaskPanes.Add(myUserControl1, "My Task Pane");
myCustomTaskPane.Visible = true;

Metode Add mengembalikan objek baru CustomTaskPane . Anda bisa menggunakan objek ini untuk mengubah tampilan panel tugas dan merespons peristiwa pengguna.

Mengontrol panel tugas di beberapa jendela

Panel tugas kustom dikaitkan dengan jendela bingkai dokumen, yang menyajikan tampilan dokumen atau item kepada pengguna. Panel tugas hanya terlihat saat jendela terkait terlihat.

Untuk menentukan jendela mana yang menampilkan panel tugas kustom, gunakan metode yang sesuai Add kelebihan beban saat Anda membuat panel tugas:

  • Untuk mengaitkan panel tugas dengan jendela aktif, gunakan Add metode .

  • Untuk mengaitkan panel tugas dengan dokumen yang dihosting oleh jendela tertentu, gunakan metode .Add

    Beberapa aplikasi Office likasi memerlukan instruksi eksplisit kapan harus membuat atau menampilkan panel tugas Anda saat lebih dari satu jendela terbuka. Ini membuatnya penting untuk mempertimbangkan di mana membuat instans panel tugas kustom dalam kode Anda untuk memastikan bahwa panel tugas muncul dengan dokumen atau item yang sesuai dalam aplikasi. Untuk informasi selengkapnya, lihat Mengelola panel tugas kustom di jendela aplikasi.

Mengakses aplikasi dari Panel Tugas

Jika Anda ingin mengotomatiskan aplikasi dari kontrol pengguna, Anda dapat langsung mengakses model objek dengan menggunakan Globals.ThisAddIn.Application dalam kode Anda. Kelas statis Globals menyediakan akses ke ThisAddIn objek. Bidang Application objek ini adalah titik masuk ke dalam model objek aplikasi.

Untuk informasi selengkapnya tentang Application bidang ThisAddIn objek, lihat Program VsTO Add-in. Untuk panduan yang menunjukkan cara mengotomatiskan aplikasi dari panel tugas kustom, lihat Panduan: Otomatis aplikasi dari panel tugas kustom. Untuk informasi selengkapnya tentang kelas ini Globals , lihat Akses global ke objek di proyek Office.

Mengelola antarmuka pengguna Panel Tugas

Setelah membuat panel tugas, Anda bisa menggunakan properti dan peristiwa CustomTaskPane objek untuk mengontrol antarmuka pengguna panel tugas dan merespons saat pengguna mengubah panel tugas.

Membuat Panel Tugas kustom terlihat

Secara default, panel tugas tidak terlihat. Untuk membuat panel tugas terlihat, Anda harus mengatur properti ke Visibletrue.

Pengguna dapat menutup panel tugas kapan saja dengan mengklik tombol Tutup (X) di sudut panel tugas. Namun, tidak ada cara default bagi pengguna untuk membuka panel tugas kustom lagi. Jika pengguna menutup panel tugas kustom, pengguna tersebut tidak dapat menampilkan panel tugas kustom lagi kecuali Anda menyediakan cara untuk menampilkannya.

Jika Anda membuat panel tugas kustom di Add-in VSTO, Anda juga harus membuat elemen UI, seperti tombol, yang dapat diklik pengguna untuk menampilkan atau menyembunyikan panel tugas kustom Anda. Jika Anda membuat panel tugas kustom di Microsoft aplikasi Office likasi yang mendukung kustomisasi Pita, Anda bisa menambahkan grup kontrol ke Pita dengan tombol yang menampilkan atau menyembunyikan panel tugas kustom Anda. Untuk panduan yang menunjukkan cara melakukannya, lihat Panduan: Menyinkronkan panel tugas kustom dengan tombol Pita.

Jika Anda membuat panel tugas kustom di Microsoft aplikasi Office likasi yang tidak mendukung kustomisasi Pita, Anda bisa menambahkan CommandBarButton yang menampilkan atau menyembunyikan panel tugas kustom Anda.

Mengubah tampilan panel tugas

Anda bisa mengontrol ukuran dan lokasi panel tugas kustom dengan menggunakan properti CustomTaskPane objek. Anda bisa membuat banyak perubahan lain pada tampilan panel tugas kustom dengan menggunakan properti UserControl objek yang terkandung dalam panel tugas kustom. Misalnya, Anda dapat menentukan gambar latar belakang untuk panel tugas kustom dengan menggunakan BackgroundImage properti kontrol pengguna.

Tabel berikut ini mencantumkan perubahan yang bisa Anda buat pada panel tugas kustom dengan menggunakan CustomTaskPane properti.

Task Properti
Untuk mengubah ukuran panel tugas Height

Width
Untuk mengubah lokasi panel tugas DockPosition
Untuk menyembunyikan panel tugas atau membuatnya terlihat Visible
Untuk mencegah pengguna mengubah lokasi panel tugas DockPositionRestrict

Peristiwa panel tugas kustom program

Anda mungkin ingin Add-in VSTO Anda merespons saat pengguna memodifikasi panel tugas kustom. Misalnya, jika pengguna mengubah orientasi panel dari vertikal ke horizontal, Anda mungkin ingin memposisikan ulang kontrol.

Tabel berikut ini mencantumkan peristiwa yang bisa Anda tangani untuk merespons perubahan yang dilakukan pengguna ke panel tugas kustom.

Task Aktivitas
Untuk merespons saat pengguna mengubah lokasi panel tugas. DockPositionChanged
Untuk merespons saat pengguna menyembunyikan panel tugas atau membuatnya terlihat. VisibleChanged

Membersihkan sumber daya yang digunakan oleh panel tugas

Setelah Anda membuat panel tugas kustom, CustomTaskPane objek tetap berada dalam memori selama Add-in VSTO Anda berjalan. Objek tetap dalam memori bahkan setelah pengguna mengklik tombol Tutup (X) di sudut panel tugas.

Untuk membersihkan sumber daya yang digunakan oleh panel tugas saat Add-in VSTO masih berjalan, gunakan Remove metode atau RemoveAt . Metode ini menghapus objek yang ditentukan CustomTaskPane dari CustomTaskPanes koleksi, dan mereka memanggil Dispose metode objek.

Runtime Visual Studio Tools for Office secara otomatis membersihkan sumber daya yang digunakan oleh panel tugas kustom saat Add-in VSTO dibongkar. Jangan panggil Remove metode atau RemoveAt di penanganan ThisAddIn_Shutdown aktivitas di proyek Anda. Metode ini akan melempar ObjectDisposedException, karena runtime Visual Studio Tools for Office membersihkan sumber daya yang CustomTaskPane digunakan oleh objek sebelumnya ThisAddIn_Shutdown dipanggil. Untuk informasi selengkapnya tentang ThisAddIn_Shutdown, lihat Peristiwa di proyek Office.

Mengelola panel tugas kustom di beberapa jendela aplikasi

Saat Anda membuat panel tugas kustom di aplikasi yang menggunakan beberapa jendela untuk menampilkan dokumen dan item lain, Anda perlu mengambil langkah tambahan untuk memastikan bahwa panel tugas terlihat ketika pengguna mengharapkannya.

Panel tugas kustom di semua aplikasi dikaitkan dengan jendela bingkai dokumen, yang menyajikan tampilan dokumen atau item kepada pengguna. Panel tugas hanya terlihat saat jendela terkait terlihat. Namun, tidak semua aplikasi menggunakan jendela bingkai dokumen dengan cara yang sama.

Grup aplikasi berikut memiliki persyaratan pengembangan yang berbeda:

Outlook

Saat Anda membuat panel tugas kustom untuk Outlook, panel tugas kustom dikaitkan dengan jendela Penjelajah atau Pemeriksa tertentu. Penjelajah adalah jendela yang menampilkan isi folder, dan Pemeriksa adalah jendela yang menampilkan item seperti pesan email atau tugas.

Jika Anda ingin menampilkan panel tugas kustom dengan beberapa jendela Penjelajah atau Pemeriksa, Anda perlu membuat instans baru panel tugas kustom saat jendela Penjelajah atau Pemeriksa terbuka. Untuk melakukan ini, tangani peristiwa yang dinaikkan saat jendela Penjelajah atau Pemeriksa dibuat, lalu buat panel tugas di penanganan aktivitas. Anda juga dapat menangani peristiwa Explorer dan Inspector untuk menyembunyikan atau menampilkan panel tugas bergantung pada jendela mana yang terlihat.

Untuk mengaitkan panel tugas dengan Penjelajah atau Pemeriksa tertentu, gunakan Add metode untuk membuat panel tugas, dan teruskan Explorer objek atau Inspector ke parameter jendela . Untuk informasi selengkapnya tentang membuat panel tugas kustom, lihat Gambaran umum panel tugas kustom.

Mencegah beberapa instans panel tugas kustom di Outlook

Untuk mencegah jendela Outlook menampilkan beberapa instans panel tugas kustom, hapus panel tugas kustom secara eksplisit dari CustomTaskPanes kumpulan ThisAddIn kelas saat setiap jendela ditutup. Remove Panggil metode dalam peristiwa yang dinaikkan saat jendela ditutup, seperti Close atau Close.

Jika Anda tidak secara eksplisit menghapus panel tugas kustom, jendela Outlook mungkin menampilkan beberapa instans panel tugas kustom. Outlook terkadang mendaur ulang jendela, dan jendela daur ulang mempertahankan referensi ke panel tugas kustom apa pun yang dilampirkan ke jendela tersebut.

Word, InfoPath, dan PowerPoint

Word, InfoPath, dan PowerPoint menampilkan setiap dokumen di jendela bingkai dokumen yang berbeda. Saat Anda membuat panel tugas kustom untuk aplikasi ini, panel tugas kustom hanya dikaitkan dengan dokumen tertentu. Jika pengguna membuka dokumen lain, panel tugas kustom disembunyikan hingga dokumen sebelumnya terlihat lagi.

Jika Anda ingin menampilkan panel tugas kustom dengan beberapa dokumen, buat contoh baru panel tugas kustom saat pengguna membuat dokumen baru atau membuka dokumen yang sudah ada. Untuk melakukan ini, tangani peristiwa yang dinaikkan saat dokumen dibuat atau dibuka, lalu buat panel tugas di penanganan aktivitas. Anda juga dapat menangani peristiwa dokumen untuk menyembunyikan atau menampilkan panel tugas bergantung pada dokumen mana yang terlihat.

Untuk mengaitkan panel tugas dengan jendela dokumen tertentu, gunakan Add metode untuk membuat panel tugas, dan meneruskan Window (untuk Word), WindowObject (untuk InfoPath), atau DocumentWindow (untuk PowerPoint) ke parameter jendela .

Peristiwa Word

Untuk memantau status jendela dokumen di Word, Anda bisa menangani kejadian berikut ini:

Peristiwa InfoPath

Untuk memantau status jendela dokumen di InfoPath, Anda dapat menangani peristiwa berikut:

Peristiwa PowerPoint

Untuk memantau status jendela dokumen di PowerPoint, Anda bisa menangani peristiwa berikut: