PersistChildrenAttribute Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Defines an attribute that is used by ASP.NET server controls to indicate at design time whether nested content that is contained within a server control corresponds to controls or to properties of the server control. This class cannot be inherited.

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)

System::Object
  System::Attribute
    System.Web.UI::PersistChildrenAttribute

[AttributeUsageAttribute(AttributeTargets::Class)]
public ref class PersistChildrenAttribute sealed : Attribute

NameDescription
System_CAPS_pubmethodPersistChildrenAttribute(Boolean)

Initializes a new instance of the PersistChildrenAttribute class using a Boolean value indicating whether to persist nested content as nested controls.

System_CAPS_pubmethodPersistChildrenAttribute(Boolean, Boolean)

Initializes a new instance of the PersistChildrenAttribute class using two Boolean values. One indicating whether to persist nested content as nested controls and the other indicating whether to use a custom persistence method.

NameDescription
System_CAPS_pubpropertyPersist

Gets a value that indicates whether the nested content is persisted as nested controls at design time.

System_CAPS_pubpropertyTypeId

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

System_CAPS_pubpropertyUsesCustomPersistence

Gets a value indicating whether the server control provides custom persistence of nested controls at design time.

NameDescription
System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Overrides Attribute::Equals(Object^).)

System_CAPS_pubmethodGetHashCode()

Serves as a hash function for the PersistChildrenAttribute class.(Overrides Attribute::GetHashCode().)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIsDefaultAttribute()

Returns a value indicating whether the value of the current instance of the PersistChildrenAttribute class is the default value of the derived clss.(Overrides Attribute::IsDefaultAttribute().)

System_CAPS_pubmethodMatch(Object^)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticDefault

Indicates the default attribute state. The Default field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticNo

Indicates that nested content should not persist as nested controls at design time. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticYes

Indicates that nested content should persist as controls at design time. The Yes field is read-only.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute::GetIDsOfNames(Guid%, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute::GetTypeInfoCount(UInt32%)

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute::Invoke(UInt32, Guid%, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

The PersistChildrenAttribute is used in combination with the ParseChildrenAttribute to determine how nested content of a control is interpreted. If PersistChildrenAttribute is true and ParseChildrenAttribute is false, the nested content contained within an ASP.NET server control is persisted as controls. If PersistChildrenAttribute is false and ParseChildrenAttribute is true, the nested content is persisted as properties of the server control. For more information about using attributes, see Extending Metadata Using Attributes.

The code example in this section contains two parts. The first code example demonstrates how to set the metadata of a custom control so that at design time, its nested content is persisted as properties of the control. The second code example demonstrates how to use classes in an ASP.NET page.

The following code example demonstrates how to apply the PersistChildrenAttribute attribute so that none of a custom server control's nested controls are persisted as nested controls. The custom server control named CollectionPropertyControl has the PersistChildrenAttribute attribute set to false so that the Employee objects that are added are persisted as nested elements.

No code example is currently available or this language may not be supported.

The following code example demonstrates how to use the CollectionPropertyControl and Employee classes in an ASP.NET page.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: