IVsAsyncShellOpenDocument.OpenStandardEditorAsync Metode

Referensi

Definisi

Ruang nama:: Microsoft.VisualStudio.Shell.Interop

Rakitan:: Microsoft.VisualStudio.Interop.dll

Paket:: Microsoft.VisualStudio.Interop v17.9.37000

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.

Membuka file menggunakan editor standar. Ini pertama-tama akan menentukan apakah pabrik editor default untuk file sudah dikonfigurasi. Jika default belum dikonfigurasi, maka akan mengulang daftar pabrik editor yang diurutkan prioritas untuk menemukan yang pertama yang mendukung dokumen. Pengecualian dilemparkan jika dokumen tidak dapat dibuka.

public Microsoft.VisualStudio.Shell.Interop.IVsTask OpenStandardEditorAsync (uint openStandardEditorFlags, string documentMoniker, Guid logicalView, string? ownerCaption, Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy? hierarchy, uint itemId, bool shouldGetDocDataFromRdt, object? docData, Microsoft.VisualStudio.OLE.Interop.IServiceProvider serviceProvider);

abstract member OpenStandardEditorAsync : uint32 * string * Guid * string * Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy * uint32 * bool * obj * Microsoft.VisualStudio.OLE.Interop.IServiceProvider -> Microsoft.VisualStudio.Shell.Interop.IVsTask

Public Function OpenStandardEditorAsync (openStandardEditorFlags As UInteger, documentMoniker As String, logicalView As Guid, ownerCaption As String, hierarchy As IVsUIHierarchy, itemId As UInteger, shouldGetDocDataFromRdt As Boolean, docData As Object, serviceProvider As IServiceProvider) As IVsTask

Parameter

openStandardEditorFlags: UInt32

Bendera yang nilainya diambil dari __VSOSEFLAGS atau __VSOSEFLAGS2 enumerasi.

documentMoniker: String

Bentuk string pengidentifikasi moniker unik dokumen dalam sistem proyek, misalnya, jalur lengkap ke file. Dalam kasus non-file, pengidentifikasi ini sering dalam bentuk URL.

logicalView: Guid

Guid Mengidentifikasi tampilan logis. Tampilan default adalah VSConstants.LOGVIEWID_Primary dan setiap editor harus mendukung tampilan tersebut.

Jika editor mengimplementasikan IVsMultiViewDocumentView pada objek tampilan dokumen, maka nilai yang diteruskan ke ActivateLogicalView(Guid), yang menentukan tampilan mana yang diaktifkan saat jendela editor ditampilkan.

Dengan menentukan tampilan Guidlogis , Anda dapat meminta tampilan tertentu yang cocok dengan alasan Anda meminta tampilan. Misalnya, tentukan VSConstants.LOGVIEWID_Debugging untuk mendapatkan tampilan yang sesuai untuk penelusuran kesalahan, atau VSConstants.LOGVIEWID_TextView untuk mendapatkan tampilan yang sesuai untuk editor teks (yaitu, tampilan yang mengimplementasikan IVsCodeWindow).

ownerCaption: String

Caption awal yang ditentukan oleh pemilik dokumen (yaitu, proyek) untuk jendela dokumen. Ini sering kali berupa: "ProjectName – ItemName."

hierarchy: IVsUIHierarchy

Referensi ke yang IVsUIHierarchy memiliki dokumen.

itemId: UInt32

Pengidentifikasi item hierarki UI editor standar. Untuk informasi selengkapnya, lihat VSConstants.VSITEMID.

shouldGetDocDataFromRdt: Boolean

Jika true, maka lingkungan akan menggunakan objek data dokumen yang diperoleh dari Tabel Dokumen Yang Berjalan; jika tidak, layanan akan membuka dokumen menggunakan data dokumen yang diteruskan ke docData.

docData: Object

Referensi ke objek data dokumen item untuk dibuka atau null. Nilai yang diteruskan ke parameter ini diabaikan jika shouldGetDocDataFromRdt adalah true.

serviceProvider: IServiceProvider

Referensi ke IServiceProvider.

Mengembalikan

IVsTask

Tugas yang menunjukkan bahwa operasi terbuka telah dimulai. Hasil tugas adalah referensi ke IVsAsyncOpenDocumentResult, jika dokumen dibuka dalam lingkungan; jika tidak, null.

Keterangan

Tugas yang dikembalikan oleh metode ini tidak menunjukkan bahwa tampilan dokumen dan docdata telah dimuat. Lihat DocumentLoadTask untuk detail selengkapnya.

Metode ini menggunakan hasil CreateEditorInstance(UInt32, String, String, IVsHierarchy, UInt32, IntPtr, IntPtr, IntPtr, String, Guid, Int32) untuk menentukan apakah harus terus mengulang ke editor berikutnya dalam daftar untuk menemukan pabrik editor yang didukung. Secara khusus, ini harus mengembalikan salah satu hal berikut: 1. S_OK untuk menunjukkan bahwa itu harus berhenti mengulang jika editor mendukung file dan berhasil diinisialisasi 2. "VS_E_UNSUPPORTEDFORMAT" untuk menunjukkan bahwa itu harus terus mengulang jika editor tidak mendukung data dokumen 3 yang disediakan. Kode kesalahan lainnya untuk menunjukkan bahwa kode tersebut harus berhenti mengulang.

Berlaku untuk

Bagikan melalui