Aspose::Email::Tools::Logging::StandardFormatter Class Reference

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

Inherits Aspose::Email::Tools::Logging::Formatter.

Public Member Functions

System::String get_Header () override
 Gets the log header. More...
 
System::String get_Footer () override
 Gest the footer string. More...
 
 StandardFormatter ()
 Initializes a new instance of the StandardFormatter class. More...
 
 StandardFormatter (System::SharedPtr< System::Text::StringBuilder > headerText)
 Initializes a new instance of the StandardFormatter class. More...
 
 StandardFormatter (System::String headerText)
 Initializes a new instance of the StandardFormatter class. More...
 
System::String Format (System::SharedPtr< LogEntry > entry) override
 Formats a log entry and return a string to be outputted. More...
 
- Public Member Functions inherited from Aspose::Email::Tools::Logging::Formatter
virtual void set_Header (System::String value)
 Sets the header. 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::DateTime datatime) override
 Formats a datetime and return a string to be outputted. More...
 

Protected Member Functions

virtual ~StandardFormatter ()
 
- Protected Member Functions inherited from Aspose::Email::Tools::Logging::Formatter
 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from Aspose::Email::Tools::Logging::Formatter
static System::SharedPtr< IFormatterget_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 inherited from Aspose::Email::Tools::Logging::Formatter
static const System::String PasswordView
 
static const char16_t COLON_CHAR
 
static const char16_t HYPHEN_CHAR
 
static const char16_t PERIOD_CHAR
 
static const char16_t SPACE_CHAR
 
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...
 

Detailed Description

Represents the class for formatting log entry messsages.

Constructor & Destructor Documentation

◆ StandardFormatter() [1/3]

Aspose::Email::Tools::Logging::StandardFormatter::StandardFormatter ( )

Initializes a new instance of the StandardFormatter class.

◆ StandardFormatter() [2/3]

Aspose::Email::Tools::Logging::StandardFormatter::StandardFormatter ( System::SharedPtr< System::Text::StringBuilder >  headerText)

Initializes a new instance of the StandardFormatter class.

Parameters
headerTextThe header text.

◆ StandardFormatter() [3/3]

Aspose::Email::Tools::Logging::StandardFormatter::StandardFormatter ( System::String  headerText)

Initializes a new instance of the StandardFormatter class.

Parameters
headerTextThe header text.

◆ ~StandardFormatter()

virtual Aspose::Email::Tools::Logging::StandardFormatter::~StandardFormatter ( )
protectedvirtual

Member Function Documentation

◆ Format()

System::String Aspose::Email::Tools::Logging::StandardFormatter::Format ( System::SharedPtr< LogEntry entry)
overridevirtual

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

Parameters
entryThe Log entry to format.
Returns
String representing the log entry.

Reimplemented from Aspose::Email::Tools::Logging::Formatter.

◆ get_Footer()

System::String Aspose::Email::Tools::Logging::StandardFormatter::get_Footer ( )
overridevirtual

Gest the footer string.

Reimplemented from Aspose::Email::Tools::Logging::Formatter.

◆ get_Header()

System::String Aspose::Email::Tools::Logging::StandardFormatter::get_Header ( )
overridevirtual

Gets the log header.

Reimplemented from Aspose::Email::Tools::Logging::Formatter.