Compartir a través de

SubordinateDocData (Clase)

  • Artículo

Objeto DocData que representa un archivo subordinado de la memoria (representado como un elemento de proyecto secundario en el Explorador de soluciones).

Esta API no es conforme a CLS. 

Jerarquía de herencia

System.Object
  System.MarshalByRefObject
    Microsoft.VisualStudio.Modeling.Shell.DocData
      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 Class SubordinateDocData _
    Inherits DocData

[CLSCompliantAttribute(false)]
public class SubordinateDocData : DocData

El tipo SubordinateDocData expone los siguientes miembros.

Constructores

  Nombre Descripción
Método público SubordinateDocData Crea una instancia de SubordinateDocData.

Arriba

Propiedades

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

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. (Se hereda de DocData).
Método protegido CanSave Comprueba si el usuario puede cancelar la operación de guardar. (Se hereda de DocData).
Método público Close Cierra el documento. (Se hereda de DocData).
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. (Se hereda de DocData).
Método protegido Dispose Libera los recursos no administrados que utiliza DocData y libera los recursos administrados de forma opcional. (Se hereda de DocData).
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. (Se hereda de DocData).
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. (Se hereda de DocData).
Método público GetClassID Obtiene el GUID del generador de editores que creó el documento. (Se hereda de DocData).
Método público GetCurFile Obtiene el nombre de archivo del documento. (Se hereda de DocData).
Método público GetData Obtiene los datos del documento de un búfer. (Se hereda de DocData).
Método público GetFormatList Obtiene la lista de formatos de documento admitidos. (Se hereda de DocData).
Método público GetGuidEditorType Obtiene el GUID del generador de editores que creó el objeto IVsPersistDocData. (Se hereda de DocData).
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. (Se hereda de DocData).
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. (Se hereda de DocData).
Método protegido HandleSaveDocDataException Administra cualquier excepción que se produjera cuando se estaba guardando el documento. (Se hereda de DocData).
Método público IgnoreFileChanges Determina si se deben omitir los cambios realizados en el documento. (Se hereda de DocData).
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. (Se hereda de DocData).
Método público IsDirty Comprueba si el documento ha cambiado desde la operación más reciente de guardar. (Se hereda de DocData).
Método público IsDocDataDirty De forma predeterminada, el documento subordinado se considera modificado si el elemento primario está modificado. (Invalida a DocData.IsDocDataDirty(Int32%)).
Método público IsDocDataReadOnly Comprueba si el documento es de solo lectura. (Se hereda de DocData).
Método público IsDocDataReloadable Comprueba si el documento puede recargarse. (Se hereda de DocData).
Método protegido Load(String, Boolean) Se supone que los archivos subordinados tienen algún objeto DocData “primario” que controla la serialización real, por lo que la operación de carga es una operación inefectiva. (Invalida a DocData.Load(String, Boolean)).
Método público Load(String, UInt32, Int32) Carga el documento en memoria. (Se hereda de DocData).
Método público LoadDocData(String) Carga el documento usando su nombre de archivo. (Se hereda de DocData).
Método protegido LoadDocData(String, Boolean) Carga el documento usando su nombre de archivo. (Se hereda de DocData).
Método público MarkDocumentChangedForBackup Marque que el documento ha cambiado y, en consecuencia, debe crearse una nueva copia de seguridad (Se hereda de DocData).
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ó. (Se hereda de DocData).
Método protegido OnDocumentClosing Alerta a los agentes de escucha de que el documento se cerrará. (Se hereda de DocData).
Método protegido OnDocumentLoaded Alerta a los agentes de escucha de que el documento se carga. (Se hereda de DocData).
Método protegido OnDocumentLoading Alerta a los agentes de escucha de que el documento se cargará. (Se hereda de DocData).
Método protegido OnDocumentReadOnlyChanged Alerta a los agentes de escucha que el estado de solo lectura del documento ha cambiado. (Se hereda de DocData).
Método protegido OnDocumentReloaded Alerta a los agentes de escucha de que se ha recargado el documento. (Se hereda de DocData).
Método protegido OnDocumentReloading Alerta a los agentes de escucha de que el documento se recargará. (Se hereda de DocData).
Método protegido OnDocumentSaved Alerta a los agentes de escucha de que se ha guardado el documento. (Se hereda de DocData).
Método protegido OnDocumentSaving Alerta a los agentes de escucha de que el documento se guardará. (Se hereda de DocData).
Método protegido OnFileNameChanged Alerta a los agentes de escucha de que el nombre de archivo de documento ha cambiado. (Se hereda de DocData).
Método protegido OnHierarchyChanged Alerta a los agentes de escucha de que el identificador del elemento que se asigna al documento ha cambiado. (Se hereda de DocData).
Método público OnRegisterDocData Asigna el documento en una jerarquía de proyecto y cookie. (Se hereda de DocData).
Método público OpenView Abre una vista concreta para el documento. (Se hereda de DocData).
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. (Se hereda de DocData).
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. (Se hereda de DocData).
Método público QuerySaveFile() Alerta a los agentes de escucha de que un archivo se va a guardar.Los agentes de escucha pueden (Se hereda de DocData).
Método público QuerySaveFile(String, tagVSQuerySaveFlags) Alerta a los agentes de escucha de que un archivo se va a guardar. (Se hereda de DocData).
Método público ReloadDocData Recarga el documento. (Se hereda de DocData).
Método protegido ReloadDocDataWorker Recarga el documento. (Se hereda de DocData).
Método público RenameDocData Cambia un documento de nombre y restablece su posición en la jerarquía. (Se hereda de DocData).
Método protegido ResumeFileChangeNotification Reanuda la distribución de las notificaciones de cambios del documento. (Se hereda de DocData).
Método protegido Save(String) Se supone que los archivos subordinados tienen algún objeto DocData “primario” que normalmente controla la serialización real; la operación de guardado es una operación inefectiva excepto en el caso de SaveAs. (Invalida a DocData.Save(String)).
Método público Save(String, Int32, UInt32) Guarda el documento. (Se hereda de DocData).
Método protegido SaveAs Guardar como datos de documento en un archivo
Método público SaveCompleted Alerta a los agentes de escucha de que se ha guardado el documento. (Se hereda de DocData).
Método público SaveDocData Guarda el documento en una ubicación específica. (Se hereda de DocData).
Método protegido SaveDocDataToFile Guarda el documento en una ubicación específica. (Se hereda de DocData).
Método protegido SaveSubordinateFile Guarde el documento especificado subordinado a este documento, por ejemplo un archivo de diagrama. (Se hereda de DocData).
Método público SetData Establece el documento en un búfer. (Se hereda de DocData).
Método público SetDocDataDirty Establece la marca IsDirty del documento. (Se hereda de DocData).
Método público SetDocDataReadOnly Establece la marca de solo lectura del documento. (Se hereda de DocData).
Método protegido SetFileName Inicializa o cambia el nombre de archivo del documento. (Se hereda de DocData).
Método protegido SetHierarchyInfo Inicializa o cambia la jerarquía de proyectos para el documento. (Se hereda de DocData).
Método público SetUntitledDocPath Actualmente no implementado. (Se hereda de DocData).
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. (Se hereda de DocData).
Método protegido SuspendFileChangeNotification Suspende la distribución de las notificaciones de cambios del documento. (Se hereda de DocData).
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. (Se hereda de DocData).
Evento público DocumentClosing Se produce antes de cerrar el documento. (Se hereda de DocData).
Evento público DocumentLoaded Se produce una vez cargado el documento en la ventana de modelado. (Se hereda de DocData).
Evento público DocumentLoading Se produce antes de la carga del documento en la ventana de modelado. (Se hereda de DocData).
Evento público DocumentReadOnlyChanged Se produce al cambiar la marca de solo lectura del documento. (Se hereda de DocData).
Evento público DocumentReloaded Se produce después de haberse recargado el documento. (Se hereda de DocData).
Evento público DocumentReloading Se produce antes de que se recargue el documento. (Se hereda de DocData).
Evento público DocumentSaved Se produce una vez que se ha guardado el documento. (Se hereda de DocData).
Evento público DocumentSaving Se produce antes de que se guarde el documento. (Se hereda de DocData).
Evento público FileNameChanged Se produce al cambiar el nombre de archivo del documento. (Se hereda de DocData).
Evento público HierarchyChanged Se produce al cambiar el identificador de elemento o la jerarquía del documento. (Se hereda de DocData).

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. (Se hereda de DocData).
Implementación explícita de interfacesMétodo privado IDisposable.Dispose Libera todos los recursos usados por la instancia actual de la clase DocData. (Se hereda de DocData).
Implementación explícita de interfacesMétodo privado IPersistFileFormat.GetClassID Obtiene el identificador de clase del generador de editores que creó el documento. (Se hereda de DocData).
Implementación explícita de interfacesMétodo privado IVsFileBackup.IsBackupFileObsolete Obtiene si el archivo de copia de seguridad está actualizado. (Se hereda de DocData).

Arriba

Comentarios

Los archivos subordinados se supone tener algún objeto de DocData de “elemento primario” que controle la serialización real. Esta clase existe para poder registrar en VS la tabla de documentos run y seguir el archivo subordinado por VS el shell.

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)