PersistenceModeAttribute Class

Definition

Namespace:

System.Web.UI

Assembly:

System.Web.dll

Defines the metadata attribute that specifies how an ASP.NET server control property or event is persisted to an ASP.NET page at design time. This class cannot be inherited.

public ref class PersistenceModeAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.All)]
public sealed class PersistenceModeAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.All)>]
type PersistenceModeAttribute = class
    inherit Attribute

Public NotInheritable Class PersistenceModeAttribute
Inherits Attribute

Inheritance

Object

Attribute

PersistenceModeAttribute

Attributes

AttributeUsageAttribute

Examples

[PersistenceMode(PersistenceMode.InnerProperty),
TemplateContainer(typeof(TemplateItem))]
public ITemplate MessageTemplate {
   get {
      return _messageTemplate;
   }
   set {
      _messageTemplate = value;
   }
}

<PersistenceMode(PersistenceMode.InnerProperty), TemplateContainer(GetType(TemplateItem))> Public Property MessageTemplate() As ITemplate
   Get
      Return _messageTemplate
   End Get
   Set(ByVal Value As ITemplate)
      _messageTemplate = Value
   End Set
End Property

Remarks

For more information about using attributes, see Attributes.

Note

The Web page designer in Visual Studio does not support the ResetPropertyName method that is optionally exposed by Windows Forms controls for property persistence. Server controls are serialized using methods provided by the ControlPersister class. The implementation of these methods is driven by metadata attributes such as DefaultValueAttribute, PersistenceModeAttribute, and DesignerSerializationVisibilityAttribute.

Constructors

PersistenceModeAttribute(PersistenceMode)

Initializes a new instance of the PersistenceModeAttribute class.

Fields

Attribute	Specifies that the property or event persists in the opening tag of the server control as an attribute. This field is read-only.
Default	Specifies the default type for the PersistenceModeAttribute class. The default is PersistenceMode.Attribute. This field is read-only.
EncodedInnerDefaultProperty	Specifies that a property is HTML-encoded and persists as the only inner content of the ASP.NET server control. This field is read-only.
InnerDefaultProperty	Specifies that a property persists as the only inner content of the ASP.NET server control. This field is read-only.
InnerProperty	Specifies that the property persists as a nested tag within the opening and closing tags of the server control. This field is read-only.

Properties

Mode	Gets the current value of the PersistenceMode enumeration.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Compares the PersistenceModeAttribute object against another object.
GetHashCode()	Provides a hash value for a PersistenceModeAttribute attribute.
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	Indicates whether the PersistenceModeAttribute object is of the default type.
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)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Provides access to properties and methods exposed by an object. (Inherited from Attribute)

See also

• Attribute