TextFormatFlags 列挙型
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
テキスト文字列の表示情報とレイアウト情報を指定します。
この列挙体は、メンバー値のビットごとの組み合わせをサポートしています。
public enum class TextFormatFlags
[System.Flags]
public enum TextFormatFlags
[<System.Flags>]
type TextFormatFlags =
Public Enum TextFormatFlags
- 継承
- 属性
フィールド
| 名前 | 値 | 説明 |
|---|---|---|
| Default | 0 | 左揃えの既定の書式を適用します。 |
| GlyphOverhangPadding | 0 | 外接する四角形にパディングを追加して、オーバーハンググリフに対応します。 これが既定値です。 |
| Left | 0 | クリッピング領域の左側にテキストを配置します。 これが既定値です。 |
| Top | 0 | 外接する四角形の上部にテキストを配置します。 これが既定値です。 |
| HorizontalCenter | 1 | 外接する四角形内でテキストを水平方向に中央揃えします。 |
| Right | 2 | クリッピング領域の右側にテキストを配置します。 |
| VerticalCenter | 4 | 境界の四角形内でテキストを垂直方向に中央揃えします。 |
| Bottom | 8 | 外接する四角形の下部にテキストを配置します。 テキストが 1 行の場合にのみ適用されます。 |
| WordBreak | 16 | 単語の末尾にあるテキストを区切ります。 |
| SingleLine | 32 | テキストを 1 行で表示します。 |
| ExpandTabs | 64 | タブ文字を展開します。 タブあたりの既定の文字数は 8 文字です。 WordEllipsis、PathEllipsis、およびEndEllipsisの値は、ExpandTabsでは使用できません。 |
| NoClipping | 256 | グリフのオーバーハング部分と、書式設定する四角形の外側に到達するラップされていないテキストを表示できるようにします。 |
| ExternalLeading | 512 | 行の高さの先頭に外部フォントが含まれます。 通常、外部の先頭はテキスト行の高さに含まれません。 |
| NoPrefix | 2048 | プレフィックス文字の処理をオフにします。 通常、アンパサンド (&) ニーモニック プレフィックス文字は、後の文字をアンダースコアにするディレクティブとして解釈され、1 つのアンパサンドを出力するディレクティブとして二重アンパサンド (&) ニーモニック プレフィックス文字が解釈されます。
NoPrefixを指定すると、この処理はオフになります。 たとえば、 NoPrefix が適用された "A>bc> " の入力文字列は、"A&bc> の出力になります。
|
| Internal | 4096 | システム フォントを使用してテキスト メトリックを計算します。 |
| TextBoxControl | 8192 | TextBox コントロールに表示するテキストを書式設定する必要があることを指定します。 |
| PathEllipsis | 16384 | トリミングされた線の中心を削除し、省略記号で置き換えます。
|
| EndEllipsis | 32768 | トリミングされた行の末尾を削除し、省略記号で置き換えます。
|
| ModifyString | 65536 | 描画されたテキストまたはテキストの測定値には影響しません。
|
| RightToLeft | 131072 | テキストを右から左に表示します。 |
| WordEllipsis | 262144 | 行を最も近い単語にトリミングし、省略記号をトリミングした行の末尾に配置します。 EndEllipsisとPathEllipsisと比較します。 |
| NoFullWidthCharacterBreak | 524288 | 影響のないレガシ値。 これにより、2 倍幅の文字列での改行が防止されるため、改行ルールは 1 文字の文字列の場合と同じになります。 |
| HidePrefix | 1048576 | テキスト内のアンパサンド (> プレフィックス文字) を無視して、後の文字に下線が引かないようにしますが、他のニーモニック プレフィックス文字は引き続き処理されます。 |
| PrefixOnly | 2097152 | アンパサンド (> プレフィックス文字) の後の文字の位置に下線のみを描画し、文字列内の他の文字は描画しません。 |
| PreserveGraphicsClipping | 16777216 | Graphics オブジェクトで指定されたクリッピングを保持します。 GraphicsであるIDeviceContextを受け取るメソッドにのみ適用されます。 |
| PreserveGraphicsTranslateTransform | 33554432 | Graphicsで指定された変換を保持します。 GraphicsであるIDeviceContextを受け取るメソッドにのみ適用されます。 |
| NoPadding | 268435456 | 外接する四角形にパディングを追加しません。 |
| LeftAndRightPadding | 536870912 | 外接する四角形の両側にパディングを追加します。 |
例
次の例では、 TextFormatFlags 列挙型を使用する方法を示します。 この例を実行するには、次のコードを Windows フォームに貼り付けます。 フォームのPaint イベント ハンドラーからRenderText6を呼び出し、eをPaintEventArgsとして渡します。
private void RenderText6(PaintEventArgs e)
{
TextFormatFlags flags = TextFormatFlags.Bottom | TextFormatFlags.EndEllipsis;
TextRenderer.DrawText(e.Graphics, "This is some text that will be clipped at the end.", this.Font,
new Rectangle(10, 10, 100, 50), SystemColors.ControlText, flags);
}
Private Sub RenderText6(ByVal e As PaintEventArgs)
Dim flags As TextFormatFlags = TextFormatFlags.Bottom Or _
TextFormatFlags.EndEllipsis
TextRenderer.DrawText(e.Graphics, _
"This is some text that will be clipped at the end.", _
Me.Font, New Rectangle(10, 10, 100, 50), SystemColors.ControlText, flags)
End Sub
注釈
TextFormatFlags列挙は、テキストを描画および測定するときにTextRendererによって使用されます。
TextRendererでは、描画されたテキストにタブ位置を追加することはできませんが、ExpandTabs フラグを使用して既存のタブ位置を展開することはできます。