MetadataUpdateHandlerAttribute Class

Definition

Indicates that a type that should receive notifications of metadata updates.

public ref class MetadataUpdateHandlerAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Assembly, AllowMultiple=true)]
public sealed class MetadataUpdateHandlerAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Assembly, AllowMultiple=true)>]
type MetadataUpdateHandlerAttribute = class
    inherit Attribute
Public NotInheritable Class MetadataUpdateHandlerAttribute
Inherits Attribute
Inheritance
MetadataUpdateHandlerAttribute
Attributes

Remarks

The Type specified by this attribute should implement static methods matching the signature of one or more of the following (visibility of the methods does not matter):

  • static void ClearCache(Type[]? updatedTypes)
  • static void UpdateApplication(Type[]? updatedTypes)

After a metadata update is applied, ClearCache is invoked for every handler that specifies one. This gives update handlers an opportunity to clear any caches that are inferred based on the application's metadata. After all ClearCache methods have been invoked, UpdateApplication is invoked for every handler that specifies one. This enables applications to refresh the application state, trigger a UI re-render, or other such reactions. When specified, the updatedTypes parameter contains the set of types that were affected by the metadata update; if it's null, any type may have been updated.

Constructors

MetadataUpdateHandlerAttribute(Type)

Initializes the attribute.

Properties

HandlerType

Gets the type that handles metadata updates and that should be notified when any occur.

TypeId

When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object)

Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode()

Returns the hash code for this instance.

(Inherited from Attribute)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to