Document インターフェイス

環境で、編集用に開いているドキュメントを表します。

名前空間:  EnvDTE
アセンブリ:  EnvDTE (EnvDTE.dll 内)

構文

'宣言
<GuidAttribute("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")> _
Public Interface Document

[GuidAttribute("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")]
public interface Document

[GuidAttribute(L"63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")]
public interface class Document

[<GuidAttribute("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")>]
type Document =  interface end

public interface Document

Document 型で公開されるメンバーは以下のとおりです。

プロパティ

	名前	説明
	ActiveWindow	現在のアクティブ ウィンドウを取得します。他にアクティブなウィンドウがない場合は最前面に表示されたウィンドウを取得します。開いているウィンドウがない場合は、Nothing を返します。
	Collection	Document オブジェクトを含むコレクションを取得します。
	DTE	トップ レベルの機能拡張オブジェクトを取得します。
	Extender	要求された Extender がこのオブジェクトで利用できる場合はそれを返します。
	ExtenderCATID	オブジェクトの Extender カテゴリ ID (CATID) を取得します。
	ExtenderNames	オブジェクトで使用できる Extender の一覧を取得します。
	FullName	オブジェクトのファイルの完全パスと名前を取得します。
	IndentSize	インフラストラクチャ。マイクロソフト内部でのみ使用します。
	Kind	オブジェクトの種類や型を表す GUID 文字列を取得します。
	Language	インフラストラクチャ。マイクロソフト内部でのみ使用します。
	Name	Document の名前を取得します。
	Path	ドキュメントが格納されているディレクトリのファイル名を含まないパスを取得します。
	ProjectItem	Document オブジェクトに関連付けられている ProjectItem オブジェクトを取得します。
	ReadOnly	インフラストラクチャ。マイクロソフト内部でのみ使用します。
	Saved	オブジェクトが最後に保存または開かれてから変更されていない場合は、true を返します。
	Selection	Document での現在の選択項目を表すオブジェクトを取得します。
	TabSize	インフラストラクチャ。マイクロソフト内部でのみ使用します。
	Type	インフラストラクチャ。マイクロソフト内部でのみ使用します。
	Windows	オブジェクトで表示されるウィンドウを含む Windows コレクションを取得します。

このページのトップへ

メソッド

	名前	説明
	Activate	現在の項目にフォーカスを移動します。
	ClearBookmarks	インフラストラクチャ。マイクロソフト内部でのみ使用します。
	Close	開いているドキュメントを閉じ、オプションでドキュメントを保存します。またはウィンドウを閉じ、破棄します。
	MarkText	インフラストラクチャ。マイクロソフト内部でのみ使用します。
	NewWindow	ドキュメントを表示する新しいウィンドウを作成します。
	Object	実行時に名前でアクセスできるインターフェイスまたはオブジェクトを返します。
	PrintOut	インフラストラクチャ。マイクロソフト内部でのみ使用します。
	Redo	Undo メソッドまたはユーザーによって直前に元に戻された操作を再実行します。
	ReplaceText	インフラストラクチャ。マイクロソフト内部でのみ使用します。
	Save	ドキュメントを保存します。
	Undo	ドキュメントで直前に実行された操作を元に戻します。

このページのトップへ

解説

Document オブジェクトは、環境で開いている各ドキュメントまたはデザイナーを表します。つまり、ツール ウィンドウではなく、テキストの編集領域のあるウィンドウです。Document オブジェクトには、ドキュメントの操作に使用できるメンバー (プロパティ、メソッド、およびイベント) が含まれます。Visual Studio エディターで編集したテキスト ファイルの場合、このオブジェクトには TextDocument オブジェクトも関連づけられています。

開いているすべてのドキュメントは、Documents コレクション内で参照されます。このコレクションのドキュメントに繰り返しアクセスして、特定のドキュメントを検索できます。

Document オブジェクトの既定のプロパティは、Name プロパティです。

このオブジェクトを参照するには、DTE.Documents.Item(...) を使用します。

例

Sub DocumentExample()
    Dim doc As Document
    Dim desc As String

    Set doc = DTE.ActiveDocument
    desc = "You are editing a "
    If (doc.ReadOnly) Then
        desc = desc & "read-only"
    Else
        desc = desc & "writable"
    End If
    desc = desc & " document called " & doc.Name & " located at " & doc.Path
    MsgBox desc
End Sub

参照

関連項目

EnvDTE 名前空間