Open sandboxFocus
  • TOC

Post­Sharp Documentation

Introduction

Deployment and Configuration

Adding Aspects to Code

Logging

Contracts

INotify­Property­Changed

Weak Event

XAML

Parent/Child, Visitor and Disposable

Undo/Redo

Caching

Multithreading

Developing Custom Aspects

Validating Architecture

Testing and Debugging

Miscellaneous

API Reference

Post­Sharp

Post­Sharp.​Aspects

Post­Sharp.​Aspects.​Advices

Post­Sharp.​Aspects.​Configuration

Post­Sharp.​Aspects.​Dependencies

Post­Sharp.​Aspects.​Internals

Post­Sharp.​Aspects.​Serialization

Post­Sharp.​Collections

Post­Sharp.​Constraints

Post­Sharp.​Extensibility

Post­Sharp.​Extensibility.​Build­Time­Logging

Post­Sharp.​Patterns

Post­Sharp.​Patterns.​Caching

Post­Sharp.​Patterns.​Caching.​Backends

Post­Sharp.​Patterns.​Caching.​Backends.​Azure

Post­Sharp.​Patterns.​Caching.​Backends.​Redis

Post­Sharp.​Patterns.​Caching.​Dependencies

Post­Sharp.​Patterns.​Caching.​Formatters

Post­Sharp.​Patterns.​Caching.​Implementation

Post­Sharp.​Patterns.​Caching.​Locking

Post­Sharp.​Patterns.​Caching.​Serializers

Post­Sharp.​Patterns.​Caching.​Value­Adapters

Post­Sharp.​Patterns.​Collections

Post­Sharp.​Patterns.​Collections.​Advices

Post­Sharp.​Patterns.​Contracts

Post­Sharp.​Patterns.​Diagnostics

Post­Sharp.​Patterns.​Diagnostics.​Adapters.​Asp­Net­Core

Post­Sharp.​Patterns.​Diagnostics.​Adapters.​Asp­Net­Framework

Post­Sharp.​Patterns.​Diagnostics.​Adapters.​Diagnostic­Source

Post­Sharp.​Patterns.​Diagnostics.​Adapters.​Http­Client

Post­Sharp.​Patterns.​Diagnostics.​Audit

Post­Sharp.​Patterns.​Diagnostics.​Backends

Post­Sharp.​Patterns.​Diagnostics.​Backends.​Application­Insights

Post­Sharp.​Patterns.​Diagnostics.​Backends.​Audit

Post­Sharp.​Patterns.​Diagnostics.​Backends.​Common­Logging

Post­Sharp.​Patterns.​Diagnostics.​Backends.​Console

Post­Sharp.​Patterns.​Diagnostics.​Backends.​Event­Source

Post­Sharp.​Patterns.​Diagnostics.​Backends.​Log4Net

Post­Sharp.​Patterns.​Diagnostics.​Backends.​Microsoft

Post­Sharp.​Patterns.​Diagnostics.​Backends.​Multiplexer

Post­Sharp.​Patterns.​Diagnostics.​Backends.​NLog

Post­Sharp.​Patterns.​Diagnostics.​Backends.​Null

Post­Sharp.​Patterns.​Diagnostics.​Backends.​Serilog

Post­Sharp.​Patterns.​Diagnostics.​Backends.​Trace

Post­Sharp.​Patterns.​Diagnostics.​Backends.​Trace­Source

Post­Sharp.​Patterns.​Diagnostics.​Contexts

Post­Sharp.​Patterns.​Diagnostics.​Correlation

Post­Sharp.​Patterns.​Diagnostics.​Custom

Post­Sharp.​Patterns.​Diagnostics.​Custom.​Messages

Post­Sharp.​Patterns.​Diagnostics.​Formatters

Post­Sharp.​Patterns.​Diagnostics.​Record­Builders

Post­Sharp.​Patterns.​Diagnostics.​Threading­Instrumentation

Post­Sharp.​Patterns.​Diagnostics.​Transactions

Post­Sharp.​Patterns.​Diagnostics.​Transactions.​Model

Post­Sharp.​Patterns.​Dynamic­Advising

Post­Sharp.​Patterns.​Formatters

Post­Sharp.​Patterns.​Model

Post­Sharp.​Patterns.​Model.​Controls

Post­Sharp.​Patterns.​Model.​Type­Adapters

Post­Sharp.​Patterns.​Recording

Post­Sharp.​Patterns.​Recording.​Operations

Post­Sharp.​Patterns.​Threading

Post­Sharp.​Patterns.​Threading.​Models

Post­Sharp.​Patterns.​Utilities

Post­Sharp.​Patterns.​Xaml

Post­Sharp.​Reflection

Post­Sharp.​Reflection.​Method­Body

Post­Sharp.​Serialization

  • Article

Method AppendSemanticParameter

AppendSemanticParameter(SemanticParameterKind, string, string, string, int)

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.

Declaration
protected virtual void AppendSemanticParameter(SemanticParameterKind kind, string name, string value, string prefix = null, int index = -1)
Parameters
Type Name Description
SemanticParameterKind kind

Kind of semantic parameter.

string name

Parameter name. The name parameter itself is not guaranteed to be unique in a given record. However, in combination with prefix and index, it is guaranteed to be unique.

string value

Parameter value.

string prefix

Prefix to be prepended to name, or null if there is no prefix.

int index

Index of the parameter value, if there are several values for the same parameter name, or -1 if there is a single parameter value for this parameter name.

AppendSemanticParameter<T>(SemanticParameterKind, string, T, IFormatter<T>, string, int)

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.

Declaration
protected virtual void AppendSemanticParameter<T>(SemanticParameterKind kind, string name, T value, IFormatter<T> formatter, string prefix = null, int index = -1)
Parameters
Type Name Description
SemanticParameterKind kind

Kind of semantic parameter.

string name

Parameter name. The name parameter itself is not guaranteed to be unique in a given record. However, in combination with prefix and index, it is guaranteed to be unique.

T value

Parameter value.

IFormatter<T> formatter

The formatter to be used to format value.

string prefix

Prefix to be prepended to name, or null if there is no prefix.

int index

Index of the parameter value, if there are several values for the same parameter name, or -1 if there is a single parameter value for this parameter name.

Type Parameters
Name Description
T

AppendSemanticParameter(SemanticParameterKind, string, object, IFormatter, string, int)

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.

Declaration
protected virtual void AppendSemanticParameter(SemanticParameterKind kind, string name, object value, IFormatter formatter, string prefix = null, int index = -1)
Parameters
Type Name Description
SemanticParameterKind kind

Kind of semantic parameter.

string name

Parameter name. The name parameter itself is not guaranteed to be unique in a given record. However, in combination with prefix and index, it is guaranteed to be unique.

object value

Parameter value.

IFormatter formatter

The formatter to be used to format value.

string prefix

Prefix to be prepended to name, or null if there is no prefix.

int index

Index of the parameter value, if there are several values for the same parameter name, or -1 if there is a single parameter value for this parameter name.

AppendSemanticParameter<T>(SemanticParameterKind, ArraySegment<char>, T, IFormatter<T>, string, int)

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.

Declaration
protected virtual void AppendSemanticParameter<T>(SemanticParameterKind kind, ArraySegment<char> name, T value, IFormatter<T> formatter, string prefix = null, int index = -1)
Parameters
Type Name Description
SemanticParameterKind kind

Kind of semantic parameter.

ArraySegment<char> name

Parameter name. The name parameter itself is not guaranteed to be unique in a given record. However, in combination with prefix and index, it is guaranteed to be unique.

T value

Parameter value.

IFormatter<T> formatter

The formatter to be used to format value.

string prefix

Prefix to be prepended to name, or null if there is no prefix.

int index

Index of the parameter value, if there are several values for the same parameter name, or -1 if there is a single parameter value for this parameter name.

Type Parameters
Name Description
T