Struct LoggingPropertyOptions

Specifies the behavior of logging properties (exposed by LogEventData), such as IsRendered, IsInherited or IsBaggage.

public readonly struct LoggingPropertyOptions

Name	Description
LoggingPropertyOptions(bool, bool, bool, bool, IFormatter?)	Initializes a new instance of the LoggingPropertyOptions struct. Initializes a new LoggingPropertyOptions.

Name	Description
Formatter	Gets the formatter to be used to render the property value.
IsBaggage	Gets a value indicating whether the property is cross-process. The default value is `false`. When this property is set to `true`, IsInherited is automatically set to `true`.
IsIgnored	Gets a value indicating whether this property must be ignored by the VisitProperties<TVisitorState>(object?, ILoggingPropertyVisitor<TVisitorState>, ref TVisitorState, in LoggingPropertyVisitorOptions) method. This value is typically only returned by GetPropertyOptions(string) to say that a property of the raw CLR object must not be exposed as a logging property.
IsInherited	Gets a value indicating whether the property is inherited from the parent activity to children activities and messages. The default value is `true`. When this property is set to `false`, IsBaggage is automatically set to `false`.
IsRendered	Gets a value indicating whether the property will be included in the log message. The default value is `false`, then the property is only available as an additional property, if this is supported by the backend.

Name	Description
WithFormatter(IFormatter)	Returns a copy of the current LoggingPropertyOptions but with a different value of the Formatter property.
WithIsBaggage(bool)	Returns a copy of the current LoggingPropertyOptions but with a different value of the IsBaggage property.
WithIsIgnored(bool)	Returns a copy of the current LoggingPropertyOptions but with a different value of the IsIgnored property.
WithIsInherited(bool)	Returns a copy of the current LoggingPropertyOptions but with a different value of the IsInherited property.
WithIsRendered(bool)	Returns a copy of the current LoggingPropertyOptions but with a different value of the IsRendered property.