PostSharp6.2/API Reference/Post­Sharp.​Patterns.​Contracts Namespace/Location­Contract­Attribute Class

LocationContractAttribute Class

Base class for other custom attributes in this namespace.
Inheritance Hierarchy
System.Object
  System.Attribute
    PostSharp.Extensibility.MulticastAttribute
      PostSharp.Patterns.Contracts.LocationContractAttribute
        More...

Namespace:  PostSharp.Patterns.Contracts
Assembly:  PostSharp.Patterns.Common (in PostSharp.Patterns.Common.dll) Version: 6.2.5.0 (6.2.5.0)
Syntax
C#
Copy
public abstract class LocationContractAttribute : MulticastAttribute, 
	ILocationLevelAspect, IAspect

The LocationContractAttribute type exposes the following members.

Constructors
  NameDescription
Protected methodLocationContractAttribute
Initializes a new LocationContractAttribute.
Properties
  NameDescription
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 propertyErrorMessage
Gets or sets the error message formatting string.
Methods
  NameDescription
Protected methodCompileTimeValidate
Validates that the current aspect has been applied to a valid location.
Protected methodCreateArgumentException
Creates an ArgumentException with an error message formatted from ErrorMessage and given concrete values.
Protected methodCreateArgumentNullException
Creates an ArgumentNullException with an error message formatted from ErrorMessage and given concrete values.
Protected methodCreateArgumentOutOfRangeException
Creates an ArgumentOutOfRangeException with an error message formatted from ErrorMessage and given concrete values.
Protected methodCreatePostconditionFailedException
Creates an PostconditionFailedException with an error message formatted from ErrorMessage and given concrete values.
Protected methodFormatErrorMessage
Formats the ErrorMessage with concrete values.
Protected methodGetErrorMessage
Gets unformatted error message as defined by the instance.
Protected methodGetErrorMessageArguments
Gets values of additional arguments for error message associated with particular instance of LocationContractAttribute. There arguments can be referenced from error message string by {4}, {5} and so on.
Public methodRuntimeInitialize
Initializes the aspect at runtime.
Protected methodSelectSelfOrNothing
A pointcut that selects the target location of the current aspect, unless the target location is a dependency property or an attached property.
Public methodValidateValueDynamic
Validates a weakly-typed (boxed) value, typically the value of a dependency property or an attached property.
Remarks

Basic error message is identified by LocationContractErrorMessage and obtained from the provider set in Current.

All formatting string are have following parameters replaced:

  • Field Value

    Type: 
    {0} represents location name.

  • Field Value

    Type: 
    {1} represents location kind.

  • Field Value

    Type: 
    {2} represents string containing both location kind and name.

  • Field Value

    Type: 
    {3} represents value which caused the error when being assigned to the location.
  • Further parameters are described in remarks sections of appropriate contracts which override the GetErrorMessageArguments() method.

Note that an array of error message arguments are cached for each location.

See Also
Inheritance Hierarchy