Represents the interface for formatting log entry messsages. More...

Inherits Aspose::Email::Tools::Logging::IFormatter.

Inherited by Aspose::Email::Tools::Logging::DebugFormatter, Aspose::Email::Tools::Logging::SimpleFormatter, and Aspose::Email::Tools::Logging::StandardFormatter.

Public Member Functions
System::String	get_Header () override
	Gets the header. More...

virtual void	set_Header (System::String value)
	Sets the header. More...

System::String	get_Footer () override
	Gets the footer. More...

virtual void	set_Footer (System::String value)
	Sets the footer. More...

System::String	get_LogHeader () override
	Gets the log header More...

virtual void	set_LogHeader (System::String value)
	Sets the log header More...

System::String	Format (System::SharedPtr< LogEntry > entry) override
	Formats a log entry and return a string to be outputted. More...

System::String	Format (System::DateTime datatime) override
	Formats a datetime and return a string to be outputted. More...

Static Public Member Functions
static System::SharedPtr< IFormatter >	get_DefaultFormatter ()
	Gets default formatter More...

static void	set_DefaultFormatter (System::SharedPtr< IFormatter > value)
	Sets default formatter More...

static System::ArrayPtr< System::String >	get_MonthNames ()
	The full names of all 12 months More...

static System::ArrayPtr< System::String >	get_MonthShortNames ()
	The short names of all 12 months More...

static System::ArrayPtr< System::String >	get_WeekdayNames ()
	The full names of all weekdays More...

static System::ArrayPtr< System::String >	get_WeekdayShortNames ()
	The short names of all weekdays More...

static System::ArrayPtr< System::String >	get_DateStrings ()

static System::ArrayPtr< System::String >	get_MillisecondStrings ()

static System::ArrayPtr< System::String >	get_YearStrings ()

Static Public Attributes
static const System::String	PasswordView

static const char16_t	COLON_CHAR = u':'

static const char16_t	HYPHEN_CHAR = u'-'

static const char16_t	PERIOD_CHAR = u'.'

static const char16_t	SPACE_CHAR = u' '

static System::String	NEW_LINE

static System::String	ISO_8601_TIME_ZONE
	The ISO 8601 standard time zone specification, showing hours offset from GMT (ex.: "-04:00") The value returned is correct for the local environment for all dates not in daylight savings time More...

static System::String	ISO_8601_DAYLIGHT_SAVINGS_TIME_ZONE
	The ISO 8601 standard time zone specification, showing hours offset from GMT (ex.: "-04:00"). The value returned is correct for the local environment for all dates in daylight savings time More...

Protected Member Functions
	Formatter ()
	Creates an instance of Formatter. More...

	Formatter (System::SharedPtr< System::Text::StringBuilder > logHeaderText)
	Initializes a new instance of the Formatter class. More...

	Formatter (System::String logHeaderText)
	Initializes a new instance of the Formatter class. More...

Friends
class	ProtocolFormatter

class	SimpleFormatter

class	StandardFormatter

Detailed Description

Represents the interface for formatting log entry messsages.

Constructor & Destructor Documentation

◆ Formatter() [1/3]

Aspose::Email::Tools::Logging::Formatter::Formatter ( )

protected

Creates an instance of Formatter.

◆ Formatter() [2/3]

Aspose::Email::Tools::Logging::Formatter::Formatter ( System::SharedPtr< System::Text::StringBuilder > logHeaderText )

protected

Initializes a new instance of the Formatter class.

Parameters

logHeaderText The log header text.

◆ Formatter() [3/3]

Aspose::Email::Tools::Logging::Formatter::Formatter ( System::String logHeaderText )

protected

Initializes a new instance of the Formatter class.

Parameters

logHeaderText The log header text.

Member Function Documentation

◆ Format() [1/2]

System::String Aspose::Email::Tools::Logging::Formatter::Format ( System::DateTime datatime )

overridevirtual

Formats a datetime and return a string to be outputted.

Parameters

datatime The datetime value for formatting to string

Implements Aspose::Email::Tools::Logging::IFormatter.

Reimplemented in Aspose::Email::Tools::Logging::SimpleFormatter.

◆ Format() [2/2]

System::String Aspose::Email::Tools::Logging::Formatter::Format ( System::SharedPtr< LogEntry > entry )

overridevirtual

Formats a log entry and return a string to be outputted.

Parameters

entry Log entry to format.

Returns: String representing the log entry.

Implements Aspose::Email::Tools::Logging::IFormatter.

Reimplemented in Aspose::Email::Tools::Logging::StandardFormatter, and Aspose::Email::Tools::Logging::SimpleFormatter.

◆ get_DateStrings()

static System::ArrayPtr<System::String> Aspose::Email::Tools::Logging::Formatter::get_DateStrings ( )

static

◆ get_DefaultFormatter()

static System::SharedPtr<IFormatter> Aspose::Email::Tools::Logging::Formatter::get_DefaultFormatter ( )

static

Gets default formatter

◆ get_Footer()

System::String Aspose::Email::Tools::Logging::Formatter::get_Footer ( )

overridevirtual

Gets the footer.

Implements Aspose::Email::Tools::Logging::IFormatter.

Reimplemented in Aspose::Email::Tools::Logging::StandardFormatter.

◆ get_Header()

System::String Aspose::Email::Tools::Logging::Formatter::get_Header ( )

overridevirtual

Gets the header.

Implements Aspose::Email::Tools::Logging::IFormatter.

Reimplemented in Aspose::Email::Tools::Logging::StandardFormatter.

◆ get_LogHeader()

System::String Aspose::Email::Tools::Logging::Formatter::get_LogHeader ( )

overridevirtual

Gets the log header

Implements Aspose::Email::Tools::Logging::IFormatter.

◆ get_MillisecondStrings()

static System::ArrayPtr<System::String> Aspose::Email::Tools::Logging::Formatter::get_MillisecondStrings ( )

static

◆ get_MonthNames()

static System::ArrayPtr<System::String> Aspose::Email::Tools::Logging::Formatter::get_MonthNames ( )

static

The full names of all 12 months

◆ get_MonthShortNames()

static System::ArrayPtr<System::String> Aspose::Email::Tools::Logging::Formatter::get_MonthShortNames ( )

static

The short names of all 12 months

◆ get_WeekdayNames()

static System::ArrayPtr<System::String> Aspose::Email::Tools::Logging::Formatter::get_WeekdayNames ( )

static

The full names of all weekdays

◆ get_WeekdayShortNames()

static System::ArrayPtr<System::String> Aspose::Email::Tools::Logging::Formatter::get_WeekdayShortNames ( )

static

The short names of all weekdays

◆ get_YearStrings()

static System::ArrayPtr<System::String> Aspose::Email::Tools::Logging::Formatter::get_YearStrings ( )

static

◆ set_DefaultFormatter()

static void Aspose::Email::Tools::Logging::Formatter::set_DefaultFormatter ( System::SharedPtr< IFormatter > value )

static

Sets default formatter

◆ set_Footer()

virtual void Aspose::Email::Tools::Logging::Formatter::set_Footer ( System::String value )

virtual

Sets the footer.

◆ set_Header()

virtual void Aspose::Email::Tools::Logging::Formatter::set_Header ( System::String value )

virtual

Sets the header.

◆ set_LogHeader()

virtual void Aspose::Email::Tools::Logging::Formatter::set_LogHeader ( System::String value )

virtual

Sets the log header

Friends And Related Function Documentation

◆ ProtocolFormatter

friend class ProtocolFormatter

friend

◆ SimpleFormatter

friend class SimpleFormatter

friend

◆ StandardFormatter

friend class StandardFormatter

friend

Member Data Documentation

◆ COLON_CHAR

const char16_t Aspose::Email::Tools::Logging::Formatter::COLON_CHAR = u':'

static

◆ HYPHEN_CHAR

const char16_t Aspose::Email::Tools::Logging::Formatter::HYPHEN_CHAR = u'-'

static

◆ ISO_8601_DAYLIGHT_SAVINGS_TIME_ZONE

System::String Aspose::Email::Tools::Logging::Formatter::ISO_8601_DAYLIGHT_SAVINGS_TIME_ZONE

static

The ISO 8601 standard time zone specification, showing hours offset from GMT (ex.: "-04:00"). The value returned is correct for the local environment for all dates in daylight savings time

◆ ISO_8601_TIME_ZONE

System::String Aspose::Email::Tools::Logging::Formatter::ISO_8601_TIME_ZONE

static

The ISO 8601 standard time zone specification, showing hours offset from GMT (ex.: "-04:00") The value returned is correct for the local environment for all dates not in daylight savings time

◆ NEW_LINE

System::String Aspose::Email::Tools::Logging::Formatter::NEW_LINE

static

◆ PasswordView

const System::String Aspose::Email::Tools::Logging::Formatter::PasswordView

static

◆ PERIOD_CHAR

const char16_t Aspose::Email::Tools::Logging::Formatter::PERIOD_CHAR = u'.'

static

◆ SPACE_CHAR

const char16_t Aspose::Email::Tools::Logging::Formatter::SPACE_CHAR = u' '

static

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Formatter() [1/3]

◆ Formatter() [2/3]

◆ Formatter() [3/3]

Member Function Documentation

◆ Format() [1/2]

◆ Format() [2/2]

◆ get_DateStrings()

◆ get_DefaultFormatter()

◆ get_Footer()

◆ get_Header()

◆ get_LogHeader()

◆ get_MillisecondStrings()

◆ get_MonthNames()

◆ get_MonthShortNames()

◆ get_WeekdayNames()

◆ get_WeekdayShortNames()

◆ get_YearStrings()

◆ set_DefaultFormatter()

◆ set_Footer()

◆ set_Header()

◆ set_LogHeader()

Friends And Related Function Documentation

◆ ProtocolFormatter

◆ SimpleFormatter

◆ StandardFormatter

Member Data Documentation

◆ COLON_CHAR

◆ HYPHEN_CHAR

◆ ISO_8601_DAYLIGHT_SAVINGS_TIME_ZONE

◆ ISO_8601_TIME_ZONE

◆ NEW_LINE

◆ PasswordView

◆ PERIOD_CHAR

◆ SPACE_CHAR