TextLogRecordBuilder Methods |
The TextLogRecordBuilder type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddHiddenCustomParameter<T> | |
| AppendAsyncInfo |
Appends information about the async method to the current StringBuilder.
|
| AppendClosingParenthesisConditional |
Appends a closing parenthesis to the current StringBuilder if required.
|
| AppendComma |
Appends a command and a space to the current StringBuilder, and resets the required punctuation set by RequireComma() or RequirePunctuation(Char).
|
| AppendCommaConditional |
Appends a comma to the current StringBuilder, unless this method is invoked for the first
time for the current record.
|
| AppendContextDescription() |
Appends the context Description
(or the TypeSource name, if the type of the context is not equal to the source type of the record)
to the current StringBuilder.
|
| AppendContextDescription(LoggingContext) |
Appends the context Description to the current StringBuilder.
|
| AppendDelimiter |
Appends a Delimiter to the current StringBuilder.
|
| AppendDelimiterConditional |
Appends a Delimiter to the current StringBuilder
if the RequireDelimiter() method has been called previously.
|
| AppendEpilogue |
Appends the final part of log message to StringBuilder.
This includes state machine number and execution time where relevant,
but does not include exception details.
|
| AppendExceptionDetails |
Appends exception details to StringBuilder if IncludeExceptionDetails is set.
|
| AppendExecutionTime |
Appends the execution time to the current StringBuilder.
|
| AppendExecutionTimeThreshold |
Appends the execution time threshold to the current StringBuilder.
|
| AppendIndentString |
Appends indentation for the given to StringBuilder.
|
| AppendMemberName |
Appends name of the member for the current record
(including the declaring type name, subject to the IncludeType property) to
the current StringBuilder, as well as an opening parenthesis.
|
| AppendOpeningParenthesis |
Appends an opening parenthesis to the current StringBuilder.
|
| AppendProlog |
Appends the indent string, context description, and the record kind to the current StringBuilder.
|
| AppendRecordKind |
Appends the LogRecordKind of the current record to the current StringBuilder.
|
| AppendSemanticParameter(SemanticParameterKind, String, String, String, Int32) |
Appends a parameter of String type to the current StringBuilder. Back-ends that
support semantic logging may store the parameter value semantically instead of appending it to the StringBuilder.
|
| AppendSemanticParameter(SemanticParameterKind, String, Object, IFormatter, String, Int32) |
Appends a parameter to the current StringBuilder, where the name is given as a String, and uses a specific formatter. Back-ends that
support semantic logging may store the parameter value semantically instead of appending it to the StringBuilder. This method overload is weakly typed.
|
| AppendSemanticParameter<T>(SemanticParameterKind, ArraySegment<Char>, T, IFormatter<T>, String, Int32) |
Appends a parameter to the current StringBuilder, where the name is given as a ArraySegment<T>, and uses a specific formatter. Back-ends that
support semantic logging may store the parameter value semantically instead of appending it to the StringBuilder.
|
| AppendSemanticParameter<T>(SemanticParameterKind, String, T, IFormatter<T>, String, Int32) |
Appends a parameter to the current StringBuilder, where the name is given as a String, and uses a specific formatter. Back-ends that
support semantic logging may store the parameter value semantically instead of appending it to the StringBuilder. This method overload is strongly typed.
|
| AppendSourceLineInfo |
Appends source (file, line) information to the current StringBuilder.
|
| AppendSpaces |
Appends a given number of spaces to the current StringBuilder.
|
| AppendSpecialChar |
Appends a special Char (which may require escaping with specific back-ends) to the current StringBuilder.
|
| AppendTrailingPeriod |
Appends a trailing period (.) to the current StringBuilder, respecting the AppendTrailingPeriod property.
|
| AppendTypeName |
Appends the name of the TypeSource to the current StringBuilder.
|
 | BeginCustomRecord |
Initializes the current LogRecordBuilder to emit a custom record.
(Overrides LogRecordBuilder.BeginCustomRecord(LoggingContext, CustomLogRecordInfo).) |
| BeginRecord |
Initializes the current LogRecordBuilder to emit a standard (i.e. non-custom) record for
a given context and method.
(Overrides LogRecordBuilder.BeginRecord(LoggingContext, LogRecordInfo, LogMemberInfo).) |
| BeginWriteItem | (Overrides LogRecordBuilder.BeginWriteItem(CustomLogRecordItem, CustomLogRecordTextOptions).) |
| Complete |
Emits the record and resets the current LogRecordBuilder.
This method invoked after all SetThis<T>(T), SetParameter<T>(Int32, String, ParameterKind, String, T) and
similar methods have been called.
(Inherited from LogRecordBuilder.) |
| Dispose |
Finishes the logging of the current record. Calling this method does not actually make
the current LogRecordBuilder unusable, but it makes it usable for a
next record in the same thread.
(Overrides LogRecordBuilder.Dispose().) |
| EmitRecord() |
Emits the record. Invoked by the Complete() method.
(Overrides LogRecordBuilder.EmitRecord().) |
| EmitRecord(Boolean) |
Emits the record and specifies whether exception details should be appended to the text.
|
| EndContextDescription |
Ends building the context Description and starts building the action text.
|
| EndContextDescriptionConditional |
Switches between building the context Description and the action text.
If the EndContextDescriptionConditional() method has been previously invoked, subsequent calls
are ignored.
|
| EndWriteItem |
Ends building a specified item.
(Overrides LogRecordBuilder.EndWriteItem(CustomLogRecordItem).) |
| ForEachProperty(LoggingPropertyVisitor<Object>) |
Invokes a delegate for each property defined in the current log record.
(Inherited from LogRecordBuilder.) |
| ForEachProperty<T>(LoggingPropertyVisitor<T>, T) |
Invokes a delegate for each property defined in the current log record.
(Inherited from LogRecordBuilder.) |
| GetContextDescription | Obsolete.
Gets the context Description
or the TypeSource name, if the type of the context is not equal to the source type of the record.
|
| GetContextDescriptionUnsafe | Obsolete.
Gets an UnsafeString representing the context Description
or the TypeSource name, if the type of the context is not equal to the source type of the record.
|
| GetContextForDescription | Obsolete.
Gets the LoggingContext that should be used when getting or appending the Description.
|
| GetSourceName |
Gets the name of the TypeSource for the current record, respecting the IncludeNamespace property.
|
| HasRecordKindName |
Determines whether the AppendRecordKind() will append anything for the current record.
|
| MustBuildContextDescription |
Determines whether the current Description should be appended
to the current StringBuilder.
|
| RequireComma |
Requires the next call to AppendCommaConditional() to append a comma even.
|
| RequireDelimiter |
Causes the next call to the AppendDelimiterConditional() to append a
Delimiter to the current StringBuilder.
|
| RequirePunctuation |
Requires the next call to AppendCommaConditional() to append a specific punctuation character.
|
| Reset |
Resets all fields and properties of the current LogRecordBuilder to their initial value. Invoked by the
Complete() method.
(Overrides LogRecordBuilder.Reset().) |
| SetException |
Sets the exception for the method or activity.
(Overrides LogRecordBuilder.SetException(Exception).) |
| SetExecutionTime |
Sets the method or activity execution time.
(Overrides LogRecordBuilder.SetExecutionTime(Double, Boolean).) |
| SetMethodGenericParameter<T> |
Not implemented.
(Inherited from LogRecordBuilder.) |
| SetParameter<T>(Int32, String, ParameterKind, String, T) |
Sets the value of a given parameter and uses the default formatter.
(Inherited from LogRecordBuilder.) |
| SetParameter<T>(Int32, String, ParameterKind, String, T, IFormatter<T>) |
Sets the value of a given parameter and specifies the Formatter<T>.
(Inherited from LogRecordBuilder.) |
| SetParameter<T>(Int32, String, ParameterKind, String, T, IFormatter<T>) |
Sets the value of a given parameter and specifies the Formatter<T>.
(Overrides LogRecordBuilder.SetParameter<T>(Int32, String, ParameterKind, String, T, IFormatter<T>).) |
| SetReturnValue<T>(Int32, String, String, T) |
Sets a given return value (there can be several return values in C# 7.0) and uses the default formatter.
(Inherited from LogRecordBuilder.) |
| SetReturnValue<T>(Int32, String, String, T, IFormatter<T>) |
Sets a given return value (there can be several return values in C# 7.0) and uses a given formatter.
(Inherited from LogRecordBuilder.) |
| SetReturnValue<T>(Int32, String, String, T, IFormatter<T>) |
Sets a given return value (there can be several return values in C# 7.0) and uses a given formatter.
(Overrides LogRecordBuilder.SetReturnValue<T>(Int32, String, String, T, IFormatter<T>).) |
| SetThis<T>(T) |
Sets the this (instance) value and uses the default formatter. This method is only invoked if the IncludeThisValue property is true.
(Inherited from LogRecordBuilder.) |
| SetThis<T>(T, IFormatter<T>) |
Sets the this (instance) value and uses a given formatter.
(Inherited from LogRecordBuilder.) |
| SetThis<T>(T, IFormatter<T>) |
Sets the this (instance) value and uses a given formatter.
(Overrides LogRecordBuilder.SetThis<T>(T, IFormatter<T>).) |
| SetTypeGenericParameter<T> |
Not implemented.
(Inherited from LogRecordBuilder.) |
| ShouldLogExceptionDetails |
Determines whether exception details should be appended to the text of the current StringBuilder.
|
| ToString | Returns a string that represents the current object. (Overrides Object.ToString().) |
| Write |
Writes the final message to the back-end.
|
| WriteCustomParameter<T>(Int32, ArraySegment<Char>, T) |
Writes a custom parameter (passed as an ArraySegment<char>) and uses the default formatter.
(Inherited from LogRecordBuilder.) |
| WriteCustomParameter<T>(Int32, CharSpan, T, CustomLogParameterOptions) |
Writes a custom parameter (passed as an CharSpan) and uses the default formatter.
(Inherited from LogRecordBuilder.) |
| WriteCustomParameter<T>(Int32, ArraySegment<Char>, T, IFormatter<T>) |
Writes a custom parameter (passed as an ArraySegment<char>) and uses a given formatter.
(Inherited from LogRecordBuilder.) |
| WriteCustomParameter<T>(Int32, ArraySegment<Char>, T, IFormatter<T>) |
Writes a custom parameter (passed as an ArraySegment<char>) and uses a given formatter.
(Overrides LogRecordBuilder.WriteCustomParameter<T>(Int32, ArraySegment<Char>, T, IFormatter<T>).) |
| WriteCustomParameter<T>(Int32, CharSpan, T, CustomLogParameterOptions, IFormatter<T>) | (Inherited from LogRecordBuilder.) |
| WriteCustomParameter<T>(Int32, CharSpan, T, CustomLogParameterOptions, IFormatter<T>) | (Overrides LogRecordBuilder.WriteCustomParameter<T>(Int32, CharSpan, T, CustomLogParameterOptions, IFormatter<T>).) |
| WriteCustomString(ArraySegment<Char>) |
Write a custom string passed as an ArraySegment<char>.
(Overrides LogRecordBuilder.WriteCustomString(ArraySegment<Char>).) |
| WriteCustomString(CharSpan) | (Overrides LogRecordBuilder.WriteCustomString(CharSpan).) |
| WriteProperty |
Appends the name and value of a property to the current StringBuilder.
|
See Also