Asposecpplib
System::IO::StringWriter Class Reference

Implements a TextWriter that writes information to a string. 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::IO::TextWriter.

Public Member Functions

 StringWriter (System::SharedPtr< Text::StringBuilder > sb, IFormatProviderPtr formatProvider)
 Constructs a new instance of StringWriter using the specified StringBuilder and IFormatProvider. More...
 
 StringWriter (System::SharedPtr< Text::StringBuilder > sb)
 Constructs a new instance of StringWriter using the specified StringBuilder and IFormatProvider from the current culture. More...
 
 StringWriter (IFormatProviderPtr formatProvider)
 Constructs a new instance of StringWriter using the specified IFormatProvider. More...
 
 StringWriter ()
 Constructs a new instance of StringWriter using IFormatProvider from the current culture. More...
 
virtual SharedPtr< Text::Encodingget_Encoding () override
 Returns the currently used encoding. More...
 
virtual SharedPtr< Text::StringBuilderGetStringBuilder ()
 Returns the currently used StringBuilder. More...
 
virtual void Write (char_t value) override
 Writes the specified character to the stream. More...
 
virtual void Write (ArrayPtr< char_t > buffer, int index, int count) override
 Writes the specified subrange of characters from the specified character array to the stream. More...
 
virtual void Write (const String &value) override
 Writes the specified string to the stream. More...
 
virtual String ToString () ASPOSE_CONST override
 Returns the underlying string. More...
 
- Public Member Functions inherited from System::IO::TextWriter
virtual ASPOSECPP_SHARED_API const SharedPtr< IFormatProviderget_FormatProvider () const
 Returns the currently used IFormatProvider object. More...
 
virtual ASPOSECPP_SHARED_API const System::String get_NewLine () const
 Returns a line terminator string. More...
 
virtual ASPOSECPP_SHARED_API void set_NewLine (const System::String &value)
 Sets a line terminator string. More...
 
virtual ~TextWriter ()
 Destructor. More...
 
ASPOSECPP_SHARED_API String get_NewLine ()
 Returns a line terminator string. More...
 
ASPOSECPP_SHARED_API IFormatProviderPtr get_FormatProvider ()
 Returns the currently used IFormatProvider object. More...
 
virtual void Dispose () override
 Releases all resources used by the current object and closes the undelying stream. More...
 
virtual void Close ()
 Closes the stream and releases aquired resources. More...
 
virtual void Flush ()
 Flushes the content of the buffer to the underlying stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (SharedPtr< Object > value)
 Writes the string representation of the specified object to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (bool value)
 Writes the string representation of the specified boolean value to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (Decimal value)
 Writes the string representation of the specified Decimal object to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (double value)
 Writes the string representation of the specified double-precision floating point value to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (int value)
 Writes the string representation of the specified 32-bit integer value to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (int64_t value)
 Writes the string representation of the specified 64-bit integer value to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (float value)
 Writes the string representation of the specified single-precision floating point value to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (uint32_t value)
 Writes the string representation of the specified unsigned 32-bit integer value to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (uint64_t value)
 Writes the string representation of the specified unsigned 64-bit integer value to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (SharedPtr< Array< char_t >> buffer)
 Writes all characetrs from the specified array to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (SharedPtr< Array< char_t >> buffer, int index, int count)
 Writes the specified subrange of UTF-16 characters from the specified character array to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine ()
 Writes line terminator characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (SharedPtr< Object > value)
 Writes the string representation of the specified object followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (bool value)
 Writes the string representation of the specified boolean value followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (char_t value)
 Writes the specified character followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (Decimal value)
 Writes the string representation of the specified Decimal object followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (double value)
 Writes the string representation of the specified double-precision floating point value followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (int value)
 Writes the string representation of the specified 32-bit integer value followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (int64_t value)
 Writes the string representation of the specified 64-bit integer value followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (float value)
 Writes the string representation of the specified single-precision floating point value followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (const String &value)
 Writes the specified string followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (uint32_t value)
 Writes the string representation of the specified unsigned 32-bit integer value followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (uint64_t value)
 Writes the string representation of the specified unsigned 64-bit integer value followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (SharedPtr< Array< char_t >> buffer)
 Writes all characetrs from the specified array followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (SharedPtr< Array< char_t >> buffer, int index, int count)
 Writes the specified subrange of UTF-16 characters from the specified character array followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (const char_t *value)
 Writes the specified c-string to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (const char_t *value)
 Writes the specified c-string followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (const TypeInfo &value)
 Writes the string representation of the specified TypeInfo object to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (const TypeInfo &value)
 Writes the string representation of the specified TypeInfo object followed by the line-terminating characters to the stream. More...
 
template<class... TArgs>
void Write (const String &format, const TArgs &... args)
 Writes the specified values formatted according to the specified format to the stream. More...
 
template<class... TArgs>
void WriteLine (const String &format, const TArgs &... args)
 Writes the specified values formatted according to the specified format followed by the line-terminating characetrs to the stream. 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 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...
 

Additional Inherited Members

- Public Types inherited from System::IO::TextWriter
typedef System::SharedPtr< TextWriterPtr
 An alias for a shared pointer to this class. More...
 
- 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...
 
- 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...
 

Detailed Description

Implements a TextWriter that writes information to a string. 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

◆ StringWriter() [1/4]

System::IO::StringWriter::StringWriter ( System::SharedPtr< Text::StringBuilder sb,
IFormatProviderPtr  formatProvider 
)
inline

Constructs a new instance of StringWriter using the specified StringBuilder and IFormatProvider.

Parameters
sbThe StringBuilder object to be used by the StringWriter being constructed
formatProviderAn IFormatProvider object to be used by the object being constructed

◆ StringWriter() [2/4]

System::IO::StringWriter::StringWriter ( System::SharedPtr< Text::StringBuilder sb)
inline

Constructs a new instance of StringWriter using the specified StringBuilder and IFormatProvider from the current culture.

Parameters
sbThe StringBuilder object to be used by the StringWriter being constructed

◆ StringWriter() [3/4]

System::IO::StringWriter::StringWriter ( IFormatProviderPtr  formatProvider)
inline

Constructs a new instance of StringWriter using the specified IFormatProvider.

Parameters
formatProviderAn IFormatProvider object to be used by the object being constructed

◆ StringWriter() [4/4]

System::IO::StringWriter::StringWriter ( )
inline

Constructs a new instance of StringWriter using IFormatProvider from the current culture.

Member Function Documentation

◆ get_Encoding()

virtual SharedPtr<Text::Encoding> System::IO::StringWriter::get_Encoding ( )
inlineoverridevirtual

Returns the currently used encoding.

Implements System::IO::TextWriter.

◆ GetStringBuilder()

virtual SharedPtr<Text::StringBuilder> System::IO::StringWriter::GetStringBuilder ( )
inlinevirtual

Returns the currently used StringBuilder.

◆ ToString()

virtual String System::IO::StringWriter::ToString ( )
inlineoverridevirtual

Returns the underlying string.

Reimplemented from System::Object.

◆ Write() [1/3]

virtual void System::IO::StringWriter::Write ( char_t  value)
inlineoverridevirtual

Writes the specified character to the stream.

Parameters
valueThe value to write

Reimplemented from System::IO::TextWriter.

◆ Write() [2/3]

virtual void System::IO::StringWriter::Write ( ArrayPtr< char_t >  buffer,
int  index,
int  count 
)
inlineoverridevirtual

Writes the specified subrange of characters from the specified character array to the stream.

Parameters
bufferThe array containing the characters to write
indexA 0-based index of the elemnet in buffer at which the subrange to write begins
countThe number of characters in the subrange to write

◆ Write() [3/3]

virtual void System::IO::StringWriter::Write ( const String value)
inlineoverridevirtual

Writes the specified string to the stream.

Parameters
valueThe string to write

Reimplemented from System::IO::TextWriter.