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 HierarchySystem.Object
System.Attribute
PostSharp.Extensibility.MulticastAttribute
PostSharp.Aspects.Aspect
PostSharp.Aspects.LocationLevelAspect
PostSharp.Aspects.LocationInterceptionAspect
System.Attribute
PostSharp.Extensibility.MulticastAttribute
PostSharp.Aspects.Aspect
PostSharp.Aspects.LocationLevelAspect
PostSharp.Aspects.LocationInterceptionAspect
Namespace: PostSharp.Aspects
Assembly: PostSharp (in PostSharp.dll) Version: 6.5.13.0 (6.5.13.0)
SyntaxC#
[SerializableAttribute] public abstract class LocationInterceptionAspect : LocationLevelAspect, ILocationInterceptionAspect, ILocationLevelAspect, IAspect, IOnInstanceLocationInitializedAspect
The LocationInterceptionAspect type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | LocationInterceptionAspect | Initializes a new instance of the LocationInterceptionAspect class |
Properties| Name | Description | |
|---|---|---|
 | AspectPriority |
Gets or sets the weaving priority of the aspect.
(Inherited from Aspect.) |
| AttributeExclude |
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.) |
| AttributeInheritance |
Determines whether this attribute is inherited
(Inherited from MulticastAttribute.) |
| AttributePriority |
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.) |
| AttributeReplace |
Determines whether this attribute replaces other attributes found on the
target declarations.
(Inherited from MulticastAttribute.) |
| AttributeTargetAssemblies |
Gets or sets the assemblies to which the current attribute apply.
(Inherited from MulticastAttribute.) |
| AttributeTargetElements |
Gets or sets the kind of elements to which this custom attributes applies.
(Inherited from MulticastAttribute.) |
| AttributeTargetExternalMemberAttributes |
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.) |
| AttributeTargetExternalTypeAttributes |
Gets or sets the visibilities of types to which this attribute applies,
when this type is external to the current module.
(Inherited from MulticastAttribute.) |
| AttributeTargetMemberAttributes |
Gets or sets the visibilities, scopes, virtualities, and other characteristics
of members to which this attribute applies.
(Inherited from MulticastAttribute.) |
| AttributeTargetMembers |
Gets or sets the expression specifying to which members
this instance applies.
(Inherited from MulticastAttribute.) |
| AttributeTargetParameterAttributes |
Gets or sets the passing style (by value, out or ref)
of parameters to which this attribute applies.
(Inherited from MulticastAttribute.) |
| AttributeTargetParameters |
Gets or sets the expression specifying to which parameters
this instance applies.
(Inherited from MulticastAttribute.) |
| AttributeTargetTypeAttributes |
Gets or sets the attributes of types to which this attribute applies. Visibility, scope (Instance or Static)
and generation are the only categories that are taken into account; attributes of other categories are ignored.
(Inherited from MulticastAttribute.) |
| AttributeTargetTypes |
Gets or sets the expression specifying to which types
this instance applies.
(Inherited from MulticastAttribute.) |
 | SerializerType |
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.) |
| UnsupportedTargetAction |
Specifies the action to take when the aspect is applied to an unsupported target element. This property affects only simple aspects, not composite aspects.
(Inherited from Aspect.) |
Methods| Name | Description | |
|---|---|---|
 | CompileTimeInitialize |
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.) |
| CompileTimeValidate(Object) |
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from LocationLevelAspect.) |
| CompileTimeValidate(LocationInfo) |
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from LocationLevelAspect.) |
| CreateAspectConfiguration |
Method invoked at build time to create a concrete AspectConfiguration instance specifically
for the current Aspect type.
(Overrides Aspect.CreateAspectConfiguration().) |
| GetAspectConfiguration |
Method invoked at build tome to get the imperative configuration of the current Aspect.
(Inherited from Aspect.) |
| OnGetValue |
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 |
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 |
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.
|
| RuntimeInitialize |
Initializes the current aspect.
(Inherited from LocationLevelAspect.) |
| SetAspectConfiguration(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.) |
| SetAspectConfiguration(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.) |
RemarksThis 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 Aspect Serialization . |
See Also