IVsAsyncShellOpenDocument.OpenStandardEditorAsync Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Abre un archivo mediante el editor estándar. En primer lugar, determinará si ya está configurado un generador de editores predeterminado para el archivo. Si un valor predeterminado aún no está configurado, recorrerá una lista ordenada por prioridad de generadores de editores para buscar la primera que admita el documento. Se produce una excepción si no se puede abrir el documento.
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
Parámetros
- openStandardEditorFlags
- UInt32
Marcas cuyos valores se toman de la __VSOSEFLAGS enumeración o __VSOSEFLAGS2 .
- documentMoniker
- String
Forma de cadena del identificador de moniker único del documento en el sistema del proyecto, por ejemplo, la ruta de acceso completa al archivo. En casos de no archivo, este identificador suele tener el formato de una dirección URL.
- logicalView
- Guid
Que Guid identifica la vista lógica. La vista predeterminada es VSConstants.LOGVIEWID_Primary
y todos los editores deben admitir esa vista.
Si el editor implementa IVsMultiViewDocumentView en el objeto de vista de documento, el valor pasado a ActivateLogicalView(Guid), que determina qué vista se activa cuando se muestra la ventana del editor.
Al especificar la vista Guidlógica , puede solicitar la vista específica que coincida con el motivo por el que solicita la vista.
Por ejemplo, especifique VSConstants.LOGVIEWID_Debugging
para obtener la vista adecuada para la depuración o VSConstants.LOGVIEWID_TextView
para obtener la vista adecuada para el editor de texto (es decir, una vista que implementa IVsCodeWindow).
- ownerCaption
- String
La subtítulo inicial definida por el propietario del documento (es decir, el proyecto) de la ventana del documento. Esto tiene a menudo el formato: "ProjectName – ItemName".
- hierarchy
- IVsUIHierarchy
Referencia al IVsUIHierarchy que posee el documento.
- itemId
- UInt32
Identificador de elemento de jerarquía de la interfaz de usuario del editor estándar. Para obtener más información, vea VSConstants.VSITEMID
.
- shouldGetDocDataFromRdt
- Boolean
Si true
es , el entorno usará el objeto de datos de documento obtenido de la tabla de documentos en ejecución; de lo contrario, el servicio abrirá el documento mediante los datos del documento pasados a docData
.
- docData
- Object
Referencia al objeto de datos del documento del elemento que se va a abrir o null
. Este valor pasado a este parámetro se omite si shouldGetDocDataFromRdt
es true
.
- serviceProvider
- IServiceProvider
Una referencia a IServiceProvider.
Devoluciones
Tarea que representa que se ha iniciado la operación de apertura.
El resultado de la tarea es una referencia a , IVsAsyncOpenDocumentResultsi el documento se abrió en el entorno; de lo contrario, null
.
Comentarios
La tarea devuelta por este método no indica que la vista del documento y los datos docdata se han cargado. Para obtener más información, consulte DocumentLoadTask.
Este método usa el resultado de CreateEditorInstance(UInt32, String, String, IVsHierarchy, UInt32, IntPtr, IntPtr, IntPtr, String, Guid, Int32) para determinar si debe continuar en bucle al siguiente editor de la lista para buscar un generador de editores compatible. En concreto, debe devolver uno de los siguientes: 1. S_OK
para indicar que debe detener el bucle si el editor admite el archivo y se inicializó correctamente 2. "VS_E_UNSUPPORTEDFORMAT"
para indicar que debe continuar en bucle si el editor no admite los datos de documento proporcionados 3. Cualquier otro código de error que indique que debe detener el bucle.