IVsAsyncShellOpenDocument.OpenSpecificEditorAsync Metode
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.
Secara asinkron membuka dokumen menggunakan editor yang ditentukan.
public Microsoft.VisualStudio.Shell.Interop.IVsTask OpenSpecificEditorAsync (uint openSpecificEditorFlags, string documentMoniker, Guid editorType, string? physicalView, Guid logicalView, string? ownerCaption, Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy? hierarchy, uint itemId, bool shouldGetDocDataFromRdt, object? docData, Microsoft.VisualStudio.OLE.Interop.IServiceProvider serviceProvider);
abstract member OpenSpecificEditorAsync : uint32 * string * Guid * string * Guid * string * Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy * uint32 * bool * obj * Microsoft.VisualStudio.OLE.Interop.IServiceProvider -> Microsoft.VisualStudio.Shell.Interop.IVsTask
Public Function OpenSpecificEditorAsync (openSpecificEditorFlags As UInteger, documentMoniker As String, editorType As Guid, physicalView 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
- openSpecificEditorFlags
- UInt32
Bendera yang nilainya diambil dari __VSOSPEFLAGS 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.
- physicalView
- String
Nama tampilan fisik atau null.
Jika null, lingkungan memanggil MapLogicalView(Guid, String) di pabrik editor untuk menentukan tampilan fisik yang sesuai dengan tampilan logis.
Dalam hal ini, null tidak menentukan tampilan utama, melainkan menunjukkan bahwa Anda tidak tahu tampilan mana yang sesuai dengan tampilan logis.
- 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
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.