This documentation is archived and is not being maintained.

ControlPersister Class

Provides methods for persisting Web server controls at design-time.

System.Object
  System.Web.UI.Design.ControlPersister

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

[<Sealed>]
[<SecurityPermissionAttribute(SecurityAction.Demand, Flags = SecurityPermissionFlag.UnmanagedCode)>]
type ControlPersister =  class end

The ControlPersister type exposes the following members.

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodStatic memberPersistControl(Control)Gets a string of data that represents the persisted form of the specified control.
Public methodStatic memberPersistControl(Control, IDesignerHost)Gets a string of data that represents the persisted form of the specified control, using the specified designer host.
Public methodStatic memberPersistControl(TextWriter, Control)Outputs a string of data that represents the persisted form of the specified control to the specified TextWriter.
Public methodStatic memberPersistControl(TextWriter, Control, IDesignerHost)Outputs a string of data that represents the persisted form of the specified control to the specified TextWriter, using the specified designer host.
Public methodStatic memberPersistInnerProperties(Object, IDesignerHost)Gets a string of data that can persist the inner properties of the specified control.
Public methodStatic memberPersistInnerProperties(TextWriter, Object, IDesignerHost)Outputs a string of data that can persist the inner properties of the specified control to the specified TextWriter, using the specified designer host.
Public methodStatic memberPersistTemplate(ITemplate, IDesignerHost)Gets a string of data that represents the persisted form of the specified template.
Public methodStatic memberPersistTemplate(TextWriter, ITemplate, IDesignerHost)Writes a string of data that represents the persisted form of the specified template to the specified TextWriter object.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The ControlPersister class provides methods that can persist a Control control or an ITemplate interface implementation as a string of aspx code. The implementation of these methods is driven by metadata attributes, such as the DefaultValueAttribute, PersistenceModeAttribute, and DesignerSerializationVisibilityAttribute.

NoteNote

The Web Forms page designer does not support the ResetPropertyName method that is optionally exposed by Microsoft Windows Forms-based controls for property persistence.

To create a Control object or an ITemplate interface by parsing a string of control- or template-persistence data, use the ControlParser class methods.

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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