Bagikan melalui

Add-in VsTO Program

  • Artikel

Saat Anda memperluas Microsoft aplikasi Office lication dengan membuat Add-in VSTO, Anda menulis kode langsung terhadap ThisAddIn kelas di proyek Anda. Anda dapat menggunakan kelas ini untuk melakukan tugas seperti mengakses model objek aplikasi host Microsoft Office, menyesuaikan antarmuka pengguna (UI) aplikasi, dan mengekspos objek di Add-in VSTO Anda ke solusi Office lainnya.

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

Beberapa aspek penulisan kode dalam proyek Add-in VSTO berbeda dari jenis proyek lain di Visual Studio. Banyak dari perbedaan ini disebabkan oleh cara model objek Office diekspos ke kode terkelola. Untuk informasi selengkapnya, lihat Menulis kode di solusi Office.

Untuk informasi umum tentang Add-in VSTO dan jenis solusi lain yang bisa Anda buat dengan menggunakan alat pengembangan Office di Visual Studio, lihat Gambaran umum pengembangan solusi Office (VSTO).

Menggunakan kelas ThisAddIn

Anda dapat mulai menulis kode Add-in VSTO Anda di ThisAddIn kelas . Visual Studio secara otomatis menghasilkan kelas ini di file kode ThisAddIn.vb (di Visual Basic) atau ThisAddIn.cs (dalam C#) di proyek Add-in VSTO Anda. Runtime Visual Studio Tools for Office secara otomatis membuat instans kelas ini untuk Anda saat Microsoft aplikasi Office lication memuat Add-in VSTO Anda.

Ada dua penanganan aktivitas default di ThisAddIn kelas . Untuk menjalankan kode saat Add-in VSTO dimuat, tambahkan kode ke penanganan ThisAddIn_Startup aktivitas. Untuk menjalankan kode tepat sebelum Add-in VSTO dibongkar, tambahkan kode ke penanganan ThisAddIn_Shutdown aktivitas. Untuk informasi selengkapnya tentang penanganan aktivitas ini, lihat Peristiwa di proyek Office.

Catatan

Di Outlook, secara default ThisAddIn_Shutdown penanganan aktivitas tidak selalu dipanggil ketika Add-in VSTO dibongkar. Untuk informasi selengkapnya, lihat Peristiwa di proyek Office.

Mengakses model objek aplikasi host

Untuk mengakses model objek aplikasi host, gunakan Application bidang ThisAddIn kelas . Bidang ini mengembalikan objek yang mewakili instans aplikasi host saat ini. Tabel berikut mencantumkan jenis nilai pengembalian untuk Application bidang di setiap proyek Add-in VSTO.

Aplikasi host Jenis nilai yang dikembalikan
Microsoft Office Excel Application
Microsoft Office InfoPath Application
Microsoft Office Outlook Application
Microsoft Office PowerPoint Aplikasi
Proyek Microsoft Office Microsoft.Office.Interop.MSProject.Application
Microsoft Office Visio Microsoft.Office.Interop.Visio.Application
Microsoft Office Word Application

Contoh kode berikut menunjukkan cara menggunakan Application bidang untuk membuat buku kerja baru di Add-in VSTO untuk Microsoft Office Excel. Contoh ini dimaksudkan untuk dijalankan dari ThisAddIn kelas .

Excel.Workbook newWorkbook = this.Application.Workbooks.Add(System.Type.Missing);

Untuk melakukan hal yang sama dari luar ThisAddIn kelas, gunakan Globals objek untuk mengakses ThisAddIn kelas. Untuk informasi selengkapnya tentang objek, Globals lihat Akses global ke objek di proyek Office.

Excel.Workbook newWorkbook = Globals.ThisAddIn.Application.Workbooks.Add(System.Type.Missing);

Untuk informasi selengkapnya tentang model objek Microsoft aplikasi Office lications tertentu, lihat topik berikut:

Mengakses dokumen saat aplikasi Office likasi dimulai

Tidak semua aplikasi Office 2010 secara otomatis membuka dokumen saat Anda memulainya, dan tidak ada aplikasi Office 2013 yang membuka dokumen saat Anda memulainya. Oleh karena itu, jangan tambahkan kode di ThisAdd-In_Startup penanganan aktivitas jika kode mengharuskan dokumen terbuka. Sebagai gantinya, tambahkan kode tersebut ke peristiwa yang dimunculkan aplikasi Office likasi saat pengguna membuat atau membuka dokumen. Dengan demikian, Anda dapat menjamin bahwa dokumen terbuka sebelum kode Anda melakukan operasi di atasnya.

Contoh kode berikut berfungsi dengan dokumen di Word hanya saat pengguna membuat dokumen atau membuka dokumen yang sudah ada.

    private void ThisAddIn_Startup(object sender, System.EventArgs e)
    {
        this.Application.DocumentOpen +=
new Word.ApplicationEvents4_DocumentOpenEventHandler(WorkWithDocument);

        ((Word.ApplicationEvents4_Event)this.Application).NewDocument +=
            new Word.ApplicationEvents4_NewDocumentEventHandler(WorkWithDocument);  
    }
    
    private void WorkWithDocument(Microsoft.Office.Interop.Word.Document Doc)
    {
        try
        {
            Word.Range rng = Doc.Range(0, 0);
            rng.Text = "New Text";
            rng.Select();
        }
        catch (Exception ex)
        {
            // Handle exception if for some reason the document is not available.
        }
    }

Anggota ThisAddIn yang akan digunakan untuk tugas lain

Tabel berikut ini menjelaskan tugas umum lainnya dan memperlihatkan anggota ThisAddIn kelas mana yang bisa Anda gunakan untuk melakukan tugas.

Task Anggota yang akan digunakan
Jalankan kode untuk menginisialisasi Add-in VSTO saat Add-in VSTO dimuat. Tambahkan kode ke ThisAddIn_Startup metode . Ini adalah penanganan aktivitas default untuk peristiwa tersebut Startup . Untuk informasi selengkapnya, lihat Peristiwa di proyek Office.
Jalankan kode untuk membersihkan sumber daya yang digunakan oleh Add-in VSTO sebelum Add-in VSTO dibongkar. Tambahkan kode ke ThisAddIn_Shutdown metode . Ini adalah penanganan aktivitas default untuk peristiwa tersebut Shutdown . Untuk informasi selengkapnya, lihat Peristiwa di proyek Office. Catatan: Di Outlook, secara default ThisAddIn_Shutdown penanganan aktivitas tidak selalu dipanggil saat Add-in VSTO dibongkar. Untuk informasi selengkapnya, lihat Peristiwa di proyek Office.
Menampilkan panel tugas kustom. CustomTaskPanes Gunakan bidang . Untuk informasi selengkapnya, lihat Panel tugas kustom.
Mengekspos objek di Add-in VSTO Anda ke solusi Microsoft Office lainnya. Ambil alih metode RequestComAddInAutomationService. Untuk informasi selengkapnya, lihat Kode panggilan di Add-in VSTO dari solusi Office lainnya.
Kustomisasi fitur dalam sistem Microsoft Office dengan menerapkan antarmuka ekstensibilitas. Ambil alih RequestService metode untuk mengembalikan instans kelas yang mengimplementasikan antarmuka. Untuk informasi selengkapnya, lihat Menyesuaikan fitur UI dengan menggunakan antarmuka ekstensibilitas. Catatan: Untuk mengkustomisasi UI pita, Anda juga bisa mengambil CreateRibbonExtensibilityObject alih metode .

Memahami desain kelas ThisAddIn

Dalam proyek yang menargetkan .NET Framework 4, AddIn adalah antarmuka. Kelas ThisAddIn berasal dari kelas AddInBase. Kelas dasar ini mengalihkan semua panggilan ke anggotanya ke implementasi AddIn internal antarmuka di runtime Visual Studio Tools for Office .

Dalam proyek Add-in VSTO untuk Outlook, ThisAddIn kelas berasal dari Microsoft.Office.Tools.Outlook.OutlookAddIn kelas dalam proyek yang menargetkan .NET Framework 3.5, dan dari OutlookAddInBase dalam proyek yang menargetkan .NET Framework 4. Kelas dasar ini menyediakan beberapa fungsionalitas tambahan untuk mendukung wilayah formulir. Untuk informasi selengkapnya tentang wilayah formulir, lihat Membuat wilayah formulir Outlook.

Mengkustomisasi antarmuka pengguna Microsoft aplikasi Office lications

Anda dapat menyesuaikan UI Microsoft aplikasi Office likasi secara terprogram dengan menggunakan Add-in VSTO. Misalnya, Anda bisa mengkustomisasi pita, menampilkan panel tugas kustom, atau membuat wilayah formulir kustom di Outlook. Untuk informasi selengkapnya, lihat Kustomisasi Office UI.

Visual Studio menyediakan perancang dan kelas yang bisa Anda gunakan untuk membuat panel tugas kustom, kustomisasi pita, dan wilayah formulir Outlook. Perancang dan kelas ini membantu menyederhanakan proses penyesuaian fitur-fitur ini. Untuk informasi selengkapnya, lihat Panel tugas kustom, Perancang Pita, dan Membuat wilayah formulir Outlook.

Jika Anda ingin menyesuaikan salah satu fitur ini dengan cara yang tidak didukung oleh kelas dan desainer, Anda juga dapat menyesuaikan fitur-fitur ini dengan menerapkan antarmuka ekstensibilitas di Add-in VSTO Anda. Untuk informasi selengkapnya, lihat Menyesuaikan fitur UI dengan menggunakan antarmuka ekstensibilitas.

Selain itu, Anda bisa mengubah UI dokumen Word dan buku kerja Excel dengan membuat item host yang memperluas perilaku dokumen dan buku kerja. Ini memungkinkan Anda menambahkan kontrol terkelola ke dokumen dan lembar kerja. Untuk informasi selengkapnya, lihat Memperluas dokumen Word dan buku kerja Excel di Add-in VSTO pada waktu proses.

Kode panggilan di Add-in VSTO dari solusi lain

Anda dapat mengekspos objek di Add-in VSTO Anda ke solusi lain, termasuk solusi Office lainnya. Ini berguna jika Add-in VSTO Anda menyediakan layanan yang ingin Anda aktifkan solusi lain untuk digunakan. Misalnya, jika Anda memiliki Add-in VSTO untuk Microsoft Office Excel yang melakukan penghitungan pada data keuangan dari layanan web, solusi lain dapat melakukan penghitungan ini dengan memanggil add-in Excel VSTO pada durasi.

Untuk informasi selengkapnya, lihat Kode panggilan di Add-in VSTO dari solusi Office lainnya.

Konten terkait