Condividi tramite

Classe DocData

Una volta sottoposto a override in una classe derivata, rappresenta un documento in 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.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.11.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 di DocData classe.

In alto

Proprietà

  Nome Descrizione
Proprietà pubblica Cookie Ottiene un cookie che identificano il documento nella tabella in esecuzione documenti.
Proprietà pubblica DocViews Ottiene la raccolta di visualizzazioni dei documenti aperti per il documento.
Proprietà pubblica Encoding Ottiene o imposta la codifica che mantiene 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 venga caricato.
Proprietà pubblica ItemId Ottiene l'ID dell'elemento assegnato al documento.
Proprietà protetta. ServiceProvider Ottiene il provider di servizi dalla shell.
Proprietà pubblica UndoManager ottiene UndoManager interfaccia del documento.
Proprietà protetta. UndoManagerIsShared Ottiene il documento e verifica se più di un documento sia condividendo lo stesso UndoManager interfaccia.
Proprietà pubblica VSUndoManager ottiene UndoManager interfaccia.

In alto

Metodi

  Nome Descrizione
Metodo protetto BackupFile Eseguire il backup di un file di questo documento.Restituisce se il documento è previsto che ricarichi senza perdita di dati.
Metodo protetto CanSave Si verifica se l'utente possa annullare l'operazione di salvataggio.
Metodo pubblico Close Chiudere il documento.
Metodo pubblico CreateObjRef Critico per la sicurezza. Crea un oggetto che contiene tutte le informazioni rilevanti obbligatorio per generare un proxy utilizzato per comunicare con un oggetto remoto. (Ereditato da MarshalByRefObject)
Metodo pubblico DirectoryChanged Non implementato attualmente.
Metodo protetto Dispose Rilascia risorse non gestite utilizzate da DocData e facoltativamente dealloca 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 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 IVsPersistDocData oggetto.
Metodo pubblico GetHashCode Funge da funzione hash per un determinato tipo. (Ereditato da Object)
Metodo pubblico GetLifetimeService Critico per la sicurezza. Recupera l'oggetto corrente del servizio di durata che controlla i criteri di durata dell'istanza. (Ereditato da MarshalByRefObject)
Metodo pubblico GetService restituire 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 risparmiando.
Metodo pubblico IgnoreFileChanges Determina se le modifiche al documento devono essere ignorate.
Metodo pubblico InitializeLifetimeService Critico per la sicurezza. Ottiene un oggetto di servizio di durata per controllare i criteri di durata dell'istanza. (Ereditato da MarshalByRefObject)
Metodo pubblico InitNew inizializza il documento.
Metodo pubblico IsDirty Si verifica se il documento è stato modificato poiché l'operazione di salvataggio più recente.
Metodo pubblico IsDocDataDirty Si verifica se il documento è stato modificato poiché l'operazione di salvataggio più recente.
Metodo pubblico IsDocDataReadOnly Si verifica se il documento è di sola lettura.
Metodo pubblico IsDocDataReloadable si verifica se il documento possa essere ricaricatoe.
Metodo protetto Load(String, Boolean) Caricare il documento in memoria.
Metodo pubblico Load(String, UInt32, Int32) Caricare il documento in memoria.
Metodo pubblico LoadDocData(String) Carica il documento mediante il nome file.
Metodo protetto LoadDocData(String, Boolean) Carica il documento mediante il nome file.
Metodo pubblico MarkDocumentChangedForBackup Contrassegnare che il documento è stato modificato e un nuovo backup deve essere creato così
Metodo protetto MemberwiseClone() Consente di creare una copia dei riferimenti dell'oggetto Object corrente. (Ereditato da Object)
Metodo protetto MemberwiseClone(Boolean) Crea una copia superficiale corrente MarshalByRefObject oggetto. (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 viene caricato.
Metodo protetto OnDocumentLoading Avvisa i listener che il documento verrà caricata.
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 salvataggio del documento.
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 a cui viene assegnato al documento è stato modificato.
Metodo pubblico OnRegisterDocData Assegna il documento in una gerarchia del progetto e dei cookie.
Metodo pubblico OpenView apre una visualizzazione specifica per il documento.
Metodo pubblico QueryEditFile() Avvisa i listener che un documento sta per essere modificato.I listener possono effettuare il polling per la modifica.
Metodo pubblico QueryEditFile(String, tagVSQueryEditFlags) Avvisa i listener che un documento sta per essere modificato.I listener possono effettuare il polling per la modifica.
Metodo pubblico QuerySaveFile() Avvisa i listener che un file sta per essere salvato.i listener possono
Metodo pubblico QuerySaveFile(String, tagVSQuerySaveFlags) Avvisa i listener che un file sta per essere salvato.
Metodo pubblico ReloadDocData ricarica il documento.
Metodo protetto ReloadDocDataWorker ricarica il documento.
Metodo pubblico RenameDocData Rinomina un documento e reimpostare la posizione nella gerarchia.
Metodo protetto ResumeFileChangeNotification Riprende la distribuzione delle notifiche del controllo per il documento.
Metodo protetto Save(String) salva il documento.
Metodo pubblico Save(String, Int32, UInt32) salva il documento.
Metodo pubblico SaveCompleted Avvisa i listener salvataggio del documento.
Metodo pubblico SaveDocData Salvare il documento in un percorso specifico.
Metodo protetto SaveDocDataToFile Salvare il documento in un percorso specifico.
Metodo protetto SaveSubordinateFile Salvare il documento specificato che è secondario a questo documento, ad esempio un file diagramma.
Metodo pubblico SetData Imposta il documento a un buffer.
Metodo pubblico SetDocDataDirty imposta il documento IsDirty flag.
Metodo pubblico SetDocDataReadOnly Imposta il flag di sola lettura del documento.
Metodo protetto SetFileName Inizializza o modificare il nome del documento.
Metodo protetto SetHierarchyInfo Inizializza o modificare la gerarchia del progetto per il documento.
Metodo pubblico SetUntitledDocPath attualmente non implementato.
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 del controllo per il 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 quando il documento viene chiuso.
Evento pubblico DocumentClosing Si verifica prima che il documento venga chiuso.
Evento pubblico DocumentLoaded Si verifica dopo che il documento è stato caricato nella finestra di modellizzazione.
Evento pubblico DocumentLoading Si verifica prima che il documento venga caricato nella finestra di modellizzazione.
Evento pubblico DocumentReadOnlyChanged Si verifica quando il contrassegno di sola lettura per la modifica del documento.
Evento pubblico DocumentReloaded Si verifica quando il documento viene ricaricato.
Evento pubblico DocumentReloading Si verifica prima che il documento venga ricaricato.
Evento pubblico DocumentSaved Si verifica quando il documento viene salvato.
Evento pubblico DocumentSaving Si verifica prima che il documento venga salvato.
Evento pubblico FileNameChanged Si verifica quando viene modificato il nome file del documento.
Evento pubblico HierarchyChanged Si verifica quando la gerarchia del documento o modifica ID elemento.

In alto

Implementazioni esplicite dell'interfaccia

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

In alto

Note

Questa classe anche ascolta gli eventi di modifica dei documenti esterni e può chiedere a l 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