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

EditableObjectAttribute Class

Custom attribute that, when applied to a class, implements IEditableObject into this class.
Inheritance Hierarchy
System.Object
  System.Attribute
    PostSharp.Extensibility.MulticastAttribute
      PostSharp.Aspects.Aspect
        PostSharp.Aspects.TypeLevelAspect
          PostSharp.Aspects.InstanceLevelAspect
            PostSharp.Patterns.Recording.EditableObjectAttribute

Namespace:  PostSharp.Patterns.Recording
Assembly:  PostSharp.Patterns.Model (in PostSharp.Patterns.Model.dll) Version: 5.0.33.0 (5.0.33.0)
Syntax
C#
public sealed class EditableObjectAttribute : InstanceLevelAspect, 
	IEditableObject, IAspectProvider, IAspect, IService

The EditableObjectAttribute type exposes the following members.

Constructors
  NameDescription
Public methodEditableObjectAttribute
Initializes a new instance of the EditableObjectAttribute 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.)
Public propertyInstance
Gets the object to which the current aspect has been applied.
(Inherited from InstanceLevelAspect.)
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 TypeLevelAspect.)
Public methodCompileTimeValidate(Object)
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from Aspect.)
Public methodCompileTimeValidate(Object)
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from TypeLevelAspect.)
Public methodCompileTimeValidate(Type)
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from TypeLevelAspect.)
Public methodCreateInstance
Creates a new instance of the aspect based on the current instance, serving as a prototype.
(Inherited from InstanceLevelAspect.)
Public methodGetAspectConfiguration
Method invoked at build tome to get the imperative configuration of the current Aspect.
(Inherited from Aspect.)
Public methodOnCloned
Method called after the an object enhanced by the current aspect has been cloned using MemberwiseClone(). The this parameter refers to the new aspect instance in the cloned object.
(Inherited from InstanceLevelAspect.)
Public methodRuntimeInitialize
Initializes the current aspect.
(Inherited from TypeLevelAspect.)
Public methodRuntimeInitializeInstance
Initializes the aspect instance. This method is invoked when all system elements of the aspect (like member imports) have completed.
(Inherited from InstanceLevelAspect.)
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 implicitly adds the RecordableAttribute aspect to the target class, unless the aspect is already applied to this class.

The aspect is implemented by creating a restore point using the AddRestorePoint(String) method in the BeginEdit() method, and undo using UndoTo(Operation) when the CancelEdit() method is invoked. The restore point is removed using Remove() after invoking CancelEdit() and EndEdit()

The implementation assumes that no other object being tracked by the same Recorder will be modified between calls to BeginEdit() and CancelEdit(), otherwise changes to these other objects will be canceled as well.

See Also