ITextRange::GetText メソッド (tom.h)

  • [アーティクル]

この範囲内のプレーン テキストを取得します。 Text プロパティは、 ITextRange インターフェイスの既定のプロパティです。

構文

HRESULT GetText(
  BSTR *pbstr
);

パラメーター

pbstr

種類: BSTR*

テキスト。

戻り値

種類: HRESULT

メソッドが成功すると、 S_OKが返されます。 メソッドが失敗した場合は、次のいずれかのエラー コードが返されます。 COM エラー コードの詳細については、「COM でのエラー処理」を参照してください。

リターン コード 説明
E_INVALIDARG
 pbstr が null です。
E_OUTOFMEMORY
 テキストを保持するためのメモリが不足しています。

注釈

ITextRange::GetText メソッドは、範囲内のプレーン テキストを返します。 Text プロパティは、ITextRange の既定のプロパティです。これは、次の Microsoft Visual Basic for Applications (VBA) の例のように、範囲に対して自動的に呼び出されます。

print range

次の例の一部では、この事実を使用します。 ITextRange::SetText メソッドは、範囲テキストに bstr を置き換えます。 1 つの文字を処理する場合、Char プロパティは Text プロパティよりも効率的であり、文字を格納するために 1 つの文字範囲を作成する必要はありません。 範囲が縮退している場合、Text プロパティを使用すると、テキストを簡単に挿入できます。 次の VBA の例に示すように、範囲内のテキストを削除することもできます。

range.delete

range = ""

Text プロパティを使用すると、ある範囲を別の範囲に設定するだけで、プレーン テキストを 1 つの場所から別の場所にコピーできます。 (これは Duplicate プロパティとは大きく異なります。詳細については、「 ITextRange::GetDuplicate」を参照してください)。 次の Microsoft Visual Basic の例のステートメントは、range1 のテキストを range2 のテキストに設定します。

range1 = range2 ' Replace range1's text by range2's

範囲は、異なるストーリー内にある場合と、異なるアプリケーション内に存在する場合があります。 ただし、最初に テキストを BSTR にコピーしてから、その文字列からターゲットの場所にコピーすることを意味します。 大量のテキストの場合、 ITextRange::Copy メソッドと ITextRange::P aste メソッドは、ソースからターゲットに直接、およびソースとターゲットでサポートされている任意の形式でコピーを実行できるため、高速になります。

Text プロパティによって返されるテキストは、Unicode で指定されます。 段落末記号は、元のファイルに応じて、0x2029 (Unicode 段落区切り記号) または復帰/改行 (CR/LF) (0xd、0xa)、または復帰単独で指定できます。 Microsoft Wordは、ファイル、クリップボード、または IDataObject から別の選択肢を読み取る場合を除き、復帰のみを使用します。 埋め込みオブジェクトのプレースホルダーは、Unicode 値0xFFFCを持つ特殊文字 WCH_EMBEDDINGによって指定されます。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー tom.h
[DLL] Msftedit.dll

関連項目

概念

コピー

GetDuplicate

ITextRange

[貼り付け]

リファレンス

Text オブジェクト モデル