This documentation is archived and is not being maintained.

SupportsPreviewControlAttribute.SupportsPreviewControl Property

Gets a value indicating whether the control designer requires a temporary preview control at design time.

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

public bool SupportsPreviewControl { get; }

Property Value

Type: System.Boolean
true if the designer uses a temporary copy of the associated control for design-time preview; false if the designer uses an instance of the Component control that is contained in the designer.

Typically, you specify a value for the SupportsPreviewControl property by applying the SupportsPreviewControlAttribute attribute to a custom designer class declaration. The value of the SupportsPreviewControl property for the SupportsPreviewControlAttribute attribute determines the behavior for the UsePreviewControl and ViewControl members in the base ControlDesigner class.

Set the SupportsPreviewControl property to true to indicate that the designer uses a temporary copy of the associated control to generate the design-time HTML. Changes to the temporary control are not persisted.

Set the SupportsPreviewControl property to false to indicate that the designer returns the control instance, specifically the Component property, from the ViewControl method. Changes to the control object are persisted.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.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.