Encapsulates text layout information, display manipulations and OpenType features. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

#include <string_format.h>

Inherits System::Object.

Public Member Functions
	StringFormat ()
	Constructs a new instance of StringFormat class. More...

	StringFormat (StringFormatFlags options, int32_t language=0)
	Constructs a new instance of StringFormat class with the specified format flags and language. More...

	StringFormat (const SharedPtr< StringFormat > &format)
	Copy constructor. More...

StringFormatFlags	get_FormatFlags () const
	Returns a bitwise combination of StringFormatFlags that specifies the string format represented by the current object. More...

void	set_FormatFlags (StringFormatFlags value)
	Sets the string format flags. More...

StringAlignment	get_Alignment () const
	Returns a value that indicates horizontal alignment of the string. More...

void	set_Alignment (StringAlignment value)
	Sets horizontal alignment of the string. More...

StringAlignment	get_LineAlignment () const
	Returns a value that indicates vertical alignment of the string. More...

void	set_LineAlignment (StringAlignment value)
	Sets vertical alignment of the string. More...

StringTrimming	get_Trimming () const
	Returns a value that indicates how the string is trimmed. More...

void	set_Trimming (StringTrimming value)
	Sets a value that specifies how the string is trimmed. More...

ArrayPtr< float >	GetTabStops (float &first_tab_offset) const
	Returns the tab stops for the current StringFormat object. More...

void	SetTabStops (float first_tab_offset, const ArrayPtr< float > &tab_stops)
	Sets the tab stops for the current StringFormat object. More...

int32_t	get_DigitSubstitutionLanguage () const
	Returns a value that indicats the language that is used when local digits are substituted with western digits. More...

StringDigitSubstitute	get_DigitSubstitutionMethod () const
	Returns digit substitution method. More...

Text::HotkeyPrefix	get_HotkeyPrefix () const
	Returns the value that indicates how the hot key prefix is displayed. More...

void	set_HotkeyPrefix (Text::HotkeyPrefix value)
	Sets the value that specifies how the hot key prefix should be displayed. More...

void	SetDigitSubstitution (int32_t language, StringDigitSubstitute substitute)
	Sets digit substitution language and method. More...

void	SetMeasurableCharacterRanges (const ArrayPtr< CharacterRange > &ranges)
	Sets an array of CharacterRange objects that represent the chracter ranges measured by a call to the MeasureCharacterRanges() method. More...

SharedPtr< StringFormat >	Clone ()
	Returns an exact copy of the current object. More...

int	GetCharacterRangesCount () const
	Gets a size of the CharacterRange array. More...

Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...

virtual	~Object ()
	Destroys object. Frees all internal data structures. More...

	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Static Public Member Functions
static SharedPtr< StringFormat >	get_GenericTypographic ()
	Returns a StringFormat object that represents a generic typographic format. More...

static SharedPtr< StringFormat >	get_GenericDefault ()
	Returns a StringFormat object that represents a generic default format. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

Protected Attributes
StringFormatFlags	m_string_format_flags
	A bitwise combination of StringFormatFlags that specifies the string format represented by the current object. More...

StringAlignment	m_alignment
	A value that indicates horizontal alignment of the string. More...

StringAlignment	m_line_alignment
	A value that indicates vertical alignment of the string. More...

StringTrimming	m_trimming
	A value that indicates how the string is trimmed. More...

float	m_first_tab_offset
	Indicates the number of spaces between the beginning of a text line and the first tab stop. More...

ArrayPtr< float >	m_tab_stops
	Contains the numbers of spaces between tab stops. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Detailed Description

Encapsulates text layout information, display manipulations and OpenType features. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ StringFormat() [1/3]

System::Drawing::StringFormat::StringFormat ( )

Constructs a new instance of StringFormat class.

◆ StringFormat() [2/3]

System::Drawing::StringFormat::StringFormat	(	StringFormatFlags	options,
		int32_t	language = `0`
	)

Constructs a new instance of StringFormat class with the specified format flags and language.

Parameters

options	A bitwise combination of StringFormatFlags enum value that specify the string format to be represented by the object being created
language	A language of the text

◆ StringFormat() [3/3]

System::Drawing::StringFormat::StringFormat ( const SharedPtr< StringFormat > & format )

Copy constructor.

Parameters

format A StringFormat object to copy from

Member Function Documentation

◆ Clone()

SharedPtr< StringFormat > System::Drawing::StringFormat::Clone ( )

Returns an exact copy of the current object.

◆ get_Alignment()

StringAlignment System::Drawing::StringFormat::get_Alignment ( ) const

Returns a value that indicates horizontal alignment of the string.

◆ get_DigitSubstitutionLanguage()

int32_t System::Drawing::StringFormat::get_DigitSubstitutionLanguage ( ) const

Returns a value that indicats the language that is used when local digits are substituted with western digits.

◆ get_DigitSubstitutionMethod()

StringDigitSubstitute System::Drawing::StringFormat::get_DigitSubstitutionMethod ( ) const

Returns digit substitution method.

◆ get_FormatFlags()

StringFormatFlags System::Drawing::StringFormat::get_FormatFlags ( ) const

Returns a bitwise combination of StringFormatFlags that specifies the string format represented by the current object.

◆ get_GenericDefault()

static SharedPtr< StringFormat > System::Drawing::StringFormat::get_GenericDefault ( )

static

Returns a StringFormat object that represents a generic default format.

◆ get_GenericTypographic()

static SharedPtr< StringFormat > System::Drawing::StringFormat::get_GenericTypographic ( )

static

Returns a StringFormat object that represents a generic typographic format.

◆ get_HotkeyPrefix()

Text::HotkeyPrefix System::Drawing::StringFormat::get_HotkeyPrefix ( ) const

Returns the value that indicates how the hot key prefix is displayed.

◆ get_LineAlignment()

StringAlignment System::Drawing::StringFormat::get_LineAlignment ( ) const

Returns a value that indicates vertical alignment of the string.

◆ get_Trimming()

StringTrimming System::Drawing::StringFormat::get_Trimming ( ) const

Returns a value that indicates how the string is trimmed.

◆ GetCharacterRangesCount()

int System::Drawing::StringFormat::GetCharacterRangesCount ( ) const

Gets a size of the CharacterRange array.

Returns: a size of the CharacterRange array

◆ GetTabStops()

ArrayPtr< float > System::Drawing::StringFormat::GetTabStops ( float & first_tab_offset ) const

Returns the tab stops for the current StringFormat object.

Parameters

first_tab_offset Output argumnt; Contains the number of spaces between the beginning of a text line and the first tab stop

Returns: An array containing values which are the numbers of spaces between tab stops

◆ set_Alignment()

void System::Drawing::StringFormat::set_Alignment ( StringAlignment value )

Sets horizontal alignment of the string.

Parameters

value The value to set

◆ set_FormatFlags()

void System::Drawing::StringFormat::set_FormatFlags ( StringFormatFlags value )

Sets the string format flags.

Parameters

value The value to set

◆ set_HotkeyPrefix()

void System::Drawing::StringFormat::set_HotkeyPrefix ( Text::HotkeyPrefix value )

Sets the value that specifies how the hot key prefix should be displayed.

Parameters

value The value to set

◆ set_LineAlignment()

void System::Drawing::StringFormat::set_LineAlignment ( StringAlignment value )

Sets vertical alignment of the string.

Parameters

value The value to set

◆ set_Trimming()

void System::Drawing::StringFormat::set_Trimming ( StringTrimming value )

Sets a value that specifies how the string is trimmed.

Parameters

value The value to set

◆ SetDigitSubstitution()

void System::Drawing::StringFormat::SetDigitSubstitution	(	int32_t	language,
		StringDigitSubstitute	substitute
	)

Sets digit substitution language and method.

Parameters

language	A language to bu esed when local digits are substituted with western digits.
substitute	Specifies how digits are displayed

◆ SetMeasurableCharacterRanges()

void System::Drawing::StringFormat::SetMeasurableCharacterRanges ( const ArrayPtr< CharacterRange > & ranges )

Sets an array of CharacterRange objects that represent the chracter ranges measured by a call to the MeasureCharacterRanges() method.

Parameters

ranges The character ranges to set

◆ SetTabStops()

void System::Drawing::StringFormat::SetTabStops	(	float	first_tab_offset,
		const ArrayPtr< float > &	tab_stops
	)

Sets the tab stops for the current StringFormat object.

Parameters

first_tab_offset	The number of spaces between the beginning of a text line and the first tab stop
tab_stops	An array containing values which are the numbers of spaces between tab stops.

Member Data Documentation

◆ m_alignment

StringAlignment System::Drawing::StringFormat::m_alignment

protected

A value that indicates horizontal alignment of the string.

◆ m_first_tab_offset

float System::Drawing::StringFormat::m_first_tab_offset

protected

Indicates the number of spaces between the beginning of a text line and the first tab stop.

◆ m_line_alignment

StringAlignment System::Drawing::StringFormat::m_line_alignment

protected

A value that indicates vertical alignment of the string.

◆ m_string_format_flags

StringFormatFlags System::Drawing::StringFormat::m_string_format_flags

protected

A bitwise combination of StringFormatFlags that specifies the string format represented by the current object.

◆ m_tab_stops

ArrayPtr<float> System::Drawing::StringFormat::m_tab_stops

protected

Contains the numbers of spaces between tab stops.

◆ m_trimming

StringTrimming System::Drawing::StringFormat::m_trimming

protected

A value that indicates how the string is trimmed.

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StringFormat() [1/3]

◆ StringFormat() [2/3]

◆ StringFormat() [3/3]

Member Function Documentation

◆ Clone()

◆ get_Alignment()

◆ get_DigitSubstitutionLanguage()

◆ get_DigitSubstitutionMethod()

◆ get_FormatFlags()

◆ get_GenericDefault()

◆ get_GenericTypographic()

◆ get_HotkeyPrefix()

◆ get_LineAlignment()

◆ get_Trimming()

◆ GetCharacterRangesCount()

◆ GetTabStops()

◆ set_Alignment()

◆ set_FormatFlags()

◆ set_HotkeyPrefix()

◆ set_LineAlignment()

◆ set_Trimming()

◆ SetDigitSubstitution()

◆ SetMeasurableCharacterRanges()

◆ SetTabStops()

Member Data Documentation

◆ m_alignment

◆ m_first_tab_offset

◆ m_line_alignment

◆ m_string_format_flags

◆ m_tab_stops

◆ m_trimming