StringFormat

StringFormat class

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.

class StringFormat : public System::Object

Methods

MethodDescription
SharedPtr<StringFormat> Clone()Returns an exact copy of the current object.
virtual bool Equals(ptr)Compares objects using C# Object.Equals semantics.
static std::enable_if<IsSmartPtr<T1>::value&&IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)Compares reference type objects in C# style.
static std::enable_if<!IsSmartPtr<T1>::value&&!IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)Compares value type objects in C# style.
static bool Equals(float const&, float const&)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.
static bool Equals(double const&, double const&)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.
virtual bool FastCast(const Details::FastRttiBase&, void **) constFor internal purposes only.
StringAlignment get_Alignment() constReturns a value that indicates horizontal alignment of the string.
int32_t get_DigitSubstitutionLanguage() constReturns a value that indicats the language that is used when local digits are substituted with western digits.
StringDigitSubstitute get_DigitSubstitutionMethod() constReturns digit substitution method.
StringFormatFlags get_FormatFlags() constReturns a bitwise combination of StringFormatFlags that specifies the string format represented by the current object.
static SharedPtr<StringFormat> get_GenericDefault()Returns a StringFormat object that represents a generic default format.
static SharedPtr<StringFormat> get_GenericTypographic()Returns a StringFormat object that represents a generic typographic format.
Text::HotkeyPrefix get_HotkeyPrefix() constReturns the value that indicates how the hot key prefix is displayed.
StringAlignment get_LineAlignment() constReturns a value that indicates vertical alignment of the string.
StringTrimming get_Trimming() constReturns a value that indicates how the string is trimmed.
int GetCharacterRangesCount() constGets a size of the CharacterRange array.
Detail::SmartPtrCounter * GetCounter()Gets reference counter data structure associated with the object.
virtual int32_t GetHashCode() constAnalog of C# Object.GetHashCode() method. Enables hashing of custom objects.
ArrayPtr<float> GetTabStops(float&) constReturns the tab stops for the current StringFormat object.
virtual const TypeInfo& GetType() constGets actual type of object. Analog of C# System.Object.GetType() call.
virtual bool Is(const TypeInfo&) constCheck if object represents an instance of type described by targetType. Analog of C# ‘is’ operator.
void Lock()Implements C# lock() statement locking. Call directly or use LockContext sentry object.
virtual ptr MemberwiseClone() constAnalog of C# Object.MemberwiseClone() method. Enables cloning custom types.
Object()Creates object. Initializes all internal data structures.
Object(Object const&)Copy constructor. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
Object& operator=(Object const&)Assignment operator. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
static bool ReferenceEquals(ptr const&, ptr const&)Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, T const&)Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, std::nullptr_t)Reference-compares value type object with nullptr.
bool ReferenceEquals(String const&, std::nullptr_t)Specialization of Object::ReferenceEquals for case of string and nullptr.
bool ReferenceEquals(String const&, String const&)Specialization of Object::ReferenceEquals for case of strings.
int RemovedSharedRefs(int)Decreases shared reference count by specified value.
void set_Alignment(StringAlignment)Sets horizontal alignment of the string.
void set_FormatFlags(StringFormatFlags)Sets the string format flags.
void set_HotkeyPrefix(Text::HotkeyPrefix)Sets the value that specifies how the hot key prefix should be displayed.
void set_LineAlignment(StringAlignment)Sets vertical alignment of the string.
void set_Trimming(StringTrimming)Sets a value that specifies how the string is trimmed.
void SetDigitSubstitution(int32_t, StringDigitSubstitute)Sets digit substitution language and method.
void SetMeasurableCharacterRanges(const ArrayPtr<CharacterRange>&)Sets an array of CharacterRange objects that represent the chracter ranges measured by a call to the MeasureCharacterRanges() method.
void SetTabStops(float, const ArrayPtr<float>&)Sets the tab stops for the current StringFormat object.
virtual void SetTemplateWeakPtr(uint32_t)Set n’th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.
int SharedCount() constGets current value of shared reference counter.
Object * SharedRefAdded()Increments shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
int SharedRefRemovedSafe()Decrements and returns shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
StringFormat()Constructs a new instance of StringFormat class.
StringFormat(StringFormatFlags, int32_t)Constructs a new instance of StringFormat class with the specified format flags and language.
StringFormat(const SharedPtr<StringFormat>&)Copy constructor.
virtual String ToString() constAnalog of C# Object.ToString() method. Enables converting custom objects to string.
static const TypeInfo& Type()Implements C# typeof(System.Object) construct.
void Unlock()Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.
Detail::SmartPtrCounter * WeakRefAdded()Increments weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
void WeakRefRemoved()Decrements weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
virtual ~Object()Destroys object. Frees all internal data structures.

See Also