CompositionAspect Class |
Aspect that, when applied on a type, introduces one or many new interfaces
into that type.
Inheritance HierarchySystem.Object
System.Attribute
PostSharp.Extensibility.MulticastAttribute
PostSharp.Aspects.Aspect
PostSharp.Aspects.TypeLevelAspect
PostSharp.Aspects.CompositionAspect
System.Attribute
PostSharp.Extensibility.MulticastAttribute
PostSharp.Aspects.Aspect
PostSharp.Aspects.TypeLevelAspect
PostSharp.Aspects.CompositionAspect
Namespace: PostSharp.Aspects
Assembly: PostSharp (in PostSharp.dll) Version: 6.4.6.0 (6.4.6.0)
SyntaxC#
[SerializableAttribute] public abstract class CompositionAspect : TypeLevelAspect, ICompositionAspect, ITypeLevelAspect, IAspect
The CompositionAspect type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CompositionAspect | Initializes a new instance of the CompositionAspect class |
Properties| Name | Description | |
|---|---|---|
 | AncestorOverrideAction |
Specifies the action (Fail or Ignore)
to be overtaken when an ancestor of one of the interfaces returned by GetPublicInterfaces(Type)
is already implemented by the type to which the current aspect is applied.
|
 | 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.) |
| GenerateImplementationAccessor |
Determines whether the interface [!:IComposed<T>] should be introduced into the type to which the aspect
is applied for each interface returned by the GetPublicInterfaces(Type) method.
|
| NonSerializedImplementation |
Determines whether the field containing the interface implementation (and storing the object returned by
CreateImplementationObject(AdviceArgs)) should be excluded from serialization by BinaryFormatter.
The same effect is typically obtained by applying the NonSerializedAttribute custom attribute to the field.
|
| OverrideAction |
Specifies the action (Fail or Ignore)
to be overtaken when one of the interfaces returned by the GetPublicInterfaces(Type) method
is already implemented by the type to which the current aspect is applied.
|
| 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 TypeLevelAspect.) |
| CompileTimeValidate(Object) |
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from TypeLevelAspect.) |
| CompileTimeValidate(Type) |
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from TypeLevelAspect.) |
| CreateAspectConfiguration |
Method invoked at build time to create a concrete AspectConfiguration instance specifically
for the current Aspect type.
(Overrides Aspect.CreateAspectConfiguration().) |
| CreateImplementationObject |
Method invoked at runtime, during the initialization of instances of the target type,
to create the composed object.
|
| GetAspectConfiguration |
Method invoked at build tome to get the imperative configuration of the current Aspect.
(Inherited from Aspect.) |
| GetPublicInterfaces |
Gets the array of interfaces that should be introduced publicly into
the target type of the current aspect.
|
| RuntimeInitialize |
Initializes the current aspect.
(Inherited from TypeLevelAspect.) |
| SetAspectConfiguration(AspectConfiguration, Type) |
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.
(Overrides TypeLevelAspect.SetAspectConfiguration(AspectConfiguration, Type).) |
| 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 TypeLevelAspect.) |
Remarks Note |
|---|
| Consider using a composite aspect and introducing an interface using IntroduceMemberAttribute instead of using a CompositionAspect. |
The GetPublicInterfaces(Type) method is invoked at build time. At runtime, the method CreateImplementationObject(AdviceArgs) should return an object implementing all interfaces.
Use the Post.Cast<TSource, TTarget>(TSource) method to cast the enhanced type to the newly implemented interface. This cast is verified during post-compilation.
Properties OverrideAction and AncestorOverrideAction determine what should happen if the target type already implements the interface directly or indirectly.
By default, the object implementing the interface is stored as a serializable field. If the property NonSerializedImplementation is set to true, this field will be marked as NonSerializedAttribute.
| 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