Klasa DocData
Kiedy zastąpiony 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.11.0 (w Microsoft.VisualStudio.Modeling.Sdk.Shell.11.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 DocData klasy. |
Początek
Właściwości
Nazwa | Opis | |
---|---|---|
Cookie | Pobiera pliku cookie, który identyfikuje dokument w tabeli dokumentów z systemem. | |
DocViews | Zwraca kolekcję widoków dokumentów, które są otwarte dla dokumentu. | |
Encoding | Pobiera lub Ustawia metodę kodowania, która będzie się powtarzał dokumentu. | |
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 są pobierane z powłoki. | |
UndoManager | Pobiera UndoManager interfejsu dla dokumentu. | |
UndoManagerIsShared | Pobiera dokument i sprawdza, czy udostępnianie jest więcej niż jeden dokument taki sam UndoManager interfejsu. | |
VSUndoManager | Pobiera UndoManager interfejsu. |
Początek
Metody
Nazwa | Opis | |
---|---|---|
BackupFile | Wprowadź pojedynczy plik kopii zapasowej tego dokumentu.Zwraca się, czy dokument oczekuje na ponowne załadowanie bez utraty danych. | |
CanSave | Sprawdza, czy użytkownik może anulować zapisywanie 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 zasobów używanych przez DocData i opcjonalnie zwalnia zarządzanych zasobów. | |
Equals | Określa, czy określony obiekt jest równa bieżącego obiektu. (Odziedziczone z Object). | |
FilesChanged | Powiadamia klientów, że zmianie jednego lub więcej dokumentów. | |
Finalize | Umożliwia obiekt spróbuj zwolnić zasoby i wykonywania innych operacji oczyszczania, zanim 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 dokumentu. | |
GetGuidEditorType | Pobiera identyfikator GUID fabryki edytor, który utworzony IVsPersistDocData obiektu. | |
GetHashCode | Służy jako funkcja mieszania dla określonego typu. (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 wyjątkami, które zostały zgłoszone podczas ładowania dokumentu. | |
HandleSaveDocDataException | Zarządza wyjątkami, które zostały zgłoszone podczas zapisywania dokumentu. | |
IgnoreFileChanges | Określa, czy zmiany wprowadzone 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 operacji zapisywania. | |
IsDocDataDirty | Sprawdza, czy dokument został zmieniony od czasu ostatniego operacji zapisywania. | |
IsDocDataReadOnly | Sprawdza, czy dokument jest przeznaczony tylko do odczytu. | |
IsDocDataReloadable | Sprawdza, czy można ponownie załadować dokument. | |
Load(String, Boolean) | Dokument należy ładuje do pamięci. | |
Load(String, UInt32, Int32) | Dokument należy ł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 w ten sposób utworzona nowa kopia zapasowa | |
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 detektory, że dokument został zamknięty. | |
OnDocumentClosing | Alerty detektory zamknięcia dokumentu. | |
OnDocumentLoaded | Alerty detektory wczytano dany dokument. | |
OnDocumentLoading | Alerty detektory, dokument zostanie załadowany. | |
OnDocumentReadOnlyChanged | Detektory alerty, które zmienił się tylko do odczytu stanu dokumentu. | |
OnDocumentReloaded | Alerty detektory, że dokument został ponownie załadowane. | |
OnDocumentReloading | Alerty detektory, że będzie można ponownie załadować dokument. | |
OnDocumentSaved | Alerty detektory, że dokument został zapisany. | |
OnDocumentSaving | Alerty detektory, że dokument zostanie zapisany. | |
OnFileNameChanged | Detektory alerty, które zmieniono nazwę pliku dokumentu. | |
OnHierarchyChanged | Alerty detektory zmienił identyfikator elementu, który jest przypisany do dokumentu. | |
OnRegisterDocData | Przypisuje dokumentu w hierarchii plików cookie i projektu. | |
OpenView | Otwiera określonego widoku dokumentu. | |
QueryEditFile() | Detektory alerty, które ma być edytowany dokument.Odbiorniki mogą głosować przeciwko Edycja. | |
QueryEditFile(String, tagVSQueryEditFlags) | Detektory alerty, które ma być edytowany dokument.Odbiorniki mogą głosować przeciwko Edycja. | |
QuerySaveFile() | Detektory alerty, które ma być zapisany plik.Można detektory | |
QuerySaveFile(String, tagVSQuerySaveFlags) | Detektory alerty, które ma być zapisany plik. | |
ReloadDocData | Wczytuje ponownie dokument. | |
ReloadDocDataWorker | Wczytuje ponownie dokument. | |
RenameDocData | Zmienia nazwę dokumentu i przywraca jego pozycji w hierarchii. | |
ResumeFileChangeNotification | Wznawia dystrybucji dokumentu-powiadomień o zmianach dokumentu. | |
Save(String) | Zapisuje dokument. | |
Save(String, Int32, UInt32) | Zapisuje dokument. | |
SaveCompleted | Alerty detektory, że dokument został zapisany. | |
SaveDocData | Zapisuje dokument do określonej lokalizacji. | |
SaveDocDataToFile | Zapisuje dokument do określonej lokalizacji. | |
SaveSubordinateFile | Zapisz określonego dokumentu, który jest podrzędny wobec tego dokumentu, na przykład plik diagramu. | |
SetData | Ustawia dokumentu do bufora. | |
SetDocDataDirty | Ustawia dokument 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 dystrybucji dokumentu-powiadomień o zmianach dokumentu. | |
ToString | Zwraca wartość typu 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 dokument został załadowany 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 dokumentu zostanie ponownie załadowana. | |
DocumentSaved | Występuje po zapisaniu dokumentu. | |
DocumentSaving | Występuje przed zapisaniem dokumentu. | |
FileNameChanged | Występuje, gdy zmienia się nazwa pliku dokumentu. | |
HierarchyChanged | Występuje, gdy zmiany w hierarchii dokumentu lub identyfikator elementu. |
Początek
Jawne implementacje interfejsu
Nazwa | Opis | |
---|---|---|
IVsFileBackup.BackupFile | Wprowadź pojedynczy plik kopii zapasowej 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 | GET, czy plik kopii zapasowej jest aktualny. |
Początek
Uwagi
Ta klasa również nasłuchuje zdarzenia dla dokumentów zewnętrznych zmian i może monituje 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.