xtd::drawing::string_format Class Reference

Inheritance diagram for xtd::drawing::string_format:

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.

Public Constructors
	string_format ()=default
	Initializes a new string_format object.
	string_format (const xtd::drawing::string_format &format)=default
	Initializes a new string_format object from the specified existing string_format object.
	string_format (xtd::drawing::string_format_flags options)
	Initializes a new string_format object with the specified string_format_flags enumeration.

Public Properties
xtd::drawing::string_alignment	alignment () const noexcept
	Gets horizontal alignment of the string.
xtd::drawing::string_format &	alignment (xtd::drawing::string_alignment alignment) noexcept
	Sets horizontal alignment of the string.
xtd::drawing::string_format_flags	format_flags () const noexcept
	Gets a string_formatFlags enumeration that contains formatting information.
xtd::drawing::string_format &	format_flags (xtd::drawing::string_format_flags format_flag) noexcept
	Sets a string_formatFlags enumeration that contains formatting information.
xtd::drawing::text::hotkey_prefix	hotkey_prefix () const noexcept
	Gets the HotkeyPrefix object for this string_format object.
xtd::drawing::string_format &	hotkey_prefix (xtd::drawing::text::hotkey_prefix hotkey_prefix) noexcept
	Sets the HotkeyPrefix object for this string_format object.
xtd::drawing::string_alignment	line_alignment () const noexcept
	Gets vertical alignment of the string.
xtd::drawing::string_format &	line_alignment (xtd::drawing::string_alignment line_alignment) noexcept
	Sets vertical alignment of the string.
xtd::drawing::string_trimming	trimming () const noexcept
	Gets the string_trimming enumeration for this string_format object.
xtd::drawing::string_format &	trimming (xtd::drawing::string_trimming trimming) noexcept
	Sets the string_trimming enumeration for this string_format object.

Public Static Properties
static xtd::drawing::string_format	generic_default () noexcept
	Gets a generic default string_format object.
static xtd::drawing::string_format	generic_typographic () noexcept
	Gets a generic typographic string_format object.

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename object_t >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual xtd::string	to_string () const noexcept
	Returns a xtd::string that represents the current object.
Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<typename object_a_t , typename object_b_t >
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.

---

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

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