PostSharp6.2/API Reference/Post­Sharp.​Patterns.​Diagnostics.​Backends.​Console Namespace/Console­Logging­Backend­Options Class

ConsoleLoggingBackendOptions Class

Options the for ConsoleLoggingBackend class.
Inheritance Hierarchy
System.Object
  PostSharp.Patterns.Diagnostics.LoggingBackendOptions
    PostSharp.Patterns.Diagnostics.Backends.TextLoggingBackendOptions
      PostSharp.Patterns.Diagnostics.Backends.Console.ConsoleLoggingBackendOptions

Namespace:  PostSharp.Patterns.Diagnostics.Backends.Console
Assembly:  PostSharp.Patterns.Diagnostics (in PostSharp.Patterns.Diagnostics.dll) Version: 6.2.13.0 (6.2.13.0)
Syntax
C#
public class ConsoleLoggingBackendOptions : TextLoggingBackendOptions

The ConsoleLoggingBackendOptions type exposes the following members.

Constructors
  NameDescription
Public methodConsoleLoggingBackendOptions
Initializes a new ConsoleLoggingBackendOptions.
Properties
  NameDescription
Public propertyActionMaxLength
Max length of a log record. The default value is 2048.
(Inherited from TextLoggingBackendOptions.)
Public propertyAppendTrailingPeriod
Determines whether log messages should be ended with a trailing period. The default value is true because we really like trailing periods at PostSharp, but other opinions are valid.
(Inherited from TextLoggingBackendOptions.)
Public propertyContextIdGenerationStrategy
Determines how the Id property is generated.
(Inherited from LoggingBackendOptions.)
Public propertyContextMaxLength
Max length of the Description property.
(Inherited from LoggingBackendOptions.)
Public propertyDelimiter
String used to separate different parts of the logging record. The default value is a pipe surrounded by spaces ( | ).
(Inherited from TextLoggingBackendOptions.)
Public propertyExceptionFormatter
The Formatter<T> used to format the Exception in which a method or custom activity results. This is different than the formatter used to format parameter or property values of Exception type. The default implementation prints the full type name of the Exception.
(Inherited from TextLoggingBackendOptions.)
Public propertyIncludeActivityExecutionTime
Determines whether the execution time should be measured for custom activities. The default value is false. This property does not affect the measurement of execution time of methods, which is only influenced by the IncludeExecutionTime property of the build-time logging profile.
(Inherited from LoggingBackendOptions.)
Public propertyIncludeExceptionDetails
Determines whether exception details (basically Exception.ToString) should be appended to the log. The default value is false.
(Inherited from TextLoggingBackendOptions.)
Public propertyIncludeLevel
Determines whether the LogLevel should be written to the console. The default value is true.
Public propertyIncludeManualLoggingSourceLineInfo
Determines whether source line information should be included in the log output for manual logging (written using LogSource).
(Inherited from LoggingBackendOptions.)
Public propertyIncludeNamespace
Determines whether the full namespace of types should be included in the log. The default value is false.
(Inherited from TextLoggingBackendOptions.)
Public propertyIncludeRole
Determines whether the role should be written to the console. The default value is true.
Public propertyIncludeTimestamp
Determines whether the current date and time should be written to the console. The default value is false.
Public propertyIncludeType
Determines whether the name of the type of the logged method should be included in the log. The default value is true.
(Inherited from TextLoggingBackendOptions.)
Public propertyIndentSpaces
Number of spaces for each indentation level. The default value is 2.
(Inherited from TextLoggingBackendOptions.)
Public propertyIsIncludeManualLoggingSourceLineInfoSpecified
Determines whether the IncludeManualLoggingSourceLineInfo has been set.
(Inherited from LoggingBackendOptions.)
Public propertyLogLevelIgnoredForSystemRecords
Determines whether the Level property is ignored by the current back-end for auto-generated (i.e. non-manual) logging records. Some back-ends may not support overriding the level of records.
(Inherited from LoggingBackendOptions.)
Public propertyPreferSystemColors
When true, the console logger will not attempt to use VT ANSI codes to format the output.
Public propertyRoleWidth
Minimal width of the role column. The default value is 6.
Public propertyRootSyntheticId
Gets or sets the root of the SyntheticId property. The default is a hex-formatted random 64-bit value.
(Inherited from LoggingBackendOptions.)
Public propertyShouldLogExceptionPredicate
Gets or sets a predicate that determines whether an exception should be logged. This predicate is evaluated only when the method entry is not logged. When the method entry is logged, exceptions are always logged.
(Inherited from TextLoggingBackendOptions.)
Public propertySyntheticIdFormatter
Determines how the SyntheticId property is generated. The default value is an instance of the DefaultSyntheticIdFormatter class.
(Inherited from LoggingBackendOptions.)
Public propertySyntheticIdMaxLength
Gets or sets the maximal length of the SyntheticId property.
(Inherited from LoggingBackendOptions.)
Public propertyTheme
Gets the color theme. A set of ready-made themes are exposed on the ConsoleThemes class.
Public propertyTimestampFormat
Gets or sets the formatting string used to render a value of the DateTimeOffset type when the IncludeTimestamp property is set to true. The default value is null.
See Also