This is the online documentation for PostSharp 5.0.
Download PDF or CHM. Go to v4.3 or v5.0

LocationInterceptionAspect Class

Aspect that, when applied on a location (field or property), intercepts invocations of the Get (OnGetValue(LocationInterceptionArgs)) and Set (OnSetValue(LocationInterceptionArgs)) semantics.
Inheritance Hierarchy
System.Object
  System.Attribute
    PostSharp.Extensibility.MulticastAttribute
      PostSharp.Aspects.Aspect
        PostSharp.Aspects.LocationLevelAspect
          PostSharp.Aspects.LocationInterceptionAspect

Namespace:  PostSharp.Aspects
Assembly:  PostSharp (in PostSharp.dll) Version: 5.0.31.0 (5.0.31.0)
Syntax
C#
[SerializableAttribute]
public abstract class LocationInterceptionAspect : LocationLevelAspect, 
	ILocationInterceptionAspect, ILocationLevelAspect, IAspect

The LocationInterceptionAspect type exposes the following members.

Constructors
  NameDescription
Protected methodLocationInterceptionAspect
Initializes a new instance of the LocationInterceptionAspect class
Top
Properties
  NameDescription
Public propertyAspectPriority
Gets or sets the weaving priority of the aspect.
(Inherited from Aspect.)
Public propertyAttributeExclude
If true, indicates that this attribute removes all other instances of the same attribute type from the set of elements defined by the current instance.
(Inherited from MulticastAttribute.)
Public propertyAttributeInheritance
Determines whether this attribute is inherited
(Inherited from MulticastAttribute.)
Public propertyAttributePriority
Gets or sets the priority of the current attribute in case that multiple instances are defined on the same element (lower values are processed before).
(Inherited from MulticastAttribute.)
Public propertyAttributeReplace
Determines whether this attribute replaces other attributes found on the target declarations.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetAssemblies
Gets or sets the assemblies to which the current attribute apply.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetElements
Gets or sets the kind of elements to which this custom attributes applies.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetExternalMemberAttributes
Gets or sets the visibilities, scopes, virtualities, and implementation of members to which this attribute applies, when the member is external to the current module.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetExternalTypeAttributes
Gets or sets the visibilities of types to which this attribute applies, when this type is external to the current module.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetMemberAttributes
Gets or sets the visibilities, scopes, virtualities, and implementation of members to which this attribute applies.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetMembers
Gets or sets the expression specifying to which members this instance applies.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetParameterAttributes
Gets or sets the passing style (by value, out or ref) of parameters to which this attribute applies.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetParameters
Gets or sets the expression specifying to which parameters this instance applies.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetTypeAttributes
Gets or sets the visibilities of types to which this attribute applies.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetTypes
Gets or sets the expression specifying to which types this instance applies.
(Inherited from MulticastAttribute.)
Protected propertySerializerType
Gets or sets the Type of the serializer (a type derived from AspectSerializer) used to serialize the aspect instance at build time and deserialize it at runtime.
(Inherited from Aspect.)
Top
Methods
  NameDescription
Public methodCompileTimeInitialize
Method invoked at build time to initialize the instance fields of the current aspect. This method is invoked before any other build-time method.
(Inherited from LocationLevelAspect.)
Public methodCompileTimeValidate(Object)
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from LocationLevelAspect.)
Public methodCompileTimeValidate(LocationInfo)
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from LocationLevelAspect.)
Protected methodCreateAspectConfiguration
Method invoked at build time to create a concrete AspectConfiguration instance specifically for the current Aspect type.
(Overrides Aspect.CreateAspectConfiguration().)
Public methodGetAspectConfiguration
Method invoked at build tome to get the imperative configuration of the current Aspect.
(Inherited from Aspect.)
Public methodOnGetValue
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.
Public methodOnSetValue
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.
Public methodRuntimeInitialize
Initializes the current aspect.
(Inherited from LocationLevelAspect.)
Protected methodSetAspectConfiguration(AspectConfiguration, LocationInfo)
Method invoked at build time to set up an AspectConfiguration object according to the current Aspect instance and a specified target element of the current aspect.
(Inherited from LocationLevelAspect.)
Protected methodSetAspectConfiguration(AspectConfiguration, Object)
Method invoked at build time to set up an AspectConfiguration object according to the current Aspect instance and a specified target element of the current aspect.
(Inherited from LocationLevelAspect.)
Top
Extension Methods
  NameDescription
Public Extension MethodQueryInterface<T>
Gets the implementation of a specified interface for the specified object.
(Defined by QueryInterfaceExtensions.)
Top
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.

For details about the implementation of this aspect, see Interception Aspects.

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.

For details about the implementation of this aspect, see Interception Aspects.

Note 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 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 Note
All classes implementing IAspect should typically be marked as serializable using the custom attribute SerializableAttribute . Fields that are only used at runtime (and unknown at compile-time) should be carefully marked with the custom attribute NonSerializedAttribute . 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 Aspect Serialization .

See Also