Klasa DocData

Artykuł
06/02/2014

Po zastąpieniu w klasie pochodnej, reprezentuje dokument w pamięci.

Ten interfejs API nie jest zgodny ze specyfikacją CLS.

Hierarchia dziedziczenia

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

Przestrzeń nazw: Microsoft.VisualStudio.Modeling.Shell
Zestaw: Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (w Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Składnia

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

Typ DocData uwidacznia następujące elementy członkowskie.

Konstruktorzy

	Nazwa	Opis
	DocData	Inicjuje nowe wystąpienie klasy DocData.

Początek

Właściwości

	Nazwa	Opis
	Cookie	Pobiera pliku cookie, który identyfikuje dokument w tabeli systemem dokumentów.
	DocViews	Pobiera Kolekcja widoków dokumentów, które są otwarte dla dokumentu.
	Encoding	Pobiera lub Ustawia metodę kodowania, która utrzymuje się dokument.
	FileName	Pobiera nazwę pliku dokumentu.
	FormatList	Pobiera listę formatów.
	Hierarchy	Pobiera hierarchii projektów, do której należy dany dokument.
	IsBackupFileObsolete
	IsLoaded	Pobiera dokument i sprawdza, czy jest on ładowany.
	ItemId	Pobiera identyfikator elementu, który jest przypisany do dokumentu.
	ServiceProvider	Usługodawca pobiera z powłoki.
	UndoManager	Pobiera UndoManager interfejsu dla dokumentu.
	UndoManagerIsShared	Pobiera dokument i sprawdza, czy udostępnianie dokumentów więcej niż jeden taki sam UndoManager interfejsu.
	VSUndoManager	Pobiera UndoManager interfejsu.

Początek

Metody

	Nazwa	Opis
	BackupFile	Pojedynczy plik Utwórz kopię zapasową tego dokumentu.Zwraca, czy dokument oczekuje na ponowne załadowanie bez utraty danych.
	CanSave	Sprawdza, czy użytkownik może anulować zapis operacji.
	Close	Zamyka dokument.
	CreateObjRef	Krytyczny pod względem zabezpieczeń Tworzy obiekt, który zawiera wszystkie istotne informacje wymagane do wygenerowania serwera proxy, używany do komunikowania się z obiektem zdalnym. (Odziedziczone z MarshalByRefObject).
	DirectoryChanged	Aktualnie nie zaimplementowane.
	Dispose	Zwalnia niezarządzanych zasoby używane przez DocData i opcjonalnie zwalnia zarządzanych zasobów.
	Equals	Określa, czy określony obiekt jest równy bieżącemu obiektowi. (Odziedziczone z Object).
	FilesChanged	Powiadamia klientów, że jeden lub więcej dokumentów, zmieniony.
	Finalize	Umożliwia obiekt spróbuj zwolnić zasoby i wykonywania innych operacji oczyszczania przed jest odzyskane w procesie wyrzucania elementów bezużytecznych. (Odziedziczone z Object).
	FlushUndoManager	Czyści UndoManager.
	GetClassID	Pobiera identyfikator GUID fabryki edytor, który utworzył dokument.
	GetCurFile	Pobiera nazwę pliku dokumentu.
	GetData	Pobiera dane dokumentu z bufora.
	GetFormatList	Pobiera listę formatów obsługiwanych dokumentów.
	GetGuidEditorType	Pobiera identyfikator GUID fabryki edytor, utworzony przez IVsPersistDocData obiektu.
	GetHashCode	Służy jako domyślnej funkcji mieszania. (Odziedziczone z Object).
	GetLifetimeService	Krytyczny pod względem zabezpieczeń Pobiera obiekt usługi bieżącego okresu istnienia, który kontroluje politykę okres istnienia dla tego wystąpienia. (Odziedziczone z MarshalByRefObject).
	GetService	Zwraca żądanej usługi.
	GetType	Pobiera Type bieżącego wystąpienia. (Odziedziczone z Object).
	HandleLoadDocDataException	Zarządza żadnych wyjątków, które były generowane podczas ładowania dokumentu.
	HandleSaveDocDataException	Zarządza żadnych wyjątków, które były generowane podczas zapisywania dokumentu.
	IgnoreFileChanges	Określa, czy zmiany w dokumencie powinny być ignorowane.
	InitializeLifetimeService	Krytyczny pod względem zabezpieczeń Uzyskuje obiekt usługi istnienia kontroli zasad okres istnienia dla tego wystąpienia. (Odziedziczone z MarshalByRefObject).
	InitNew	Inicjuje dokumentu.
	IsDirty	Sprawdza, czy dokument został zmieniony od czasu ostatniego zapisania operacji.
	IsDocDataDirty	Sprawdza, czy dokument został zmieniony od czasu ostatniego zapisania operacji.
	IsDocDataReadOnly	Sprawdza, czy dokument jest tylko do odczytu.
	IsDocDataReloadable	Sprawdza, czy dokument może być ponownie.
	Load(String, Boolean)	Dokument ładuje do pamięci.
	Load(String, UInt32, Int32)	Dokument ładuje do pamięci.
	LoadDocData(String)	Ładuje dokumentu przy użyciu jego nazwy pliku.
	LoadDocData(String, Boolean)	Ładuje dokumentu przy użyciu jego nazwy pliku.
	MarkDocumentChangedForBackup	Znak, że dokument został zmieniony i dlatego należy utworzyć nową kopię zapasową
	MemberwiseClone()	Tworzy kopię płytkie bieżące Object. (Odziedziczone z Object).
	MemberwiseClone(Boolean)	Powoduje utworzenie kopii shallow bieżącego MarshalByRefObject obiektu. (Odziedziczone z MarshalByRefObject).
	OnDocumentClosed	Alerty słuchaczy, że dokument został zamknięty.
	OnDocumentClosing	Alerty słuchaczy dokumentu zostanie zamknięte.
	OnDocumentLoaded	Alerty słuchaczy wczytano dany dokument.
	OnDocumentLoading	Alerty słuchaczy, dokument zostanie załadowany.
	OnDocumentReadOnlyChanged	Alerty nasłuchujących zmienił się stan tylko do odczytu dokumentu.
	OnDocumentReloaded	Alerty słuchaczy dokumentu została załadowana.
	OnDocumentReloading	Alerty słuchaczy, że zostanie ponownie załadowana dokumentu.
	OnDocumentSaved	Alerty nasłuchujących dokument został zapisany.
	OnDocumentSaving	Alerty nasłuchujących dokument zostanie zapisany.
	OnFileNameChanged	Alerty nasłuchujących zmienił nazwę pliku dokumentu.
	OnHierarchyChanged	Alerty słuchaczy zmienił identyfikator elementu, który jest przypisany do dokumentu.
	OnRegisterDocData	Przypisuje hierarchii plików cookie i projekt dokumentu.
	OpenView	Otwiera widok określonych dla danego dokumentu.
	QueryEditFile()	Ostrzega odbiorniki, że dokument będzie edytowany.Detektory głosować przeciwko Edycja.
	QueryEditFile(String, tagVSQueryEditFlags)	Ostrzega odbiorniki, że dokument będzie edytowany.Detektory głosować przeciwko Edycja.
	QuerySaveFile()	Ostrzega odbiorniki, że plik zostanie zapisany.Można słuchaczy
	QuerySaveFile(String, tagVSQuerySaveFlags)	Ostrzega odbiorniki, że plik zostanie zapisany.
	ReloadDocData	Ponownie ładuje dokumentu.
	ReloadDocDataWorker	Ponownie ładuje dokumentu.
	RenameDocData	Zmienia nazwę dokumentu i przywraca jego pozycji w hierarchii.
	ResumeFileChangeNotification	Wznawia rozkładem powiadomienia o zmianie dokumentu dla dokumentu.
	Save(String)	Zapisuje dokument.
	Save(String, Int32, UInt32)	Zapisuje dokument.
	SaveCompleted	Alerty nasłuchujących dokument został zapisany.
	SaveDocData	Zapisuje dokument do określonej lokalizacji.
	SaveDocDataToFile	Zapisuje dokument do określonej lokalizacji.
	SaveSubordinateFile	Zapisywanie określonego dokumentu, który jest podrzędny wobec tego dokumentu, na przykład plik diagramu.
	SetData	Ustawia dokumentu do bufora.
	SetDocDataDirty	Ustawia dokumentu IsDirty flagi.
	SetDocDataReadOnly	Ustawia flagę tylko do odczytu dokumentu.
	SetFileName	Inicjuje lub zmienia nazwę pliku dla dokumentu.
	SetHierarchyInfo	Inicjuje lub zmiany hierarchii projektu dla dokumentu.
	SetUntitledDocPath	Obecnie nie zaimplementowana.
	ShowSaveOptionsDlg	Pokazuje okno dialogowe, z którego użytkownik może określić dodatkowe opcje zapisywania formatów.
	SuspendFileChangeNotification	Wstrzymuje rozkładem powiadomienia o zmianie dokumentu dla dokumentu.
	ToString	Zwraca ciąg, który reprezentuje bieżący obiekt. (Odziedziczone z Object).

Początek

Zdarzenia

	Nazwa	Opis
	DocumentClosed	Występuje po zamknięciu dokumentu.
	DocumentClosing	Występuje przed zamknięciem dokumentu.
	DocumentLoaded	Występuje po załadowaniu dokumentu w oknie modelowania.
	DocumentLoading	Występuje przed załadowaniem dokumentu w oknie modelowania.
	DocumentReadOnlyChanged	Występuje, gdy flaga tylko do odczytu dla danego dokumentu.
	DocumentReloaded	Występuje po załadowaniu dokumentu.
	DocumentReloading	Występuje przed dokument zostanie ponownie załadowana.
	DocumentSaved	Występuje po zapisaniu dokumentu.
	DocumentSaving	Występuje przed zapisaniem dokumentu.
	FileNameChanged	Występuje, gdy nazwa pliku dokumentu.
	HierarchyChanged	Występuje, gdy w dokumencie hierarchii lub identyfikator elementu.

Początek

Jawne implementacje interfejsu

	Nazwa	Opis
	IVsFileBackup.BackupFile	Pojedynczy plik Utwórz kopię zapasową tego dokumentu.
	IDisposable.Dispose	Zwalnia wszystkie zasoby używane przez bieżące wystąpienie DocData klasy.
	IPersistFileFormat.GetClassID	Pobiera identyfikator klasy fabryki edytor, który utworzył dokument.
	IVsFileBackup.IsBackupFileObsolete	Pobierz czy plik kopii zapasowej jest aktualny.

Początek

Uwagi

Ta klasa również nasłuchuje zdarzeń dla dokumentów zewnętrznych zmian i może monitować użytkownika o ponowne ładowanie dokumentu.

Bezpieczeństwo wątku

Wszystkie publiczne static (Shared w języku Visual Basic) elementy członkowskie tego typu są bezpieczne dla wątków. Wystąpienia elementów członkowskich nie dają gwarancji bezpieczeństwa wątków.

Zobacz też

Informacje

Przestrzeń nazw Microsoft.VisualStudio.Modeling.Shell

Udostępnij za pośrednictwem

Klasa DocData

Hierarchia dziedziczenia

Składnia

Konstruktorzy

Właściwości

Metody

Zdarzenia

Jawne implementacje interfejsu

Uwagi

Bezpieczeństwo wątku

Zobacz też

Informacje

Dodatkowe zasoby