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

Advice­Args

Arguments

Aspect3

Aspect­Description­Attribute2

Aspect­Info

Aspect­Instance2

Aspect­Specification

Aspect­Utilities

Assembly­Level­Aspect4

Async­Call­Id

Composition­Aspect5

Constructor­Depth

Custom­Attribute­Introduction­Aspect

Event­Interception­Args2

Event­Interception­Aspect5

Event­Level­Aspect4

Field­Level­Aspect4

Flow­Behavior

IAspect

IAspect­Build­Semantics

IAspect­Instance

IAspect­Provider

IAspect­Repository­Service

IAssembly­Level­Aspect

IAssembly­Level­Aspect­Build­Semantics

IAsync­Method­Binding

IAsync­Method­Interception­Aspect

IClone­Aware­Aspect

IComposition­Aspect

ICustom­Attribute­Introduction­Aspect

IEvent­Binding

IEvent­Interception­Aspect

IEvent­Level­Aspect

IEvent­Level­Aspect­Build­Semantics

IField­Level­Aspect

IField­Level­Aspect­Build­Semantics

IInstance­Scoped­Aspect

ILocation­Binding

ILocation­Binding<T>

ILocation­Binding­Action<TPayload>

ILocation­Interception­Args

ILocation­Interception­Args<T>

ILocation­Interception­Args­Action<TPayload>

ILocation­Interception­Aspect

ILocation­Level­Aspect

ILocation­Level­Aspect­Build­Semantics

ILocation­Validation­Aspect

ILocation­Validation­Aspect<T>

IManaged­Resource­Introduction­Aspect

IMethod­Binding

IMethod­Interception­Aspect

IMethod­Level­Aspect

IMethod­Level­Aspect­Build­Semantics

Instance­Level­Aspect5

IOn­Exception­Aspect

IOn­Instance­Location­Initialized­Aspect

IOn­Method­Boundary­Aspect

IOn­State­Machine­Boundary­Aspect

IType­Level­Aspect

IType­Level­Aspect­Build­Semantics

Lines­Of­Code­Avoided­Attribute2

Location­Binding­Extensions

Location­Initialization­Args3

Location­Interception­Args3

Location­Interception­Aspect5

Location­Level­Aspect4

Location­Validation­Context

Managed­Resource­Introduction­Aspect

Method­Binding­Invoke­Awaitable

Method­Binding­Invoke­Awaiter

Method­Execution­Args2

Method­Implementation­Aspect5

Method­Interception­Args2

Method­Interception­Aspect5

Method­Interception­Proceed­Awaitable

Method­Interception­Proceed­Awaiter

Method­Level­Aspect4

Module­Initializer­Attribute2

Null­Task­Sentinel

On­Exception­Aspect5

On­Method­Boundary­Aspect5

Semantically­Advised­Method­Kinds

Type­Identity

Type­Level­Aspect4

Unsupported­Target­Action

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

Class LocationInterceptionAspect

Aspect that, when applied on a location (field or property), intercepts invocations of the Get (OnGetValue(LocationInterceptionArgs)) and Set (OnSetValue(LocationInterceptionArgs)) semantics.

Inheritance
LocationInterceptionAspect
Namespace: PostSharp.Aspects
Assembly: PostSharp.dll
Syntax
[MulticastAttributeUsage(MulticastTargets.Field|MulticastTargets.Property, TargetMemberAttributes = MulticastAttributes.NonAbstract|MulticastAttributes.NonLiteral, AllowExternalAssemblies = false, AllowMultiple = true)]
[HasInheritedAttribute]
[AttributeUsage(AttributeTargets.Assembly|AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Interface, AllowMultiple = true)]
[AspectConfigurationAttributeType(typeof(LocationInterceptionAspectConfigurationAttribute))]
[Serializer(null)]
public abstract class LocationInterceptionAspect : LocationLevelAspect, ILocationLevelAspectBuildSemantics, IAspectBuildSemantics, IValidableAnnotation, ILocationInterceptionAspect, IOnInstanceLocationInitializedAspect, ILocationLevelAspect, IAspect
Remarks

This aspect can be applied indifferently to fields and properties, called locations because they both have the semantics of a slot where a value can be stored and retrieved.

Applying the Aspect on Properties

Applying an aspect of type LocationInterceptionAspect to a property results in the accessors of this property to be replaced by a call to the method OnGetValue(LocationInterceptionArgs) or OnSetValue(LocationInterceptionArgs) of the current class. The original body of the accessor is moved into a new method, which can be called by the aspect by invoking one of the methods ProceedGetValue(), ProceedSetValue(), GetCurrentValue() or SetNewValue(object), or by using the Binding object.

Applying the Aspect on Fields

Applying this aspect on a field transforms the field into a property of the same name, scope and visibility as the original field. The original field is removed. Aspect code can get or set the value of the field by calling the methods ProceedGetValue(), ProceedSetValue(), GetCurrentValue() or SetNewValue(object), or by using the Binding object.

note

Remember to use PropertyInfo instead of FieldInfo at runtime to reflect the original field. For this reason, you cannot store a FieldInfo in the aspect. Store a LocationInfo instead; even if a LocationInfo represents a field at build time, it will represent the corresponding PropertyInfo at runtime.

note

When you apply an aspect derived from LocationInterceptionAspect to a value-type field, you should not pass the value of this field by reference (as an argument to out and ref parameters in C#). Indeed, PostSharp is unable to detect read and write accesses through references.

note

All classes implementing IAspect should typically be marked as serializable using the SerializableAttribute or PSerializableAttribute custom attribute . Fields that are only used at runtime (and unknown at compile-time) should be carefully marked with the NonSerializedAttribute or PNonSerializedAttribute custom attribute. When PostSharp is used on a platform that does not support aspect serialization (such as .NET Compact Framework, Silverlight, or Windows Phone), or when another aspect serializer is used, it is not necessary to mark the aspect class as serializable. For more information, see Understanding Aspect Serialization .

Understanding Aspect Serialization

Constructors

Name Description
LocationInterceptionAspect()

Methods

Name Description
CreateAspectConfiguration()

Method invoked at build time to create a concrete AspectConfiguration instance specifically for the current Aspect type.

OnGetValue(LocationInterceptionArgs)

Method invoked instead of the Get semantic of the field or property to which the current aspect is applied, i.e. when the value of this field or property is retrieved.

OnInstanceLocationInitialized(LocationInitializationArgs)

Method invoked after an initial value is set for a field or property to which the current aspect is applied. The method is invoked only for instance fields and instance auto-implemented properties, and it is invoked after their inline initialization. For static fields and properties, and for accesses from the constructor, OnSetValue is invoked instead.

OnSetValue(LocationInterceptionArgs)

Method invoked instead of the Set semantic of the field or property to which the current aspect is applied, i.e. when the value of this field or property is changed.

See Also