xtd - Reference Guide  0.1.0
Modern c++17 framework to create console, gui and unit test applications on Windows, macOS and Linux.
xtd::drawing::string_format Class Referencefinal

Encapsulates text layout information (such as alignment, orientation and tab stops) display manipulations (such as ellipsis insertion and national digit substitution) and OpenType features. This class cannot be inherited. More...

#include <string_format.h>

Public Member Functions

 string_format ()=default
 Initializes a new string_format object. More...
 
 string_format (const xtd::drawing::string_format &format)=default
 Initializes a new string_format object from the specified existing string_format object. More...
 
 string_format (xtd::drawing::string_format_flags options)
 Initializes a new string_format object with the specified string_format_flags enumeration. More...
 
xtd::drawing::string_alignment alignment () const
 Gets horizontal alignment of the string. More...
 
xtd::drawing::string_formatalignment (xtd::drawing::string_alignment alignment)
 Sets horizontal alignment of the string. More...
 
xtd::drawing::string_format_flags format_flags () const
 Gets a string_formatFlags enumeration that contains formatting information. More...
 
xtd::drawing::string_formatformat_flags (xtd::drawing::string_format_flags format_flag)
 Sets a string_formatFlags enumeration that contains formatting information. More...
 
xtd::drawing::hotkey_prefix hotkey_prefix () const
 Gets the HotkeyPrefix object for this string_format object. More...
 
xtd::drawing::string_formathotkey_prefix (xtd::drawing::hotkey_prefix hotkey_prefix)
 Sets the HotkeyPrefix object for this string_format object. More...
 
xtd::drawing::string_alignment line_alignment () const
 Gets vertical alignment of the string. More...
 
xtd::drawing::string_formatline_alignment (xtd::drawing::string_alignment line_alignment)
 Sets vertical alignment of the string. More...
 
xtd::drawing::string_trimming trimming () const
 Gets the string_trimming enumeration for this string_format object. More...
 
xtd::drawing::string_formattrimming (xtd::drawing::string_trimming trimming)
 Sets the string_trimming enumeration for this string_format object. More...
 

Static Public Member Functions

static xtd::drawing::string_format generic_default ()
 Gets a generic default string_format object. More...
 
static xtd::drawing::string_format generic_typographic ()
 Gets a generic typographic string_format object. More...
 

Detailed Description

Encapsulates text layout information (such as alignment, orientation and tab stops) display manipulations (such as ellipsis insertion and national digit substitution) and OpenType features. This class cannot be inherited.

Remarks
Many common formats are provided through the string_format_flags enumeration. string_format objects can be changed.

The documentation for this class was generated from the following file: