TextFormatFlags 列挙体とは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

TextFormatFlags 列挙体

メモ : この列挙体は、.NET Framework version 2.0 で新しく追加されたものです。

文字列の表示情報およびレイアウト情報を指定します。

この列挙体には、メンバ値のビットごとの組み合わせを可能にする FlagsAttribute 属性が含まれています。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

<FlagsAttribute> _
Public Enumeration TextFormatFlags

Visual Basic (使用法)

Dim instance As TextFormatFlags

[FlagsAttribute] 
public enum TextFormatFlags

C++

[FlagsAttribute] 
public enum class TextFormatFlags

/** @attribute FlagsAttribute() */ 
public enum TextFormatFlags

JScript

FlagsAttribute 
public enum TextFormatFlags

メンバ

	メンバ名	説明
	Bottom	外接する四角形の下部に揃えてテキストを配置します。テキストが 1 行の場合にだけ適用されます。
	Default	既定の書式 (左寄せ) を適用します。
	EndEllipsis	トリムされる行の末尾を削除し、省略記号に置き換えます。
	ExpandTabs	タブ文字を拡張します。タブごとの既定の文字数は 8 文字です。WordEllipsis、PathEllipsis、および EndEllipsis の各値は、ExpandTabs では使用できません。
	ExternalLeading	行の高さにフォントの外部レディングを含めます。通常、外部レディングは、テキストの行の高さに含まれません。
	GlyphOverhangPadding	グリフの突出部が収まるように、外接する四角形にパディングを追加します。
	HidePrefix	Windows 2000 および Windows XP だけに適用されます。テキスト内のアンパサンド (&) 先頭文字を無視します。その後に続く文字は下線付きになりませんが、他のニーモニック先頭文字は処理されます。たとえば、HidePrefix が適用された "A&bc&&d" という入力文字列は、"Abc&d" として出力されます。 NoPrefix および PrefixOnly と比較してください。
	HorizontalCenter	外接する四角形内に、テキストを横方向に中央揃えで配置します。
	Internal	システムフォントを使用して、テキストメトリックを計算します。
	Left	テキストをクリッピング領域の左側に揃えて配置します。
	LeftAndRightPadding	外接する四角形の両側にパディングを追加します。
	ModifyString	表示されるテキストに一致するように、指定した文字列を変更します。EndEllipsis または PathEllipsis も指定されていなければ、この値は無効です。
	NoClipping	グリフの突出部と書式指定用の四角形からはみ出すラップされていないテキストを表示できるようにします。
	NoFullWidthCharacterBreak	Windows 98、Windows Me、Windows 2000、または Windows XP だけに適用されます。ダブルワイド文字列で改行されないようにして、改行規則が単一ワイド文字列の場合と同じになるようにします。たとえば、NoFullWidthCharacterBreak を使用すると、韓国語のウィンドウでアイコンラベルの読みやすさが向上します。WordBreak も指定されていなければ、この値は無効です。
	NoPadding	外接する四角形にパディングを追加しません。
	NoPrefix	先頭文字の処理を無効にします。通常、アンパサンド (&) ニーモニック先頭文字は、その後の文字に下線を付けるディレクティブとして解釈され、ダブルアンパサンド (&&) ニーモニック先頭文字は、単一のアンパサンドを出力するディレクティブとして解釈されます。NoPrefix を指定すると、この処理が無効になります。たとえば、NoPrefix が適用された "A&bc&&d" という入力文字列は、"A&bc&&d" として出力されます。 HidePrefix および PrefixOnly と比較してください。
	PathEllipsis	トリムされる行の中央を削除し、省略記号に置き換えます。
	PrefixOnly	Windows 2000 または Windows XP だけに適用されます。アンパサンド (&) 先頭文字の次の文字の位置に下線だけを描画します。文字列に含まれる他の文字は描画しません。たとえば、"A&bc&&d" という入力文字列は、" _ " として出力されます。 HidePrefix および NoPrefix と比較してください。
	PreserveGraphicsClipping	Graphics オブジェクトで指定されたクリッピングを維持します。Graphics である IDeviceContext を受信するメソッドだけに適用されます。
	PreserveGraphicsTranslateTransform	Graphics で指定された変換を維持します。Graphics である IDeviceContext を受信するメソッドだけに適用されます。
	Right	テキストをクリッピング領域の右側に揃えて配置します。
	RightToLeft	テキストを右から左へ表示します。
	SingleLine	テキストを 1 行で表示します。
	TextBoxControl	テキストを TextBox コントロールに表示するために書式設定する必要があることを指定します。
	Top	外接する四角形の上部に揃えてテキストを配置します。
	VerticalCenter	外接する四角形内に、テキストを縦方向に中央揃えで配置します。
	WordBreak	単語の末尾でテキストを改行します。
	WordEllipsis	行を最も近い単語までトリムします。トリムされた行の末尾には、省略記号が配置されます。

解説

TextFormatFlags 列挙体は、テキストの描画および計測時に、TextRenderer によって使用されます。TextRenderer では、表示するテキストへのタブストップの追加はサポートされていません。ただし、ExpandTabs フラグを使用して、既存のタブストップを拡張することはできます。

使用例

TextFormatFlags 列挙体の使用方法を示すコード例を次に示します。この例を実行するには、次のコードを Windows フォームに貼り付けます。フォームの Paint イベントハンドラから RenderText7 を呼び出し、e を PaintEventArgs として渡します。

Visual Basic

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

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);
}