Compartir a través de

DocData (Clase)

  • Artículo

Cuando se reemplaza en una clase derivada, representa un documento en memoria.

Esta API no es conforme a CLS. 

Jerarquía de herencia

System.Object
  System.MarshalByRefObject
    Microsoft.VisualStudio.Modeling.Shell.DocData
      Microsoft.VisualStudio.Modeling.Shell.ModelingDocData
      Microsoft.VisualStudio.Modeling.Shell.SubordinateDocData

Espacio de nombres:  Microsoft.VisualStudio.Modeling.Shell
Ensamblado:  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (en Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Sintaxis

'Declaración
<CLSCompliantAttribute(False)> _
Public MustInherit Class DocData _
    Inherits MarshalByRefObject _
    Implements IVsPersistDocData2, IVsPersistDocData, IVsFileChangeEvents, IVsDocDataFileChangeControl,  _
    IPersistFileFormat, IPersist, IDisposable, IVsSaveOptionsDlg, IVsUserData,  _
    IVsFileBackup, IServiceProvider

[CLSCompliantAttribute(false)]
public abstract class DocData : MarshalByRefObject, 
    IVsPersistDocData2, IVsPersistDocData, IVsFileChangeEvents, IVsDocDataFileChangeControl, IPersistFileFormat, 
    IPersist, IDisposable, IVsSaveOptionsDlg, IVsUserData, IVsFileBackup, 
    IServiceProvider

El tipo DocData expone los siguientes miembros.

Constructores

  Nombre Descripción
Método protegido DocData Inicializa una nueva instancia de la clase DocData.

Arriba

Propiedades

  Nombre Descripción
Propiedad pública Cookie Obtiene la cookie que identifica el documento en la tabla Documentos en ejecución.
Propiedad pública DocViews Obtiene la colección de vistas de documentos que están abiertas para el documento.
Propiedad pública Encoding Obtiene o establece la codificación que persiste en el documento.
Propiedad pública FileName Obtiene el nombre de archivo del documento.
Propiedad protegida FormatList Obtiene una lista de formatos.
Propiedad pública Hierarchy Obtiene la jerarquía del proyecto al que pertenece el documento.
Propiedad protegida IsBackupFileObsolete
Propiedad pública IsLoaded Obtiene el documento y comprueba si se carga.
Propiedad pública ItemId Obtiene el identificador de elemento asignado al documento.
Propiedad protegida ServiceProvider Obtiene el proveedor de servicio del shell.
Propiedad pública UndoManager Obtiene la interfaz UndoManager para el documento.
Propiedad protegida UndoManagerIsShared Obtiene el documento y comprueba si más de un documento comparte la misma interfaz UndoManager .
Propiedad pública VSUndoManager Obtiene la interfaz UndoManager.

Arriba

Métodos

  Nombre Descripción
Método protegido BackupFile Haga una copia de seguridad de archivo de este documento.Devuelve si se espera que el documento vuelva a cargarse sin pérdida de datos.
Método protegido CanSave Comprueba si el usuario puede cancelar la operación de guardar.
Método público Close Cierra el documento.
Método público CreateObjRef Crítico para la seguridad. Crea un objeto que contiene toda la información relevante necesaria para generar un proxy utilizado para comunicarse con un objeto remoto. (Se hereda de MarshalByRefObject).
Método público DirectoryChanged No implementado actualmente.
Método protegido Dispose Libera los recursos no administrados que utiliza DocData y libera los recursos administrados de forma opcional.
Método público Equals Determina si el objeto especificado es igual al objeto actual. (Se hereda de Object).
Método público FilesChanged Notifica a los clientes que uno o más documentos han cambiado.
Método protegido Finalize Permite que un objeto intente liberar recursos y realizar otras operaciones de limpieza antes de ser reclamado por la recolección de elementos no utilizados. (Se hereda de Object).
Método público FlushUndoManager Borra la colección UndoManager.
Método público GetClassID Obtiene el GUID del generador de editores que creó el documento.
Método público GetCurFile Obtiene el nombre de archivo del documento.
Método público GetData Obtiene los datos del documento de un búfer.
Método público GetFormatList Obtiene la lista de formatos de documento admitidos.
Método público GetGuidEditorType Obtiene el GUID del generador de editores que creó el objeto IVsPersistDocData.
Método público GetHashCode Sirve como la función hash predeterminada. (Se hereda de Object).
Método público GetLifetimeService Crítico para la seguridad. Recupera el objeto de servicio de duración actual que controla la directiva de duración de esta instancia. (Se hereda de MarshalByRefObject).
Método público GetService Devuelve el servicio solicitado.
Método público GetType Obtiene el objeto Type de la instancia actual. (Se hereda de Object).
Método protegido HandleLoadDocDataException Administra cualquier excepción que se produjera cuando se estaba cargando el documento.
Método protegido HandleSaveDocDataException Administra cualquier excepción que se produjera cuando se estaba guardando el documento.
Método público IgnoreFileChanges Determina si se deben omitir los cambios realizados en el documento.
Método público InitializeLifetimeService Crítico para la seguridad. Obtiene un objeto de servicio de duración para controlar la directiva de duración de esta instancia. (Se hereda de MarshalByRefObject).
Método público InitNew Inicializa el documento especificado.
Método público IsDirty Comprueba si el documento ha cambiado desde la operación más reciente de guardar.
Método público IsDocDataDirty Comprueba si el documento ha cambiado desde la operación más reciente de guardar.
Método público IsDocDataReadOnly Comprueba si el documento es de solo lectura.
Método público IsDocDataReloadable Comprueba si el documento puede recargarse.
Método protegido Load(String, Boolean) Carga el documento en memoria.
Método público Load(String, UInt32, Int32) Carga el documento en memoria.
Método público LoadDocData(String) Carga el documento usando su nombre de archivo.
Método protegido LoadDocData(String, Boolean) Carga el documento usando su nombre de archivo.
Método público MarkDocumentChangedForBackup Marque que el documento ha cambiado y, en consecuencia, debe crearse una nueva copia de seguridad
Método protegido MemberwiseClone() Crea una copia superficial del objeto Object actual. (Se hereda de Object).
Método protegido MemberwiseClone(Boolean) Crea una copia superficial del objeto MarshalByRefObject actual. (Se hereda de MarshalByRefObject).
Método protegido OnDocumentClosed Alerta a los agentes de escucha de que el documento se cerró.
Método protegido OnDocumentClosing Alerta a los agentes de escucha de que el documento se cerrará.
Método protegido OnDocumentLoaded Alerta a los agentes de escucha de que el documento se carga.
Método protegido OnDocumentLoading Alerta a los agentes de escucha de que el documento se cargará.
Método protegido OnDocumentReadOnlyChanged Alerta a los agentes de escucha que el estado de solo lectura del documento ha cambiado.
Método protegido OnDocumentReloaded Alerta a los agentes de escucha de que se ha recargado el documento.
Método protegido OnDocumentReloading Alerta a los agentes de escucha de que el documento se recargará.
Método protegido OnDocumentSaved Alerta a los agentes de escucha de que se ha guardado el documento.
Método protegido OnDocumentSaving Alerta a los agentes de escucha de que el documento se guardará.
Método protegido OnFileNameChanged Alerta a los agentes de escucha de que el nombre de archivo de documento ha cambiado.
Método protegido OnHierarchyChanged Alerta a los agentes de escucha de que el identificador del elemento que se asigna al documento ha cambiado.
Método público OnRegisterDocData Asigna el documento en una jerarquía de proyecto y cookie.
Método público OpenView Abre una vista concreta para el documento.
Método público QueryEditFile() Alerta a los agentes de escucha de que un documento se va a modificar.Los agentes de escucha pueden votar contra la edición.
Método público QueryEditFile(String, tagVSQueryEditFlags) Alerta a los agentes de escucha de que un documento se va a modificar.Los agentes de escucha pueden votar contra la edición.
Método público QuerySaveFile() Alerta a los agentes de escucha de que un archivo se va a guardar.Los agentes de escucha pueden
Método público QuerySaveFile(String, tagVSQuerySaveFlags) Alerta a los agentes de escucha de que un archivo se va a guardar.
Método público ReloadDocData Recarga el documento.
Método protegido ReloadDocDataWorker Recarga el documento.
Método público RenameDocData Cambia un documento de nombre y restablece su posición en la jerarquía.
Método protegido ResumeFileChangeNotification Reanuda la distribución de las notificaciones de cambios del documento.
Método protegido Save(String) Guarda el documento.
Método público Save(String, Int32, UInt32) Guarda el documento.
Método público SaveCompleted Alerta a los agentes de escucha de que se ha guardado el documento.
Método público SaveDocData Guarda el documento en una ubicación específica.
Método protegido SaveDocDataToFile Guarda el documento en una ubicación específica.
Método protegido SaveSubordinateFile Guarde el documento especificado subordinado a este documento, por ejemplo un archivo de diagrama.
Método público SetData Establece el documento en un búfer.
Método público SetDocDataDirty Establece la marca IsDirty del documento.
Método público SetDocDataReadOnly Establece la marca de solo lectura del documento.
Método protegido SetFileName Inicializa o cambia el nombre de archivo del documento.
Método protegido SetHierarchyInfo Inicializa o cambia la jerarquía de proyectos para el documento.
Método público SetUntitledDocPath Actualmente no implementado.
Método público ShowSaveOptionsDlg Muestra un cuadro de diálogo desde el que el usuario puede especificar opciones adicionales para los formatos de guardado.
Método protegido SuspendFileChangeNotification Suspende la distribución de las notificaciones de cambios del documento.
Método público ToString Devuelve una cadena que representa el objeto actual. (Se hereda de Object).

Arriba

Eventos

  Nombre Descripción
Evento público DocumentClosed Se produce después de haberse cerrado el documento.
Evento público DocumentClosing Se produce antes de cerrar el documento.
Evento público DocumentLoaded Se produce una vez cargado el documento en la ventana de modelado.
Evento público DocumentLoading Se produce antes de la carga del documento en la ventana de modelado.
Evento público DocumentReadOnlyChanged Se produce al cambiar la marca de solo lectura del documento.
Evento público DocumentReloaded Se produce después de haberse recargado el documento.
Evento público DocumentReloading Se produce antes de que se recargue el documento.
Evento público DocumentSaved Se produce una vez que se ha guardado el documento.
Evento público DocumentSaving Se produce antes de que se guarde el documento.
Evento público FileNameChanged Se produce al cambiar el nombre de archivo del documento.
Evento público HierarchyChanged Se produce al cambiar el identificador de elemento o la jerarquía del documento.

Arriba

Implementaciones de interfaz explícita

  Nombre Descripción
Implementación explícita de interfacesMétodo privado IVsFileBackup.BackupFile Haga una copia de seguridad de archivo de este documento.
Implementación explícita de interfacesMétodo privado IDisposable.Dispose Libera todos los recursos usados por la instancia actual de la clase DocData.
Implementación explícita de interfacesMétodo privado IPersistFileFormat.GetClassID Obtiene el identificador de clase del generador de editores que creó el documento.
Implementación explícita de interfacesMétodo privado IVsFileBackup.IsBackupFileObsolete Obtiene si el archivo de copia de seguridad está actualizado.

Arriba

Comentarios

Esta clase también escucha para cambiar eventos para los documentos externos y puede preguntar al usuario a cargar el documento.

Seguridad para subprocesos

Todos los miembros static (Shared en Visual Basic) públicos de este tipo son seguros para la ejecución de subprocesos. No se garantiza que los miembros de instancias sean seguros para la ejecución de subprocesos.

Vea también

Referencia

Microsoft.VisualStudio.Modeling.Shell (Espacio de nombres)