Definition

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.

class drawing_export_ string_format final : public xtd::object

Inheritance: xtd::object → xtd::drawing::string_dormat

Namespace: xtd::drawing

Library: xtd.drawing

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

Examples:: hello_world_paint.cpp, hello_world_png.cpp, owner_button.cpp, and user_control.cpp.

Constructors
	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...

Properties
xtd::drawing::string_alignment	alignment () const noexcept
	Gets horizontal alignment of the string. More...

xtd::drawing::string_format &	alignment (xtd::drawing::string_alignment alignment) noexcept
	Sets horizontal alignment of the string. More...

xtd::drawing::string_format_flags	format_flags () const noexcept
	Gets a string_formatFlags enumeration that contains formatting information. More...

xtd::drawing::string_format &	format_flags (xtd::drawing::string_format_flags format_flag) noexcept
	Sets a string_formatFlags enumeration that contains formatting information. More...

xtd::drawing::text::hotkey_prefix	hotkey_prefix () const noexcept
	Gets the HotkeyPrefix object for this string_format object. More...

xtd::drawing::string_format &	hotkey_prefix (xtd::drawing::text::hotkey_prefix hotkey_prefix) noexcept
	Sets the HotkeyPrefix object for this string_format object. More...

xtd::drawing::string_alignment	line_alignment () const noexcept
	Gets vertical alignment of the string. More...

xtd::drawing::string_format &	line_alignment (xtd::drawing::string_alignment line_alignment) noexcept
	Sets vertical alignment of the string. More...

xtd::drawing::string_trimming	trimming () const noexcept
	Gets the string_trimming enumeration for this string_format object. More...

xtd::drawing::string_format &	trimming (xtd::drawing::string_trimming trimming) noexcept
	Sets the string_trimming enumeration for this string_format object. More...

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

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

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object. More...

bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object. More...

virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type. More...

virtual type_object	get_type () const noexcept
	Gets the type of the current instance. More...

template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const noexcept
	Creates a shallow copy of the current object. More...

virtual xtd::ustring	to_string () const noexcept
	Returns a sxd::ustring that represents the current object. More...

Static Public Member Functions inherited from xtd::object
static bool	equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are considered equal. More...

static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance. More...

Constructor & Destructor Documentation

◆ string_format() [1/3]

xtd::drawing::string_format::string_format ( )

default

Initializes a new string_format object.

Remarks

The following table shows initial property values for an instance of string_format class.

property	initial value
format_flag	0
hotkey_prefix	none

◆ string_format() [2/3]

xtd::drawing::string_format::string_format ( const xtd::drawing::string_format & format )

default

Initializes a new string_format object from the specified existing string_format object.

Parameters

format The string_format object from which to initialize the new string_format object.

◆ string_format() [3/3]

xtd::drawing::string_format::string_format ( xtd::drawing::string_format_flags options )

explicit

Initializes a new string_format object with the specified string_format_flags enumeration.

Parameters

options The StringFormatFlags enumeration for the new StringFormat object.

Member Function Documentation

◆ alignment() [1/2]

xtd::drawing::string_alignment xtd::drawing::string_format::alignment ( ) const

noexcept

Gets horizontal alignment of the string.

Returns: A string_alignment enumeration that specifies the horizontal alignment of the string.

Remarks: Use line_alignment to specify the vertical alignment of the string.

Examples:: hello_world_paint.cpp, hello_world_png.cpp, owner_button.cpp, and user_control.cpp.

◆ alignment() [2/2]

xtd::drawing::string_format& xtd::drawing::string_format::alignment ( xtd::drawing::string_alignment alignment )

noexcept

Sets horizontal alignment of the string.

Parameters

alignment A string_alignment enumeration that specifies the horizontal alignment of the string.

Remarks: Use line_alignment to specify the vertical alignment of the string.

◆ format_flags() [1/2]

xtd::drawing::string_format_flags xtd::drawing::string_format::format_flags ( ) const

noexcept

Gets a string_formatFlags enumeration that contains formatting information.

Returns: A string_formatFlags enumeration that contains formatting information.

◆ format_flags() [2/2]

xtd::drawing::string_format& xtd::drawing::string_format::format_flags ( xtd::drawing::string_format_flags format_flag )

noexcept

Sets a string_formatFlags enumeration that contains formatting information.

Parameters

format_flag A string_formatFlags enumeration that contains formatting information.

◆ generic_default()

static xtd::drawing::string_format xtd::drawing::string_format::generic_default ( )

staticnoexcept

Gets a generic default string_format object.

Returns: The generic default string_format object.

Remarks

The following table shows initial property values for a generic default instance of the string_format class.

property	initial value
format_flag	0
alignment	near
line_alignment	near
hotkey_prefix	none
trimming	character

◆ generic_typographic()

static xtd::drawing::string_format xtd::drawing::string_format::generic_typographic ( )

staticnoexcept

Gets a generic typographic string_format object.

Returns: A generic typographic string_format object.

Remarks

The following table shows initial property values for a generic default instance of the string_format class.

property	initial value
format_flag	0b110000000000100 (no_clip\|fit_black_box\|line_limit)
alignment	near
line_alignment	near
hotkey_prefix	none
trimming	none

◆ hotkey_prefix() [1/2]

xtd::drawing::text::hotkey_prefix xtd::drawing::string_format::hotkey_prefix ( ) const

noexcept

Gets the HotkeyPrefix object for this string_format object.

Returns: The hotkey_prefix object for this string_format object, the default is hotkey_prefix::none.

Remarks: In a graphical user interface, a hot key is the underlined letter in a word (usually combined with another key, such as the Alt key) that you can press on the keyboard to activate the functionality that the word represents.

◆ hotkey_prefix() [2/2]

xtd::drawing::string_format& xtd::drawing::string_format::hotkey_prefix ( xtd::drawing::text::hotkey_prefix hotkey_prefix )

noexcept

Sets the HotkeyPrefix object for this string_format object.

Parameters

hotkey_prefix The hotkey_prefix object for this string_format object, the default is hotkey_prefix::none.

Remarks: In a graphical user interface, a hot key is the underlined letter in a word (usually combined with another key, such as the Alt key) that you can press on the keyboard to activate the functionality that the word represents.

◆ line_alignment() [1/2]

xtd::drawing::string_alignment xtd::drawing::string_format::line_alignment ( ) const

noexcept

Gets vertical alignment of the string.

Returns: A string_alignment enumeration that specifies the vertical alignment of the string.

Remarks: Use alignment to specify the horizontal alignment of the string.

◆ line_alignment() [2/2]

xtd::drawing::string_format& xtd::drawing::string_format::line_alignment ( xtd::drawing::string_alignment line_alignment )

noexcept

Sets vertical alignment of the string.

Parameters

alignment A string_alignment enumeration that specifies the vertical alignment of the string.

Remarks: Use alignment to specify the horizontal alignment of the string.

◆ trimming() [1/2]

xtd::drawing::string_trimming xtd::drawing::string_format::trimming ( ) const

noexcept

Gets the string_trimming enumeration for this string_format object.

Returns: A string_trimming enumeration that indicates how text drawn with this string_format object is trimmed when it exceeds the edges of the layout rectangle.

◆ trimming() [2/2]

xtd::drawing::string_format& xtd::drawing::string_format::trimming ( xtd::drawing::string_trimming trimming )

noexcept

Sets the string_trimming enumeration for this string_format object.

Parameters

trimming A string_trimming enumeration that indicates how text drawn with this string_format object is trimmed when it exceeds the edges of the layout rectangle.

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

xtd.drawing/include/xtd/drawing/string_format.h

Definition

Constructors

Properties

Additional Inherited Members

Constructor & Destructor Documentation

◆ string_format() [1/3]

◆ string_format() [2/3]

◆ string_format() [3/3]

Member Function Documentation

◆ alignment() [1/2]

◆ alignment() [2/2]

◆ format_flags() [1/2]

◆ format_flags() [2/2]

◆ generic_default()

◆ generic_typographic()

◆ hotkey_prefix() [1/2]

◆ hotkey_prefix() [2/2]

◆ line_alignment() [1/2]

◆ line_alignment() [2/2]

◆ trimming() [1/2]

◆ trimming() [2/2]