ITextDocument

ITextDocument インターフェースは、Text Object Model (TOM) の最上位インターフェースであり、ドキュメント内の任意のストーリー(アクティブかどうかを問わず)のアクティブな選択範囲オブジェクトと範囲オブジェクトを取得します。

このドキュメントのファイル名を取得します。これは ITextDocument の既定のプロパティです。

Type: HRESULT

メソッドが成功した場合は S_OK を返します。失敗した場合は、以下のいずれかの COM エラーコードを返します。COM エラーコードの詳細については、Error Handling in COM を参照してください。

アクティブな選択範囲を取得します。(ITextDocument.GetSelection)

Type: HRESULT

メソッドが成功した場合は S_OK を返します。失敗した場合は、以下のいずれかの COM エラーコードを返します。COM エラーコードの詳細については、Error Handling in COM を参照してください。

このドキュメント内のストーリーの数を取得します。

Type: HRESULT

メソッドが成功した場合は S_OK を返します。失敗した場合は、以下の COM エラーコードを返します。COM エラーコードの詳細については、Error Handling in COM を参照してください。

リッチエディットコントロールはストーリーを 1 つだけ持ち、ITextDocument::GetStoryRanges メソッドを実装していません。ストーリーが 1 つしかない場合にエラーが返るのを避けるには、ITextDocument::GetStoryCount を使用してストーリー数を確認してください。ストーリー数が 1 より大きい場合は、 ITextDocument::GetStoryRanges を呼び出します。

ドキュメント内のストーリーを列挙するために使用するストーリーコレクションオブジェクトを取得します。

Type: HRESULT

メソッドが成功した場合は S_OK を返します。失敗した場合は、以下の COM エラーコードを返します。COM エラーコードの詳細については、Error Handling in COM を参照してください。

このメソッドは、ITextDocument::GetStoryCount が 1 より大きい値を返す場合にのみ呼び出してください。

ファイルが最後に保存されてから変更が行われたかどうかを示す値を取得します。

Type: HRESULT

メソッドが成功した場合は S_OK を返します。失敗した場合は、以下の COM エラーコードを返します。COM エラーコードの詳細については、Error Handling in COM を参照してください。

saved プロパティを設定するには、ITextDocument::SetSaved メソッドを呼び出します。

ドキュメントの Saved プロパティを設定します。

Type: HRESULT

戻り値は S_OK です。

既定のタブ幅を取得します。

Type: HRESULT

メソッドが成功した場合は S_OK を返します。 pValue が NULL の場合、メソッドは失敗し E_INVALIDARG を返します。COM エラーコードの詳細については、Error Handling in COM を参照してください。

既定のタブ幅は、現在の表示位置より先にタブが存在しない場合に常に使用されます。既定の幅は浮動小数点のポイント単位で指定します。

現在の表示位置より先にタブが存在しない場合に使用される、既定のタブストップを設定します。

Type: HRESULT

メソッドが成功した場合は S_OK を返します。失敗した場合は、以下のいずれかの COM エラーコードを返します。COM エラーコードの詳細については、Error Handling in COM を参照してください。

新しいドキュメントを開きます。

Type: HRESULT

ITextDocument::New メソッドが成功した場合は S_OK を返します。

別のドキュメントが開いている場合、このメソッドは現在の変更を保存し、現在のドキュメントを閉じてから新しいドキュメントを開きます。

指定したドキュメントを開きます。アクセス権および共有権限、ファイルの作成と変換、さらにファイルのコードページを指定するためのパラメーターがあります。

Type: HRESULT

戻り値には、システムエラーまたは COM エラーコードに対応する HRESULT 値を指定でき、以下のいずれかの値が含まれます。

ドキュメントが ITextDocument::New メソッドで作成され、0 の値が使用される場合、Text Object Model (TOM) エンジンはどのフラグとコードページを使用するかを選択する必要があります。UTF-8 の Rich Text Format (RTF)(後述)は魅力的な既定値です。

Microsoft Rich Edit 3.0 は、\rtf1 の代わりに使用すべき制御ワード \urtf8 を定義しています。これはファイルが UTF-8 でエンコードされていることを意味します。入力時、RTF ファイルには関連するコードページ情報が含まれていますが、これは保存時に変更でき、あるバージョンを別のバージョンに変換できます。

Flags パラメーターに tomPasteFile フラグが設定されていない場合、このメソッドはまず未保存の変更を保存してから現在のドキュメントを閉じます。

ファイルが Unicode BOM 0xfeff で始まる場合、そのファイルは Unicode テキストファイルとして認識されます。ITextDocument::Open メソッドは入力時にこの Unicode BOM を取り除き、ITextDocument::Save は出力時にこれを付加します。Unicode プレーンテキストファイルの先頭に Unicode BOM を配置することについて説明した ITextDocument::Save メソッドのコメントを参照してください。変換値 tomRTF、tomHTML、tomWordDocument は、これらの形式が入力時に容易に認識されるため、主に ITextDocument::Save メソッドで使用されます。

エラーは負の値で報告されますが、ファイル操作には多くの種類のエラーがあるため、提供されるすべてのエラー情報が必要とは限りません。特に、使用されているファイル機能、すなわち Windows(pVar.vt = VT_BSTR)か、IStorage の OLE ストレージかについては、気にする必要がない(またはすでにわかっている)場合があります。HRESULT 値のビット 18 をマスクすることで、この違いを無視して STG_E_xxx の値と比較できます。次に例を示します。

HRESULT hr;
VARIANT Var;
VariantInit(&Var)

Var.vt = VT_BSTR;
Var.bstrVal = SysAllocString(L"test.txt"); // ファイルコマンドを使用
hr = pDoc->Open(&Var, tomOpenExisting, 0);
hr &= ~0x40000; // ビット 18 をマスク
if(hr == STG_E_FILENOTFOUND)
{
...// 残りのコード
}

ドキュメントを保存します。

Type: HRESULT

戻り値には、システムエラーコードまたは COM エラーコードに対応する HRESULT 値を指定でき、以下のいずれかの値が含まれます。

ファイルを開くときに指定したパラメーターを使用するには、パラメーターに 0 の値を使用します。

            <i>pVar</i> が null または指定されていない場合、このドキュメントの名前で指定されたファイル名が使用されます。これらの両方が指定されていないか null の場合、メソッドは失敗します。


            <i>pVar</i> がファイル名を指定する場合、その名前は現在の Name プロパティを置き換えます。同様に、
            <i>Flags</i> および 
            <i>CodePage</i> 引数は、
            <a href="/windows/desktop/api/tom/nf-tom-itextdocument-open">ITextDocument::Open</a> メソッドで指定された値を上書きし、
            <a href="/windows/desktop/api/tom/nf-tom-itextdocument-new">ITextDocument::New</a> メソッドで作成されたファイルに使用する値を定義できます。

Unicode プレーンテキストファイルは、最初の文字として Unicode バイトオーダーマーク (0xFEFF) を付けて保存する必要があります。この文字はファイルの読み込み時に削除する必要があります。つまり、プレーンテキストが Unicode であることを識別し、そのテキストのバイトオーダーを識別するためのインポート/エクスポートにのみ使用されます。Microsoft メモ帳はこの規則を採用しており、現在では Unicode 標準で推奨されています。

フリーズカウントをインクリメントします。

Type: HRESULT

ITextDocument::Freeze カウントが 0 以外の場合は S_OK を返します。ITextDocument::Freeze カウントが 0 の場合は FALSE を返します。

フリーズカウントが 0 以外の場合、画面の更新は無効になります。これにより、一連の編集操作を、画面更新によるパフォーマンス低下やちらつきなしに実行できます。フリーズカウントをデクリメントするには、ITextDocument::Unfreeze メソッドを呼び出します。

フリーズカウントをデクリメントします。

Type: HRESULT

                    フリーズカウントが 0 の場合、メソッドは <b>S_OK</b> を返します。メソッドが失敗した場合は <b>S_FALSE</b> を返し、
                    フリーズカウントが 0 以外であることを示します。COM エラーコードの詳細については、<a href="/windows/desktop/com/error-handling-in-com">Error Handling in COM</a> を参照してください。

フリーズカウントが 0 になると、画面の更新が有効になります。このメソッドはカウントを 0 未満にデクリメントすることはできず、フリーズカウントが 0 の状態で実行してもエラーは発生しません。

なお、編集コレクションが有効な場合、フリーズカウントが 0 であっても画面の更新は抑制されます。

編集コレクション(アンドゥのグループ化とも呼ばれます)をオンにします。

Type: HRESULT

メソッドが成功した場合は S_OK を返します。失敗した場合は、以下のいずれかの COM エラーコードを返します。COM エラーコードの詳細については、Error Handling in COM を参照してください。

1 回の Undo コマンドで、編集コレクションがオンの間に行われたすべての変更が取り消されます。

編集コレクション(アンドゥのグループ化とも呼ばれます)をオフにします。

Type: HRESULT

メソッドが成功した場合は S_OK を返します。失敗した場合は、以下の COM エラーコードを返します。COM エラーコードの詳細については、Error Handling in COM を参照してください。

フリーズカウントが 0 以外でない限り、画面のフリーズは解除されます。

指定した回数のアンドゥ操作を実行します。

Type: HRESULT

                    <i>Count</i> 回のアンドゥ操作がすべて実行された場合は <b>S_OK</b> を返します。メソッドが失敗した場合は <b>S_FALSE</b> を返し、
                    <i>Count</i> 回未満のアンドゥ操作しか実行されなかったことを示します。COM エラーコードの詳細については、<a href="/windows/desktop/com/error-handling-in-com">Error Handling in COM</a> を参照してください。

指定した回数のリドゥ操作を実行します。

Type: HRESULT

メソッドが成功した場合は S_OK を返します。失敗した場合は、以下の COM エラーコードを返します。COM エラーコードの詳細については、Error Handling in COM を参照してください。

ドキュメントのアクティブなストーリー内の指定した範囲のコンテンツに対するテキスト範囲オブジェクトを取得します。

Type: HRESULT

メソッドが成功した場合は S_OK を返します。失敗した場合は、以下のいずれかの COM エラーコードを返します。COM エラーコードの詳細については、Error Handling in COM を参照してください。

画面上の指定した点、またはそれに最も近いコンテンツに対する範囲を取得します。

Type: HRESULT

メソッドが成功した場合は S_OK を返します。失敗した場合は、以下のいずれかの COM エラーコードを返します。COM エラーコードの詳細については、Error Handling in COM を参照してください。