CDC::SetTextAlign

[アーティクル]
08/09/2011

テキスト配置フラグを設定します。

UINT SetTextAlign(
   UINT nFlags 
);

パラメーター

nFlags
テキスト配置フラグ。このフラグは点とテキストに外接する四角形の関係を指定します。点は、テキスト出力関数により指定される現在位置または座標です。テキストに外接する四角形は、テキスト文字列の隣接する文字セルによって定義されます。パラメーター nFlags には、次の 3 つのカテゴリから複数指定できます。各カテゴリから選択できるのは 1 つだけです。最初のカテゴリは x 方向のテキストの配置に影響します。
- TA_CENTER 点と外接する四角形の水平方向の中心が一致するように配置します。
- TA_LEFT 点と外接する四角形の左辺が一致するように配置します。これは、既定の設定です。
- TA_RIGHT 点と外接する四角形の右辺が一致するように配置します。
2 番目のカテゴリは y 方向のテキストの配置に影響します。
- TA_BASELINE 点と選択されたフォントのベースラインが一致するように配置します。
- TA_BOTTOM 点と外接する四角形の底辺が一致するように配置します。
- TA_TOP 点と外接する四角形の上辺が一致するように配置します。これは、既定の設定です。
3 番目のカテゴリは、テキストを書き込んだときに現在位置を更新するかどうかを決定します。
- TA_NOUPDATECP テキスト出力関数呼び出し各回の後に、現在位置を更新しません。これは、既定の設定です。
- TA_UPDATECP テキスト出力関数呼び出し各回の後に、現在の x 位置を更新します。新しい位置は、テキストに外接する四角形の右辺の位置になります。このフラグが設定されているときは、TextOut メンバー関数の呼び出しで指定された座標は無視されます。

戻り値

正常終了した場合は、直前のテキスト配置の設定を返します。下位バイトで水平配置を示し、上位バイトで垂直配置を示します。エラーが発生した場合は 0 を返します。

解説

TextOut メンバー関数および ExtTextOut メンバー関数は、ディスプレイ上またはデバイス上にテキストの文字列を配置するときに、このフラグを使います。このフラグは指定した点とテキストに外接する四角形の関係を指定します。この点の座標は、TextOut メンバー関数へのパラメーターとして渡されます。テキストに外接する四角形は、テキスト文字列の隣接する文字セルによって形成されます。