Asposecpplib
System::Globalization::StringInfo Class Reference

Splitter to iterate through string parts. 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

 StringInfo (const StringInfo &)=delete
 
StringInfooperator= (const StringInfo &)=delete
 
ASPOSECPP_SHARED_API String get_String () const
 Gets the value of the StringInfo object. More...
 
ASPOSECPP_SHARED_API void set_String (const String &value)
 Sets the value of the StringInfo object. More...
 
ASPOSECPP_SHARED_API int get_LengthInTextElements () const
 Gets number of text items in StringInfo object. More...
 
ASPOSECPP_SHARED_API String SubstringByTextElements (int starting_text_element) const
 Gets substring of text elements from the specified text element through the last text element. More...
 
ASPOSECPP_SHARED_API String SubstringByTextElements (int starting_text_element, int length_in_text_elements) const
 Gets substring of text elements from the specified text element through the specified number of text elements. More...
 
ASPOSECPP_SHARED_API bool Equals (SharedPtr< Object > value) override
 
ASPOSECPP_SHARED_API int GetHashCode () const override
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. 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 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 String GetNextTextElement (const String &str)
 Gets first element in the specified string. More...
 
static ASPOSECPP_SHARED_API String GetNextTextElement (const String &str, int index)
 Gets element at the specified index of the specified string. More...
 
static ASPOSECPP_SHARED_API SharedPtr< TextElementEnumeratorGetTextElementEnumerator (const String &str)
 Creates enumerator to iterate through string's characters. More...
 
static ASPOSECPP_SHARED_API SharedPtr< TextElementEnumeratorGetTextElementEnumerator (const String &str, int index)
 Creates enumerator to iterate through string's characters starting at the specified index. More...
 
static ASPOSECPP_SHARED_API ArrayPtr< int > ParseCombiningCharacters (const String &str)
 Gets indexes of the base characters, high surrogates and control characters. 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

Splitter to iterate through string parts. 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

◆ StringInfo()

System::Globalization::StringInfo::StringInfo ( const StringInfo )
delete

Member Function Documentation

◆ Equals()

ASPOSECPP_SHARED_API bool System::Globalization::StringInfo::Equals ( SharedPtr< Object value)
override

◆ get_LengthInTextElements()

ASPOSECPP_SHARED_API int System::Globalization::StringInfo::get_LengthInTextElements ( ) const

Gets number of text items in StringInfo object.

◆ get_String()

ASPOSECPP_SHARED_API String System::Globalization::StringInfo::get_String ( ) const

Gets the value of the StringInfo object.

Returns
String value.

◆ GetHashCode()

ASPOSECPP_SHARED_API int System::Globalization::StringInfo::GetHashCode ( ) const
overridevirtual

Analog of C# Object.GetHashCode() method. Enables hashing of custom objects.

Returns
Hash code value as calculated by corresponding class.

Reimplemented from System::Object.

◆ GetNextTextElement() [1/2]

static ASPOSECPP_SHARED_API String System::Globalization::StringInfo::GetNextTextElement ( const String str)
static

Gets first element in the specified string.

Parameters
strInput string.
Returns
First text element.

◆ GetNextTextElement() [2/2]

static ASPOSECPP_SHARED_API String System::Globalization::StringInfo::GetNextTextElement ( const String str,
int  index 
)
static

Gets element at the specified index of the specified string.

Parameters
strInput string.
indexStart index.
Returns
Text element at the specified index.

◆ GetTextElementEnumerator() [1/2]

static ASPOSECPP_SHARED_API SharedPtr<TextElementEnumerator> System::Globalization::StringInfo::GetTextElementEnumerator ( const String str)
static

Creates enumerator to iterate through string's characters.

Parameters
strString to iterate through.
Returns
Newly created enumerator.

◆ GetTextElementEnumerator() [2/2]

static ASPOSECPP_SHARED_API SharedPtr<TextElementEnumerator> System::Globalization::StringInfo::GetTextElementEnumerator ( const String str,
int  index 
)
static

Creates enumerator to iterate through string's characters starting at the specified index.

Parameters
strString to iterate through.
indexStart index.
Returns
Newly created enumerator.

◆ operator=()

StringInfo& System::Globalization::StringInfo::operator= ( const StringInfo )
delete

◆ ParseCombiningCharacters()

static ASPOSECPP_SHARED_API ArrayPtr<int> System::Globalization::StringInfo::ParseCombiningCharacters ( const String str)
static

Gets indexes of the base characters, high surrogates and control characters.

Parameters
strInput string.
Returns
Array of indexes.

◆ set_String()

ASPOSECPP_SHARED_API void System::Globalization::StringInfo::set_String ( const String value)

Sets the value of the StringInfo object.

Parameters
valueString value.

◆ SubstringByTextElements() [1/2]

ASPOSECPP_SHARED_API String System::Globalization::StringInfo::SubstringByTextElements ( int  starting_text_element) const

Gets substring of text elements from the specified text element through the last text element.

Parameters
starting_text_elementIndex of a text element.
Returns
Substring of text elements.

◆ SubstringByTextElements() [2/2]

ASPOSECPP_SHARED_API String System::Globalization::StringInfo::SubstringByTextElements ( int  starting_text_element,
int  length_in_text_elements 
) const

Gets substring of text elements from the specified text element through the specified number of text elements.

Parameters
starting_text_elementIndex of a text element.
length_in_text_elementsNumber of text elements.
Returns
Substring of text elements.