Inherits System::IDisposable.

Inherited by System::ConsoleOutput, System::IO::StreamWriter, and System::IO::StringWriter.

Public Types

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

Public Member Functions

virtual SharedPtr< System::Text::Encodingget_Encoding ()=0
 Returns the currently used encoding. More...
 
virtual const SharedPtr< IFormatProviderget_FormatProvider () const
 Returns the currently used IFormatProvider object. More...
 
virtual const System::String get_NewLine () const
 Returns a line terminator string. More...
 
virtual void set_NewLine (const System::String &value)
 
virtual ~TextWriter ()
 Destructor. More...
 
String get_NewLine ()
 Returns a line terminator string. More...
 
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 void Write (SharedPtr< Object > value)
 
virtual void Write (bool value)
 
virtual void Write (char_t value)
 
virtual void Write (Decimal value)
 
virtual void Write (double value)
 
virtual void Write (int value)
 
virtual void Write (int64_t value)
 
virtual void Write (float value)
 
virtual void Write (const String &value)
 
virtual void Write (uint32_t value)
 
virtual void Write (uint64_t value)
 
virtual void Write (SharedPtr< Array< char_t >> buffer)
 
virtual void Write (SharedPtr< Array< char_t >> buffer, int index, int count)
 
virtual void WriteLine ()
 Writes line terminator characters to the stream. More...
 
virtual void WriteLine (SharedPtr< Object > value)
 
virtual void WriteLine (bool value)
 
virtual void WriteLine (char_t value)
 
virtual void WriteLine (Decimal value)
 
virtual void WriteLine (double value)
 
virtual void WriteLine (int value)
 
virtual void WriteLine (int64_t value)
 
virtual void WriteLine (float value)
 
virtual void WriteLine (const String &value)
 
virtual void WriteLine (uint32_t value)
 
virtual void WriteLine (uint64_t value)
 
virtual void WriteLine (SharedPtr< Array< char_t >> buffer)
 
virtual void WriteLine (SharedPtr< Array< char_t >> buffer, int index, int count)
 
virtual void Write (const char_t *value)
 
virtual void WriteLine (const char_t *value)
 
virtual void Write (const TypeInfo &value)
 
virtual void WriteLine (const TypeInfo &value)
 
template<class... TArgs>
void Write (const String &format, const TArgs &... args)
 
template<class... TArgs>
void WriteLine (const String &format, const TArgs &... args)
 
- 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...
 
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...
 
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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_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 TypeInfoGetType () 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 (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)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Protected Member Functions

virtual void Dispose (bool disposing)
 
 TextWriter ()
 
 TextWriter (IFormatProviderPtr formatProvider)
 

Protected Attributes

ArrayPtr< char_t > CoreNewLine
 The line terminator string. More...
 
IFormatProviderPtr internalFormatProvider
 IFormatProvider used by the current object. More...
 

Additional Inherited Members

- 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

A base class for classes that represent writers that writes sequences of characters to different destinations. 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.

Member Typedef Documentation

◆ Ptr

An alias for a shared pointer to this class.

Constructor & Destructor Documentation

◆ ~TextWriter()

virtual System::IO::TextWriter::~TextWriter ( )
inlinevirtual

Destructor.

◆ TextWriter() [1/2]

System::IO::TextWriter::TextWriter ( )
protected

Constructs a new intstance of TextWriter class that uses IFormatProvider object from the invariant culture.

◆ TextWriter() [2/2]

System::IO::TextWriter::TextWriter ( IFormatProviderPtr  formatProvider)
protected

Constructs a new intstance of TextWriter class that uses the specified IFormatProvider object.

Parameters
formatProviderThe format provider object to use

Member Function Documentation

◆ Close()

virtual void System::IO::TextWriter::Close ( )
inlinevirtual

Closes the stream and releases aquired resources.

Reimplemented in System::IO::StreamWriter.

◆ Dispose() [1/2]

virtual void System::IO::TextWriter::Dispose ( )
inlineoverridevirtual

Releases all resources used by the current object and closes the undelying stream.

Reimplemented from System::IDisposable.

◆ Dispose() [2/2]

virtual void System::IO::TextWriter::Dispose ( bool  disposing)
protectedvirtual

Releases all resources used by the current object and closes the undelying stream.

Parameters
disposingSpecifies whether the undelying stream should be closed.

Reimplemented in System::IO::StreamWriter.

◆ Flush()

virtual void System::IO::TextWriter::Flush ( )
inlinevirtual

Flushes the content of the buffer to the underlying stream.

Reimplemented in System::IO::StreamWriter.

◆ get_Encoding()

virtual SharedPtr<System::Text::Encoding> System::IO::TextWriter::get_Encoding ( )
pure virtual

Returns the currently used encoding.

Implemented in System::ConsoleOutput, System::IO::StreamWriter, and System::IO::StringWriter.

◆ get_FormatProvider() [1/2]

virtual const SharedPtr<IFormatProvider> System::IO::TextWriter::get_FormatProvider ( ) const
virtual

Returns the currently used IFormatProvider object.

◆ get_FormatProvider() [2/2]

IFormatProviderPtr System::IO::TextWriter::get_FormatProvider ( )

Returns the currently used IFormatProvider object.

◆ get_NewLine() [1/2]

virtual const System::String System::IO::TextWriter::get_NewLine ( ) const
virtual

Returns a line terminator string.

◆ get_NewLine() [2/2]

String System::IO::TextWriter::get_NewLine ( )

Returns a line terminator string.

◆ set_NewLine()

virtual void System::IO::TextWriter::set_NewLine ( const System::String value)
virtual

Sets a line terminator string.

Parameters
valueA value to set

◆ Write() [1/16]

virtual void System::IO::TextWriter::Write ( SharedPtr< Object value)
virtual

Writes the string representation of the specified object to the stream.

Parameters
valueThe object to write

Reimplemented in System::ConsoleOutput.

◆ Write() [2/16]

virtual void System::IO::TextWriter::Write ( bool  value)
virtual

Writes the string representation of the specified boolean value to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput.

◆ Write() [3/16]

virtual void System::IO::TextWriter::Write ( char_t  value)
virtual

Writes the specified character to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput, System::IO::StreamWriter, and System::IO::StringWriter.

◆ Write() [4/16]

virtual void System::IO::TextWriter::Write ( Decimal  value)
virtual

Writes the string representation of the specified Decimal object to the stream.

Parameters
valueThe object to write

Reimplemented in System::ConsoleOutput.

◆ Write() [5/16]

virtual void System::IO::TextWriter::Write ( double  value)
virtual

Writes the string representation of the specified double-precision floating point value to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput.

◆ Write() [6/16]

virtual void System::IO::TextWriter::Write ( int  value)
virtual

Writes the string representation of the specified 32-bit integer value to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput.

◆ Write() [7/16]

virtual void System::IO::TextWriter::Write ( int64_t  value)
virtual

Writes the string representation of the specified 64-bit integer value to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput.

◆ Write() [8/16]

virtual void System::IO::TextWriter::Write ( float  value)
virtual

Writes the string representation of the specified single-precision floating point value to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput.

◆ Write() [9/16]

virtual void System::IO::TextWriter::Write ( const String value)
virtual

Writes the specified string to the stream.

Parameters
valueThe string to write

Reimplemented in System::ConsoleOutput, System::IO::StringWriter, and System::IO::StreamWriter.

◆ Write() [10/16]

virtual void System::IO::TextWriter::Write ( uint32_t  value)
virtual

Writes the string representation of the specified unsigned 32-bit integer value to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput.

◆ Write() [11/16]

virtual void System::IO::TextWriter::Write ( uint64_t  value)
virtual

Writes the string representation of the specified unsigned 64-bit integer value to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput.

◆ Write() [12/16]

virtual void System::IO::TextWriter::Write ( SharedPtr< Array< char_t >>  buffer)
virtual

Writes all characetrs from the specified array to the stream.

Parameters
bufferThe array containing the characters to write

Reimplemented in System::ConsoleOutput, and System::IO::StreamWriter.

◆ Write() [13/16]

virtual void System::IO::TextWriter::Write ( SharedPtr< Array< char_t >>  buffer,
int  index,
int  count 
)
virtual

Writes the specified subrange of UTF-16 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; -1 specifies that the subrange ends where buffer array ends

Reimplemented in System::ConsoleOutput, and System::IO::StreamWriter.

◆ Write() [14/16]

virtual void System::IO::TextWriter::Write ( const char_t *  value)
virtual

Writes the specified c-string to the stream.

Parameters
valueThe c-string to write

Reimplemented in System::ConsoleOutput.

◆ Write() [15/16]

virtual void System::IO::TextWriter::Write ( const TypeInfo value)
virtual

Writes the string representation of the specified TypeInfo object to the stream.

Parameters
valueThe object to write

Reimplemented in System::ConsoleOutput.

◆ Write() [16/16]

template<class... TArgs>
void System::IO::TextWriter::Write ( const String format,
const TArgs &...  args 
)
inline

Writes the specified values formatted according to the specified format to the stream.

Parameters
formatThe string format
argsThe values to write
Template Parameters
TArgsThe list of types of values to write

◆ WriteLine() [1/17]

virtual void System::IO::TextWriter::WriteLine ( )
virtual

Writes line terminator characters to the stream.

Reimplemented in System::ConsoleOutput, and System::IO::StreamWriter.

◆ WriteLine() [2/17]

virtual void System::IO::TextWriter::WriteLine ( SharedPtr< Object value)
virtual

Writes the string representation of the specified object followed by the line-terminating characters to the stream.

Parameters
valueThe object to write

Reimplemented in System::ConsoleOutput.

◆ WriteLine() [3/17]

virtual void System::IO::TextWriter::WriteLine ( bool  value)
virtual

Writes the string representation of the specified boolean value followed by the line-terminating characters to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput.

◆ WriteLine() [4/17]

virtual void System::IO::TextWriter::WriteLine ( char_t  value)
virtual

Writes the specified character followed by the line-terminating characters to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput.

◆ WriteLine() [5/17]

virtual void System::IO::TextWriter::WriteLine ( Decimal  value)
virtual

Writes the string representation of the specified Decimal object followed by the line-terminating characters to the stream.

Parameters
valueThe object to write

Reimplemented in System::ConsoleOutput.

◆ WriteLine() [6/17]

virtual void System::IO::TextWriter::WriteLine ( double  value)
virtual

Writes the string representation of the specified double-precision floating point value followed by the line-terminating characters to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput.

◆ WriteLine() [7/17]

virtual void System::IO::TextWriter::WriteLine ( int  value)
virtual

Writes the string representation of the specified 32-bit integer value followed by the line-terminating characters to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput.

◆ WriteLine() [8/17]

virtual void System::IO::TextWriter::WriteLine ( int64_t  value)
virtual

Writes the string representation of the specified 64-bit integer value followed by the line-terminating characters to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput.

◆ WriteLine() [9/17]

virtual void System::IO::TextWriter::WriteLine ( float  value)
virtual

Writes the string representation of the specified single-precision floating point value followed by the line-terminating characters to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput.

◆ WriteLine() [10/17]

virtual void System::IO::TextWriter::WriteLine ( const String value)
virtual

Writes the specified string followed by the line-terminating characters to the stream.

Parameters
valueThe string to write

Reimplemented in System::ConsoleOutput, and System::IO::StreamWriter.

◆ WriteLine() [11/17]

virtual void System::IO::TextWriter::WriteLine ( uint32_t  value)
virtual

Writes the string representation of the specified unsigned 32-bit integer value followed by the line-terminating characters to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput.

◆ WriteLine() [12/17]

virtual void System::IO::TextWriter::WriteLine ( uint64_t  value)
virtual

Writes the string representation of the specified unsigned 64-bit integer value followed by the line-terminating characters to the stream.

Parameters
valueThe value to write

Reimplemented in System::ConsoleOutput.

◆ WriteLine() [13/17]

virtual void System::IO::TextWriter::WriteLine ( SharedPtr< Array< char_t >>  buffer)
virtual

Writes all characetrs from the specified array followed by the line-terminating characters to the stream.

Parameters
bufferThe array containing the characters to write

Reimplemented in System::ConsoleOutput, and System::IO::StreamWriter.

◆ WriteLine() [14/17]

virtual void System::IO::TextWriter::WriteLine ( SharedPtr< Array< char_t >>  buffer,
int  index,
int  count 
)
virtual

Writes the specified subrange of UTF-16 characters from the specified character array followed by the line-terminating characters 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; -1 specifies that the subrange ends where buffer array ends

Reimplemented in System::ConsoleOutput, and System::IO::StreamWriter.

◆ WriteLine() [15/17]

virtual void System::IO::TextWriter::WriteLine ( const char_t *  value)
virtual

Writes the specified c-string followed by the line-terminating characters to the stream.

Parameters
valueThe c-string to write

Reimplemented in System::ConsoleOutput.

◆ WriteLine() [16/17]

virtual void System::IO::TextWriter::WriteLine ( const TypeInfo value)
virtual

Writes the string representation of the specified TypeInfo object followed by the line-terminating characters to the stream.

Parameters
valueThe object to write

Reimplemented in System::ConsoleOutput.

◆ WriteLine() [17/17]

template<class... TArgs>
void System::IO::TextWriter::WriteLine ( const String format,
const TArgs &...  args 
)
inline

Writes the specified values formatted according to the specified format followed by the line-terminating characetrs to the stream.

Parameters
formatThe string format
argsThe values to write
Template Parameters
TArgsThe list of types of values to write

Member Data Documentation

◆ CoreNewLine

ArrayPtr<char_t> System::IO::TextWriter::CoreNewLine
protected

The line terminator string.

◆ internalFormatProvider

IFormatProviderPtr System::IO::TextWriter::internalFormatProvider
protected

IFormatProvider used by the current object.