Condividi tramite

Classe DocData

  • Articolo

Una volta eseguito l'override in una classe derivata, rappresenta un documento nella memoria.

Questa API non è conforme a CLS. 

Gerarchia di ereditarietà

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

Spazio dei nomi:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Sintassi

'Dichiarazione
<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

Il tipo DocData espone i seguenti membri.

Costruttori

  Nome Descrizione
Metodo protetto DocData Inizializza una nuova istanza della classe DocData.

In alto

Proprietà

  Nome Descrizione
Proprietà pubblica Cookie Ottiene il cookie che identifica il documento nella tabella Documenti aperti.
Proprietà pubblica DocViews Ottiene la raccolta di visualizzazioni di documento che sono aperte per il documento.
Proprietà pubblica Encoding Ottiene o imposta la codifica che memorizza in modo permanente il documento.
Proprietà pubblica FileName Ottiene il nome file del documento.
Proprietà protetta. FormatList Ottiene un elenco di formati.
Proprietà pubblica Hierarchy Ottiene la gerarchia del progetto a cui appartiene il documento.
Proprietà protetta. IsBackupFileObsolete
Proprietà pubblica IsLoaded Ottiene il documento e verifica se è caricato.
Proprietà pubblica ItemId Ottiene l'ID di elemento assegnato al documento.
Proprietà protetta. ServiceProvider Ottiene il provider di servizi dalla shell.
Proprietà pubblica UndoManager Ottiene l'interfaccia UndoManager per il documento.
Proprietà protetta. UndoManagerIsShared Ottiene il documento e verifica se più documenti stanno condividendo la stessa interfaccia di UndoManager.
Proprietà pubblica VSUndoManager Ottiene l'interfaccia UndoManager.

In alto

Metodi

  Nome Descrizione
Metodo protetto BackupFile Eseguire il backup del file di questo documento.Restituisce un valore che indica se è previsto che il documento venga ricaricato senza perdita di dati.
Metodo protetto CanSave Verifica se l'utente possa annullare l'operazione di salvataggio.
Metodo pubblico Close Chiude il documento.
Metodo pubblico CreateObjRef Critico per la sicurezza. Consente di creare un oggetto che contiene tutte le informazioni rilevanti necessarie per la generazione del proxy utilizzato per effettuare la comunicazione con un oggetto remoto. (Ereditato da MarshalByRefObject)
Metodo pubblico DirectoryChanged Non implementato attualmente.
Metodo protetto Dispose Rilascia le risorse non gestite utilizzate da DocData e, facoltativamente, le risorse gestite.
Metodo pubblico Equals Determina se l'oggetto specificato equivale all'oggetto corrente. (Ereditato da Object)
Metodo pubblico FilesChanged Notifica ai client che uno o più documenti sono stati modificati.
Metodo protetto Finalize Consente a un oggetto di provare a liberare risorse ed eseguire altre operazioni di pulitura prima che l'oggetto stesso venga recuperato dalla procedura di Garbage Collection. (Ereditato da Object)
Metodo pubblico FlushUndoManager Cancella la classe UndoManager.
Metodo pubblico GetClassID Ottiene il GUID della factory dell'editor che ha creato il documento.
Metodo pubblico GetCurFile Ottiene il nome file del documento.
Metodo pubblico GetData Ottiene i dati del documento da un buffer.
Metodo pubblico GetFormatList Ottiene l'elenco dei formati di documento supportati.
Metodo pubblico GetGuidEditorType Ottiene il GUID della factory dell'editor che ha creato l'oggetto IVsPersistDocData.
Metodo pubblico GetHashCode Funge da funzione hash predefinita. (Ereditato da Object)
Metodo pubblico GetLifetimeService Critico per la sicurezza. Consente di recuperare l'oggetto servizio di durata corrente per controllare i criteri di durata per l'istanza. (Ereditato da MarshalByRefObject)
Metodo pubblico GetService Restituisce il servizio richiesto.
Metodo pubblico GetType Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
Metodo protetto HandleLoadDocDataException Gestisce eventuali eccezioni generate quando il documento viene caricato.
Metodo protetto HandleSaveDocDataException Gestisce eventuali eccezioni generate quando il documento viene salvato.
Metodo pubblico IgnoreFileChanges Determina se le modifiche al documento devono essere ignorate.
Metodo pubblico InitializeLifetimeService Critico per la sicurezza. Consente di ottenere un oggetto servizio di durata per il controllo dei criteri di durata per l'istanza. (Ereditato da MarshalByRefObject)
Metodo pubblico InitNew Inizializza il documento.
Metodo pubblico IsDirty Verifica se il documento è stato modificato dall'operazione di salvataggio più recente.
Metodo pubblico IsDocDataDirty Verifica se il documento è stato modificato dall'operazione di salvataggio più recente.
Metodo pubblico IsDocDataReadOnly Verifica se il documento è di sola lettura.
Metodo pubblico IsDocDataReloadable Verifica se il documento può essere ricaricato.
Metodo protetto Load(String, Boolean) Carica il documento in memoria.
Metodo pubblico Load(String, UInt32, Int32) Carica il documento in memoria.
Metodo pubblico LoadDocData(String) Carica il documento utilizzando il relativo nome file.
Metodo protetto LoadDocData(String, Boolean) Carica il documento utilizzando il relativo nome file.
Metodo pubblico MarkDocumentChangedForBackup Contrassegnare il documento come modificato. Dovrebbe essere creato un nuovo backup.
Metodo protetto MemberwiseClone() Consente di creare una copia dei riferimenti dell'oggetto Object corrente. (Ereditato da Object)
Metodo protetto MemberwiseClone(Boolean) Crea una copia dei riferimenti dell'oggetto MarshalByRefObject corrente. (Ereditato da MarshalByRefObject)
Metodo protetto OnDocumentClosed Avvisa i listener che il documento è stato chiuso.
Metodo protetto OnDocumentClosing Avvisa i listener che il documento verrà chiuso.
Metodo protetto OnDocumentLoaded Avvisa i listener che il documento è stato caricato.
Metodo protetto OnDocumentLoading Avvisa i listener che il documento verrà caricato.
Metodo protetto OnDocumentReadOnlyChanged Avvisa i listener che lo stato di sola lettura del documento è stato modificato.
Metodo protetto OnDocumentReloaded Avvisa i listener che il documento è stato ricaricato.
Metodo protetto OnDocumentReloading Avvisa i listener che il documento verrà ricaricato.
Metodo protetto OnDocumentSaved Avvisa i listener che il documento è stato salvato.
Metodo protetto OnDocumentSaving Avvisa i listener che il documento verrà salvato.
Metodo protetto OnFileNameChanged Avvisa i listener che il nome file del documento è stato modificato.
Metodo protetto OnHierarchyChanged Avvisa i listener che l'ID elemento assegnato al documento è stato modificato.
Metodo pubblico OnRegisterDocData Assegna il documento a un cookie e a una gerarchia del progetto.
Metodo pubblico OpenView Apre una visualizzazione specifica per il documento.
Metodo pubblico QueryEditFile() Avvisa i listener che si sta per modificare un documento.I listener possono impedire la modifica.
Metodo pubblico QueryEditFile(String, tagVSQueryEditFlags) Avvisa i listener che si sta per modificare un documento.I listener possono impedire la modifica.
Metodo pubblico QuerySaveFile() Avvisa i listener che si è in procinto di salvare un file.I listener possono
Metodo pubblico QuerySaveFile(String, tagVSQuerySaveFlags) Avvisa i listener che si è in procinto di salvare un file.
Metodo pubblico ReloadDocData Ricarica il documento.
Metodo protetto ReloadDocDataWorker Ricarica il documento.
Metodo pubblico RenameDocData Rinomina un documento e ne reimposta la posizione nella gerarchia.
Metodo protetto ResumeFileChangeNotification Riprende la distribuzione delle notifiche delle modifiche del documento.
Metodo protetto Save(String) Salva il documento.
Metodo pubblico Save(String, Int32, UInt32) Salva il documento.
Metodo pubblico SaveCompleted Avvisa i listener che il documento è stato salvato.
Metodo pubblico SaveDocData Salva il documento in una posizione specifica.
Metodo protetto SaveDocDataToFile Salva il documento in una posizione specifica.
Metodo protetto SaveSubordinateFile Salvare il documento specificato secondario a questo documento, ad esempio un file diagramma.
Metodo pubblico SetData Imposta il documento su un buffer.
Metodo pubblico SetDocDataDirty Imposta il flag IsDirty del documento.
Metodo pubblico SetDocDataReadOnly Imposta il flag di sola lettura del documento.
Metodo protetto SetFileName Inizializza o modifica il nome file del documento.
Metodo protetto SetHierarchyInfo Inizializza o modifica la gerarchia di progetto per il documento.
Metodo pubblico SetUntitledDocPath Non implementato attualmente.
Metodo pubblico ShowSaveOptionsDlg Visualizza una finestra di dialogo da cui l'utente può specificare opzioni aggiuntive per i formati di salvataggio.
Metodo protetto SuspendFileChangeNotification Sospende la distribuzione delle notifiche delle modifiche del documento.
Metodo pubblico ToString Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)

In alto

Eventi

  Nome Descrizione
Evento pubblico DocumentClosed Si verifica dopo la chiusura del documento.
Evento pubblico DocumentClosing Si verifica prima della chiusura del documento.
Evento pubblico DocumentLoaded Si verifica dopo che il documento è stato caricato nella finestra di modellazione.
Evento pubblico DocumentLoading Si verifica prima del caricamento del documento nella finestra di modellazione.
Evento pubblico DocumentReadOnlyChanged Si verifica quando viene modificato il flag di sola lettura del documento.
Evento pubblico DocumentReloaded Si verifica dopo che il documento è stato ricaricato.
Evento pubblico DocumentReloading Si verifica prima che il documento venga ricaricato.
Evento pubblico DocumentSaved Si verifica dopo il salvataggio del documento.
Evento pubblico DocumentSaving Viene generato prima del salvataggio del documento.
Evento pubblico FileNameChanged Si verifica quando viene modificato il nome file del documento.
Evento pubblico HierarchyChanged Si verifica quando viene modificata la gerarchia o l'ID elemento del documento.

In alto

Implementazioni esplicite dell'interfaccia

  Nome Descrizione
Implementazione esplicita dell'interfacciaMetodo privato IVsFileBackup.BackupFile Eseguire il backup del file di questo documento.
Implementazione esplicita dell'interfacciaMetodo privato IDisposable.Dispose Rilascia tutte le risorse utilizzate dall'istanza corrente della classe DocData.
Implementazione esplicita dell'interfacciaMetodo privato IPersistFileFormat.GetClassID Ottiene l'ID della classe della factory dell'editor che ha creato il documento.
Implementazione esplicita dell'interfacciaMetodo privato IVsFileBackup.IsBackupFileObsolete Scoprire se il file di backup è aggiornato.

In alto

Note

Questa classe inoltre ascolta gli eventi di modifica dei documenti esterni e può richiedere all'utente di ricaricare il documento.

Codice thread safe

Qualsiasi membro static (Shared in Visual Basic) pubblico di questo tipo è thread-safe. I membri di istanza non sono garantiti come thread-safe.

Vedere anche

Riferimenti

Spazio dei nomi Microsoft.VisualStudio.Modeling.Shell