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

WeakEventAttribute Class

Aspect that, when applied to an event, prevents the target event from holding a strong reference to event handlers. Therefore, the aspect prevents the event to prevent clients to be garbage collected.
Inheritance Hierarchy
System.Object
  System.Attribute
    PostSharp.Extensibility.MulticastAttribute
      PostSharp.Aspects.Aspect
        PostSharp.Aspects.EventLevelAspect
          PostSharp.Aspects.EventInterceptionAspect
            PostSharp.Patterns.Model.WeakEventAttribute

Namespace:  PostSharp.Patterns.Model
Assembly:  PostSharp.Patterns.Model (in PostSharp.Patterns.Model.dll) Version: 5.0.31.0 (5.0.31.0)
Syntax
C#
public sealed class WeakEventAttribute : EventInterceptionAspect, 
	IInstanceScopedAspect, IAspect

The WeakEventAttribute type exposes the following members.

Constructors
  NameDescription
Public methodWeakEventAttribute
Initializes a new instance of the WeakEventAttribute 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.)
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 EventLevelAspect.)
Public methodCompileTimeValidate(Object)
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from EventLevelAspect.)
Public methodCompileTimeValidate(EventInfo)
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from EventLevelAspect.)
Public methodGetAspectConfiguration
Method invoked at build tome to get the imperative configuration of the current Aspect.
(Inherited from Aspect.)
Public methodOnAddHandler
Method invoked instead of the Add semantic of the event to which the current aspect is applied, i.e. when a new delegate is added to this event.
(Inherited from EventInterceptionAspect.)
Public methodOnInvokeHandler
Method invoked when the event to which the current aspect is applied is fired, for each delegate of this event, and instead of invoking this delegate.
(Inherited from EventInterceptionAspect.)
Public methodOnRemoveHandler
Method invoked instead of the Remove semantic of the event to which the current aspect is applied, i.e. when a delegate is removed from this event.
(Inherited from EventInterceptionAspect.)
Public methodRuntimeInitialize
Initializes the current aspect.
(Inherited from EventLevelAspect.)
Top
Extension Methods
  NameDescription
Public Extension MethodQueryInterface<T>
Gets the implementation of a specified interface for the specified object.
(Defined by QueryInterfaceExtensions.)
Top
Remarks

Event clients do not need to keep a strong reference to the delegates passed to a weak event. The WeakEventAttribute implementation will keep delegate instances alive as long as the event source (i.e. whatever object the Target property points to) is alive, but no longer.

See Also