Compartir a través de

DocData (Clase)

  • Artículo

Cuando se reemplaza en una clase derivada, representa un documento en la 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.11.0 (en Microsoft.VisualStudio.Modeling.Sdk.Shell.11.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 actual de documentos.
Propiedad pública DocViews Obtiene la colección de vistas de documentos que estén abiertos para el documento.
Propiedad pública Encoding Obtiene o establece la codificación que conserva 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 a la que el documento pertenece.
Propiedad protegida IsBackupFileObsolete
Propiedad pública IsLoaded Obtiene el documento y comprueba si se carga.
Propiedad pública ItemId Obtiene el Id. de elemento que se asigna al documento.
Propiedad protegida ServiceProvider Obtiene el proveedor de servicios de shell.
Propiedad pública UndoManager obtiene la interfaz de UndoManager para el documento.
Propiedad protegida UndoManagerIsShared Obtiene el documento y comprueba si más de un documento se comparte la misma interfaz de UndoManager .
Propiedad pública VSUndoManager obtiene la interfaz de UndoManager .

Arriba

Métodos

  Nombre Descripción
Método protegido BackupFile Haga una copia de seguridad de archivo de este documento.Devuelve si el documento es esperado recargar sin pérdida de datos.
Método protegido CanSave Comprueba si el usuario puede cancelar la operación.
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 del editor que creó el documento.
Método público GetCurFile Obtiene el nombre de archivo del documento.
Método público GetData Obtiene los datos 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 del editor que creó el objeto de IVsPersistDocData .
Método público GetHashCode Actúa como función hash para un tipo concreto. (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 produce cuando el documento con.
Método protegido HandleSaveDocDataException Administra cualquier excepción que se produce cuando el documento guardar.
Método público IgnoreFileChanges Determina si los cambios al documento deben omitirse.
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 Inicializar el documento.
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 sólo lectura.
Método público IsDocDataReloadable Comprueba si el documento pueda volver a cargarse.
Método protegido Load(String, Boolean) Carga el documento en la memoria.
Método público Load(String, UInt32, Int32) Carga el documento en la memoria.
Método público LoadDocData(String) Carga el documento utilizando su nombre de archivo.
Método protegido LoadDocData(String, Boolean) Carga el documento utilizando su nombre de archivo.
Método público MarkDocumentChangedForBackup Marcado como el documento ha cambiado y una nueva copia de seguridad debe crear así
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 agentes de escucha que el documento se cerró.
Método protegido OnDocumentClosing Alerta agentes de escucha que el documento se cierra.
Método protegido OnDocumentLoaded Alerta agentes de escucha que el documento se carga.
Método protegido OnDocumentLoading Alerta agentes de escucha que el documento se carga.
Método protegido OnDocumentReadOnlyChanged Alerta agentes de escucha que el estado de sólo lectura del documento ha cambiado.
Método protegido OnDocumentReloaded Alerta agentes de escucha que se ha recargado el documento.
Método protegido OnDocumentReloading Alerta agentes de escucha que el documento se vuelva a cargar.
Método protegido OnDocumentSaved Alerta agentes de escucha que se ha guardado el documento.
Método protegido OnDocumentSaving Alerta agentes de escucha que el documento se guardarán.
Método protegido OnFileNameChanged Alerta agentes de escucha que el nombre de archivo de documento ha cambiado.
Método protegido OnHierarchyChanged Alerta agentes de escucha que el Id. de elemento que se asigna al documento ha cambiado.
Método público OnRegisterDocData Asigna el documento en una jerarquía de la cookie y del proyecto.
Método público OpenView Abra una vista concreta para el documento.
Método público QueryEditFile() Alerta agentes de escucha que un documento se va a modificar.Los agentes de escucha pueden votar en la edición.
Método público QueryEditFile(String, tagVSQueryEditFlags) Alerta agentes de escucha que un documento se va a modificar.Los agentes de escucha pueden votar en la edición.
Método público QuerySaveFile() Alerta agentes de escucha que un archivo está a punto de ser guardado.Los agentes de escucha pueden
Método público QuerySaveFile(String, tagVSQuerySaveFlags) Alerta agentes de escucha que un archivo está a punto de ser guardado.
Método público ReloadDocData Recarga el documento.
Método protegido ReloadDocDataWorker Recarga el documento.
Método público RenameDocData Cambia un documento y restaura 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 agentes de escucha que se ha guardado el documento.
Método público SaveDocData Guarda el documento en una ubicación concreta.
Método protegido SaveDocDataToFile Guarda el documento en una ubicación concreta.
Método protegido SaveSubordinateFile Guarde el documento especificado que es subordinado a este documento, por ejemplo un diagrama.
Método público SetData Establece el documento en un búfer.
Método público SetDocDataDirty Establece la marca de IsDirty del documento.
Método público SetDocDataReadOnly Establece la marca de sólo lectura del documento.
Método protegido SetFileName Inicializa o cambia el nombre de archivo del documento.
Método protegido SetHierarchyInfo Inicializa o la jerarquía del documento.
Método público SetUntitledDocPath Actualmente no implementado.
Método público ShowSaveOptionsDlg Muestra un cuadro de diálogo de que el usuario pueda especificar opciones adicionales para los formatos de almacenamiento.
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 que se cierre el documento.
Evento público DocumentClosing Se produce antes de cerrar el documento.
Evento público DocumentLoaded Se produce cuando el documento se haya cargado en la ventana de modelado.
Evento público DocumentLoading Se produce antes de que el documento se carga en la ventana de modelado.
Evento público DocumentReadOnlyChanged Se produce cuando el indicador de sólo lectura para el documento cambia.
Evento público DocumentReloaded Se produce después de que se vuelva a cargar el documento.
Evento público DocumentReloading Se produce antes de que se vuelva a cargar el documento.
Evento público DocumentSaved Se produce después de que se guarda el documento.
Evento público DocumentSaving Se produce antes de que se guarde el documento.
Evento público FileNameChanged Se produce cuando cambia el nombre de archivo del documento.
Evento público HierarchyChanged Se produce cuando la jerarquía del documento o el Id. de elemento.

Arriba

Implementaciones explícitas de interfaces

  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 la clase de generador de editor 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 los eventos para los documentos externos y puede preguntar al usuario al 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)