DrawTextExA 関数 (winuser.h)
DrawTextEx 関数は、指定した四角形に書式設定されたテキストを描画します。
構文
int DrawTextExA(
[in] HDC hdc,
[in, out] LPSTR lpchText,
[in] int cchText,
[in, out] LPRECT lprc,
[in] UINT format,
[in] LPDRAWTEXTPARAMS lpdtp
);
パラメーター
[in] hdc
描画するデバイス コンテキストへのハンドル。
[in, out] lpchText
描画するテキストを含む文字列へのポインター。 cchText パラメーターが -1 の場合、文字列は null で終わる必要があります。
dwDTFormat
[in] cchText
lpchTextによって指 文字列の
[in, out] lprc
テキストを書式設定する論理座標で四角形を含む RECT 構造体へのポインター。
[in] format
書式設定オプション。 このパラメーターには、次の値のうち 1 つ以上を指定できます。
| 価値 | 意味 |
|---|---|
|
テキストを四角形の下部に配置します。 この値は、DT_SINGLELINE値でのみ使用されます。 |
|
四角形の幅と高さを決定します。 複数行のテキストがある場合、DrawTextEx は、lprc パラメーターによって指される四角形の幅を使用し、四角形の底を拡張してテキストの最後の行を連結します。 テキストの行が 1 行しかない場合は、DrawTextEx は、四角形の右側を変更して、行の最後の文字を囲みます。 いずれの場合も、DrawTextEx |
|
テキストを四角形内で水平方向に中央揃えします。 |
|
複数行編集コントロールのテキスト表示特性を複製します。 具体的には、平均文字幅は編集コントロールの場合と同じ方法で計算され、関数は部分的に表示される最後の行を表示しません。 |
|
表示されるテキストの場合は、文字列の末尾を省略記号に置き換え、結果が指定した四角形に収まるようにします。 四角形の制限を超える単語 (文字列の末尾ではない) は省略記号なしで切り捨てられます。 DT_MODIFYSTRING フラグが指定されていない限り、文字列は変更されません。
DT_PATH_ELLIPSISとDT_WORD_ELLIPSISと比較します。 |
|
タブ文字を展開します。 タブあたりの既定の文字数は 8 文字です。 |
|
行の高さの先頭に外部フォントが含まれます。 通常、外部の先頭はテキスト行の高さに含まれません。 |
|
テキスト内のアンパサンド (&) プレフィックス文字を無視します。 次の文字は下線付きではありませんが、他のニーモニックプレフィックス文字は引き続き処理されます。
例： 入力文字列: "A&bc&&d" normal: "Abc&d" DT_HIDEPREFIX: "Abc&d" DT_NOPREFIXとDT_PREFIXONLYと比較します。 |
|
システム フォントを使用してテキスト メトリックを計算します。 |
|
テキストを左揃えにします。 |
|
指定した文字列を、表示されるテキストと一致するように変更します。 DT_END_ELLIPSISまたはDT_PATH_ELLIPSISが指定されていない限り、この値は無効です。 |
|
クリッピングなしで描画します。 DrawTextEx は、DT_NOCLIPを使用するとやや高速です。 |
|
DBCS (ダブルワイド文字ストリング) での改行を防ぎ、改行規則が SBCS 文字列と同等になるようにします。 たとえば、これはアイコン ラベルの読みやすさを高める目的で、韓国語のウィンドウで使用できます。 DT_WORDBREAKが指定されていない限り、この値は無効です。 |
|
プレフィックス文字の処理をオフにします。 通常、DrawTextEx は、アンパサンド (&) ニーモニック プレフィックス文字を、次の文字をアンダースコア付けするディレクティブとして解釈し、二重アンパサンド (&&) ニーモニック プレフィックス文字を 1 つのアンパサンドを印刷するディレクティブとして解釈します。 DT_NOPREFIXを指定すると、この処理はオフになります。 DT_HIDEPREFIXとDT_PREFIXONLYとの比較 |
|
表示されるテキストの場合、文字列の中央にある文字を省略記号に置き換え、結果が指定した四角形に収まるようにします。 文字列に円記号 (\\) 文字が含まれている場合、DT_PATH_ELLIPSISは最後の円記号の後のテキストをできるだけ保持します。 DT_MODIFYSTRING フラグが指定されていない限り、文字列は変更されません。
DT_END_ELLIPSISとDT_WORD_ELLIPSISと比較します。 |
|
アンパサンド (&) プレフィックス文字の後の文字の位置に下線のみを描画します。 文字列内の文字を描画しません。
例： 入力文字列: "A&bc&&d" normal: "Abc&d" PREFIXONLY: " _ " DT_NOPREFIXとDT_HIDEPREFIXと比較します。 |
|
テキストを右揃えにします。 |
|
hdc で選択したフォントがヘブライ語またはアラビア語のフォントである場合、双方向テキストの右から左への読み取り順序でのレイアウト。 すべてのテキストの既定の読み取り順序は左から右です。 |
|
1 行のみにテキストを表示します。 復帰と改行は行を中断しません。 |
|
タブ位置を設定します。 lpDTParams パラメーターが指す DRAWTEXTPARAMS 構造体は、タブ位置あたりの平均文字幅の数を指定します。 |
|
テキストを四角形の上部に揃えます。 |
|
テキストを垂直方向に中央揃えします。 この値は、DT_SINGLELINE値でのみ使用されます。 |
|
単語を区切ります。 lprc パラメーターで指定された四角形の端を越えて単語が拡張されている場合、単語間で行が自動的に分割されます。 復帰改行シーケンスも改行します。 |
|
四角形に収まらない単語を切り捨て、省略記号を追加します。
DT_END_ELLIPSISとDT_PATH_ELLIPSISと比較します。 |
[in] lpdtp
追加の書式設定オプションを指定する DRAWTEXTPARAMS 構造体へのポインター。 このパラメーターは NULL
戻り値
関数が成功した場合、戻り値は論理単位でのテキストの高さになります。 DT_VCENTERまたはDT_BOTTOMが指定されている場合、戻り値は、描画されたテキストの lprc->top から下部へのオフセットです。
関数が失敗した場合、戻り値は 0 です。
備考
DrawTextEx 関数は、エスケープメントと方向の両方が 0 であるフォントのみをサポートします。
デバイス コンテキストのテキスト配置モードには、TA_LEFT、TA_TOP、およびTA_NOUPDATECPフラグを含める必要があります。
手記
winuser.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして DrawTextEx を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされる最小サーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| ターゲット プラットフォーム の |
ウィンドウズ |
| ヘッダー | winuser.h (Windows.h を含む) |
| ライブラリ | User32.lib |
| DLL | User32.dll |
| API セットの | ext-ms-win-ntuser-misc-l1-2-0 (Windows 8.1 で導入) |
関連項目
DRAWTEXTPARAMS を
DrawText の