DocData クラス
派生クラスでオーバーライドされると、インメモリ ドキュメントを表します。
この API は、CLS に準拠していません。
継承階層
System.Object
System.MarshalByRefObject
Microsoft.VisualStudio.Modeling.Shell.DocData
Microsoft.VisualStudio.Modeling.Shell.ModelingDocData
Microsoft.VisualStudio.Modeling.Shell.SubordinateDocData
名前空間: Microsoft.VisualStudio.Modeling.Shell
アセンブリ: Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0 (Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0.dll 内)
構文
'宣言
<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
DocData 型で公開されるメンバーは以下のとおりです。
コンストラクター
| 名前 | 説明 | |
|---|---|---|
.gif "プロテクト メソッド") |
DocData | DocData クラスの新しいインスタンスを初期化します。 |
このページのトップへ
プロパティ
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック プロパティ") |
Cookie | 実行中のドキュメントの表のドキュメントを識別するクッキーを取得します。 |
|
DocViews | ドキュメントのために開いているドキュメントのビューのコレクションを取得します。 |
|
Encoding | ドキュメントを保持するエンコーディングを取得または設定します。 |
|
FileName | ドキュメントのファイル名を取得します。 |
.gif "プロテクト プロパティ") |
FormatList | 形式のリストを取得します。 |
|
Hierarchy | ドキュメントが属するプロジェクト階層を取得します。 |
|
IsBackupFileObsolete | |
|
IsLoaded | ドキュメントを取得し、読み込むかどうかを確認します。 |
|
ItemId | ドキュメントに割り当てられている項目 ID を取得します。 |
|
ServiceProvider | シェルからサービス プロバイダーを取得します。 |
|
UndoManager | ドキュメントの UndoManager インターフェイスを取得します。 |
|
UndoManagerIsShared | ドキュメントを取得し、複数のドキュメントが UndoManager の同じインターフェイスを共有しているかどうかを確認します。 |
|
VSUndoManager | UndoManager インターフェイスを取得します。 |
このページのトップへ
メソッド
| 名前 | 説明 | |
|---|---|---|
|
BackupFile | このドキュメントの単一ファイルをバックアップします。ドキュメントがデータを失わずにリロードが期待されるかどうかを返します。 |
|
CanSave | ユーザーが保存操作をキャンセルできるかどうかを確認します。 |
.gif "パブリック メソッド") |
Close | 文書を閉じます。 |
|
CreateObjRef | セキュリティ クリティカル。リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 (MarshalByRefObject から継承されます。) |
|
DirectoryChanged | 現在、実装されていません。 |
|
Dispose | DocData によって使用されているアンマネージ リソースを解放し、オプションでマネージ リソースも解放します。 |
|
Equals | 指定のオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (Object から継承されます。) |
|
FilesChanged | 一つ以上のドキュメントが変更されたことをクライアントに通知します。 |
|
Finalize | オブジェクトがガベージ コレクションにより収集される前に、そのオブジェクトがリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。) |
|
FlushUndoManager | UndoManager を消去します。 |
|
GetClassID | エディターでドキュメントを作成するファクトリの GUID を取得します。 |
|
GetCurFile | ドキュメントのファイル名を取得します。 |
|
GetData | バッファーからドキュメント データを取得します。 |
|
GetFormatList | サポートされているドキュメント形式のリストを取得します。 |
|
GetGuidEditorType | IVsPersistDocData オブジェクトを作成するエディターのファクトリの GUID を取得します。 |
|
GetHashCode | 特定の型のハッシュ関数として機能します。 (Object から継承されます。) |
|
GetLifetimeService | セキュリティ クリティカル。対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。 (MarshalByRefObject から継承されます。) |
|
GetService | 要求されたサービスを返します。 |
|
GetType | 現在のインスタンスの Type を取得します。 (Object から継承されます。) |
|
HandleLoadDocDataException | ドキュメントの読み込みされたときにスローされた例外を管理します。 |
|
HandleSaveDocDataException | ドキュメントを保存したときにスローされた例外を管理します。 |
|
IgnoreFileChanges | ドキュメントへの変更を無視するかどうかを判定します。 |
|
InitializeLifetimeService | セキュリティ クリティカル。対象のインスタンスの有効期間ポリシーを制御する、有効期間サービス オブジェクトを取得します。 (MarshalByRefObject から継承されます。) |
|
InitNew | ドキュメントを初期化します。 |
|
IsDirty | ドキュメントが最近の保存操作変更されているかどうかを確認します。 |
|
IsDocDataDirty | ドキュメントが最近の保存操作変更されているかどうかを確認します。 |
|
IsDocDataReadOnly | ドキュメントが読み取り専用かどうかを確認しています。 |
|
IsDocDataReloadable | ドキュメントを再度読み込むことができるかどうかを確認します。 |
|
Load(String, Boolean) | メモリにドキュメントを読み込みます。 |
|
Load(String, UInt32, Int32) | メモリにドキュメントを読み込みます。 |
|
LoadDocData(String) | ファイル名を使用してドキュメントを読み込みます。 |
|
LoadDocData(String, Boolean) | ファイル名を使用してドキュメントを読み込みます。 |
|
MarkDocumentChangedForBackup | ドキュメントを変更するため、新しいバックアップを作成する必要があることを示します。 |
|
MemberwiseClone() | 現在の Object の簡易コピーを作成します。 (Object から継承されます。) |
|
MemberwiseClone(Boolean) | 現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。 (MarshalByRefObject から継承されます。) |
|
OnDocumentClosed | ドキュメントが閉じられたときリスナーに警告します。 |
|
OnDocumentClosing | ドキュメントを閉じるとリスナーに警告します。 |
|
OnDocumentLoaded | リスナー ドキュメントを読み込むように警告します。 |
|
OnDocumentLoading | リスナー ドキュメントを読み込むように警告します。 |
|
OnDocumentReadOnlyChanged | ドキュメントの読み取り専用ステータスが変化したリスナーに警告します。 |
|
OnDocumentReloaded | ドキュメントを再読み込みするリスナーに警告します。 |
|
OnDocumentReloading | ドキュメントを再度読み込みます。リスナーに警告します。 |
|
OnDocumentSaved | 文書が保存されると、リスナーに警告します。 |
|
OnDocumentSaving | 文書が保存されるのリスナーに警告します。 |
|
OnFileNameChanged | ドキュメントのファイル名が変更したリスナーに警告します。 |
|
OnHierarchyChanged | ドキュメントに割り当てられている項目 ID が変更したリスナーに警告します。 |
|
OnRegisterDocData | クッキーと、プロジェクト階層にドキュメントを割り当てます。 |
|
OpenView | ドキュメントの特定のビューを開きます。 |
|
QueryEditFile() | ドキュメントが編集されると、リスナーに警告します。リスナーは編集に対して判別できます。 |
|
QueryEditFile(String, tagVSQueryEditFlags) | ドキュメントが編集されると、リスナーに警告します。リスナーは編集に対して判別できます。 |
|
QuerySaveFile() | ファイルが保存されると、リスナーに警告します。リスナーができます。 |
|
QuerySaveFile(String, tagVSQuerySaveFlags) | ファイルが保存されると、リスナーに警告します。 |
|
ReloadDocData | ドキュメントを再度読み込みます。 |
|
ReloadDocDataWorker | ドキュメントを再度読み込みます。 |
|
RenameDocData | ドキュメントの名前を変更し、階層の位置をリセットします。 |
|
ResumeFileChangeNotification | ドキュメントのドキュメントの変更通知の配分を再開します。 |
|
Save(String) | ドキュメントを保存します。 |
|
Save(String, Int32, UInt32) | ドキュメントを保存します。 |
|
SaveCompleted | 文書が保存されると、リスナーに警告します。 |
|
SaveDocData | 特定の場所にドキュメントを保存します。 |
|
SaveDocDataToFile | 特定の場所にドキュメントを保存します。 |
|
SaveSubordinateFile | このドキュメント内の下位に指定されたドキュメントたとえば、図ファイルを保存します。 |
|
SetData | バッファーにドキュメントを設定します。 |
|
SetDocDataDirty | ドキュメントの IsDirty にフラグを設定します。 |
|
SetDocDataReadOnly | ドキュメントの読み取り専用フラグを設定します。 |
|
SetFileName | 初期化または変更するには、ドキュメントのファイル名。 |
|
SetHierarchyInfo | 初期化または変更するには、ドキュメントの階層。 |
|
SetUntitledDocPath | 現在、実装されていません。 |
|
ShowSaveOptionsDlg | ユーザーが格納形式に追加のオプションを指定できるダイアログ ボックスについて説明します。 |
|
SuspendFileChangeNotification | ドキュメントのドキュメントの変更通知の配分を中断します。 |
|
ToString | 現在のオブジェクトを表す文字列を返します。 (Object から継承されます。) |
このページのトップへ
イベント
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック イベント") |
DocumentClosed | 文書を閉じた後に発生します。 |
|
DocumentClosing | ドキュメントを閉じる前に発生します。 |
|
DocumentLoaded | ドキュメントがモデリングのウィンドウに読み込まれた後に発生します。 |
|
DocumentLoading | ドキュメントがモデリングのウィンドウに読み込まれる前に発生します。 |
|
DocumentReadOnlyChanged | ドキュメントの読み取り専用のフラグが変更されると発生します。 |
|
DocumentReloaded | ドキュメントが再読み込み後に発生します。 |
|
DocumentReloading | ドキュメントが再び読み込まれる前に発生します。 |
|
DocumentSaved | ドキュメントが保存された後に発生します。 |
|
DocumentSaving | 文書を保存するときに、保存が行われる前に発生します。 |
|
FileNameChanged | ドキュメントが変更されたときに発生します。 |
|
HierarchyChanged | ドキュメントの階層またはアイテム ID が変更されると発生します。 |
このページのトップへ
明示的インターフェイスの実装
| 名前 | 説明 | |
|---|---|---|
.gif "明示的なインターフェイス実装") .gif "プライベート メソッド") |
IVsFileBackup.BackupFile | このドキュメントの単一ファイルをバックアップします。 |
|
IDisposable.Dispose | DocData クラスの現在のインスタンスによって使用されているすべてのリソースを解放します。 |
|
IPersistFileFormat.GetClassID | エディターでドキュメントを作成するファクトリ クラス ID を取得します。 |
|
IVsFileBackup.IsBackupFileObsolete | バックアップ ファイルが最新であるかどうかを取得します。 |
このページのトップへ
解説
このクラスは、外部ドキュメントの変更イベントをリッスン、ユーザーがドキュメントを再度読み込むにプロンプトを表示できます。
スレッド セーフ
この型のすべてのパブリック static (Visual Basic では Shared) メンバーは、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。