xtd 0.2.0
Loading...
Searching...
No Matches

◆ text_format_flags

enum class xtd::forms::text_format_flags
strong

Specifies the display and layout information for text strings.

Header
#include <xtd/forms/text_format_flags>
Namespace
xtd::forms
Library
xtd.forms
Remarks
The text_format_flags enumeration is used by the text_renderer when drawing and measuring text. The text_renderer does not support adding tab stops to drawn text, although you can expand existing tab stops using the expand_tabs flag.
Enumerator
default_format 

Applies the default formatting, which is left-aligned.

glyph_overhang_padding 

Adds padding to the bounding rectangle to accommodate overhanging glyphs. This is the default.

left 

Aligns the text on the left side of the clipping area. This is the default.

top 

Aligns the text on the top of the bounding rectangle. This is the default.

horizontal_center 

Centers the text horizontally within the bounding rectangle.

right 

Aligns the text on the right side of the clipping area.

vertical_center 

Centers the text vertically, within the bounding rectangle.

bottom 

Aligns the text on the bottom of the bounding rectangle. Applied only when the text is a single line.v.

word_break 

Breaks the text at the end of a word.

single_line 

Displays the text in a single line.

expand_tabs 

Expands tab characters. The default number of characters per tab is eight. The word_ellipsis, path_ellipsis, and end_ellipsis values cannot be used with expand_tabs.

no_clipping 

Allows the overhanging parts of glyphs and unwrapped text reaching outside the formatting rectangle to show.

external_leading 

Includes the font external leading in line height. Typically, external leading is not included in the height of a line of text.

no_prefix 

Turns off processing of prefix characters. Typically, the ampersand (&) mnemonic-prefix character is interpreted as a directive to underscore the character that follows, and the double-ampersand (&&) mnemonic-prefix characters as a directive to print a single ampersand. By specifying no_prefix, this processing is turned off. For example, an input string of "A&bc&&d" with no_prefix applied would result in output of "A&bc&&d". Compare with prefix_only.

internal 

Uses the system font to calculate text metrics.

text_box_control 

Specifies the text should be formatted for display on a TextBox control.

path_ellipsis 

Removes the center of trimmed lines and replaces it with an ellipsis. When used to draw text by text_renderer, the string is not modified unless the modify_string flag is specified. Compare with end_ellipsis and word_ellipsis.

end_ellipse 

Removes the end of trimmed lines, and replaces them with an ellipsis. When used to draw text by text_renderer, the string is not modified unless the modify_string flag is specified. Compare with path_ellipsis and word_ellipsis.

modify_string 

Has no effect on the drawn text or text measurements. When used to draw text by TextRenderer, modifies the specified string parameter to match the displayed text if ellipsis are shown. This value has no effect unless end_ellipsis or path_ellipsis is specified.

right_to_left 

Displays the text from right to left.

word_ellipsis 

Trims the line to the nearest word and an ellipsis is placed at the end of a trimmed line. Compare with end_ellipsis and path_ellipsis.

no_full_width_characterB_break 

A legacy value that has no effect. It prevents a line break at a double-wide character string, so that the line-breaking rule is equivalent to that for single-wide character strings.

hide_prefix 

Ignores the ampersand (&) prefix character in the text, so that the letter that follows won't be underlined, but other mnemonic-prefix characters are still processed.

prefix_only 

Draws only an underline at the position of the character following the ampersand (&) prefix character and doesn't draw any other characters in the string.

preserve_graphics_clipping 

Preserves the clipping specified by a graphics object. Applies only to methods receiving an idevice_context that is a graphics.

preserve_graphics_translate_transform 

Preserves the transformation specified by a graphics. Applies only to methods receiving an ideviceContext that is a graphics.

no_padding 

Does not add padding to the bounding rectangle.

left_and_right_padding 

Adds padding to both sides of the bounding rectangle.