Asposecpplib
System::Drawing::StringFormat Class Reference

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

Inherits System::Object.

Public Member Functions

ASPOSECPP_SHARED_API StringFormat ()
 Constructs a new instance of StringFormat class. More...
 
ASPOSECPP_SHARED_API StringFormat (StringFormatFlags options, int32_t language=0)
 Constructs a new instance of StringFormat class with the specified format flags and language. More...
 
ASPOSECPP_SHARED_API StringFormat (const SharedPtr< StringFormat > &format)
 Copy constructor. More...
 
ASPOSECPP_SHARED_API StringFormatFlags get_FormatFlags () const
 Returns a bitwise combination of StringFormatFlags that specifies the string format represented by the current object. More...
 
ASPOSECPP_SHARED_API void set_FormatFlags (StringFormatFlags value)
 Sets the string format flags. More...
 
ASPOSECPP_SHARED_API StringAlignment get_Alignment () const
 Returns a value that indicates horizontal alignment of the string. More...
 
ASPOSECPP_SHARED_API void set_Alignment (StringAlignment value)
 Sets horizontal alignment of the string. More...
 
ASPOSECPP_SHARED_API StringAlignment get_LineAlignment () const
 Returns a value that indicates vertical alignment of the string. More...
 
ASPOSECPP_SHARED_API void set_LineAlignment (StringAlignment value)
 Sets vertical alignment of the string. More...
 
ASPOSECPP_SHARED_API StringTrimming get_Trimming () const
 Returns a value that indicates how the string is trimmed. More...
 
ASPOSECPP_SHARED_API void set_Trimming (StringTrimming value)
 Sets a value that specifies how the string is trimmed. More...
 
ASPOSECPP_SHARED_API ArrayPtr< float > GetTabStops (float &first_tab_offset) const
 Returns the tab stops for the current StringFormat object. More...
 
ASPOSECPP_SHARED_API void SetTabStops (float first_tab_offset, const ArrayPtr< float > &tab_stops)
 Sets the tab stops for the current StringFormat object. More...
 
ASPOSECPP_SHARED_API int32_t get_DigitSubstitutionLanguage () const
 Returns a value that indicats the language that is used when local digits are substituted with western digits. More...
 
ASPOSECPP_SHARED_API StringDigitSubstitute get_DigitSubstitutionMethod () const
 Returns digit substitution method. More...
 
ASPOSECPP_SHARED_API Text::HotkeyPrefix get_HotkeyPrefix () const
 Returns the value that indicates how the hot key prefix is displayed. More...
 
ASPOSECPP_SHARED_API void set_HotkeyPrefix (Text::HotkeyPrefix value)
 Sets the value that specifies how the hot key prefix should be displayed. More...
 
ASPOSECPP_SHARED_API void SetDigitSubstitution (int32_t language, StringDigitSubstitute substitute)
 Sets digit substitution language and method. More...
 
ASPOSECPP_SHARED_API 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...
 
ASPOSECPP_SHARED_API SharedPtr< StringFormatClone ()
 Returns an exact copy of the current object. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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 refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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...
 
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 ASPOSECPP_SHARED_API SharedPtr< StringFormatget_GenericTypographic ()
 Returns a StringFormat object that represents a generic typographic format. More...
 
static ASPOSECPP_SHARED_API SharedPtr< StringFormatget_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 TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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]

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

Constructs a new instance of StringFormat class.

◆ StringFormat() [2/3]

ASPOSECPP_SHARED_API 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
optionsA bitwise combination of StringFormatFlags enum value that specify the string format to be represented by the object being created
languageA language of the text

◆ StringFormat() [3/3]

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

Copy constructor.

Parameters
formatA StringFormat object to copy from

Member Function Documentation

◆ Clone()

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

Returns an exact copy of the current object.

◆ get_Alignment()

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

Returns a value that indicates horizontal alignment of the string.

◆ get_DigitSubstitutionLanguage()

ASPOSECPP_SHARED_API 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()

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

Returns digit substitution method.

◆ get_FormatFlags()

ASPOSECPP_SHARED_API 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 ASPOSECPP_SHARED_API SharedPtr<StringFormat> System::Drawing::StringFormat::get_GenericDefault ( )
static

Returns a StringFormat object that represents a generic default format.

◆ get_GenericTypographic()

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

Returns a StringFormat object that represents a generic typographic format.

◆ get_HotkeyPrefix()

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

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

◆ get_LineAlignment()

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

Returns a value that indicates vertical alignment of the string.

◆ get_Trimming()

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

Returns a value that indicates how the string is trimmed.

◆ GetTabStops()

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

Returns the tab stops for the current StringFormat object.

Parameters
first_tab_offsetOutput 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()

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

Sets horizontal alignment of the string.

Parameters
valueThe value to set

◆ set_FormatFlags()

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

Sets the string format flags.

Parameters
valueThe value to set

◆ set_HotkeyPrefix()

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

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

Parameters
valueThe value to set

◆ set_LineAlignment()

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

Sets vertical alignment of the string.

Parameters
valueThe value to set

◆ set_Trimming()

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

Sets a value that specifies how the string is trimmed.

Parameters
valueThe value to set

◆ SetDigitSubstitution()

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

Sets digit substitution language and method.

Parameters
languageA language to bu esed when local digits are substituted with western digits.
substituteSpecifies how digits are displayed

◆ SetMeasurableCharacterRanges()

ASPOSECPP_SHARED_API 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
rangesThe character ranges to set

◆ SetTabStops()

ASPOSECPP_SHARED_API 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_offsetThe number of spaces between the beginning of a text line and the first tab stop
tab_stopsAn array containing values which are the numbers of spaces between tab stops.