.NET Framework Class Library
ControlDesignerUsePreviewControl Property

Gets a value indicating whether the control designer uses a temporary preview control to generate the design-time HTML markup.

Namespace:   System.Web.UI.Design
Assembly:  System.Design (in System.Design.dll)
Syntax
Protected Overridable ReadOnly Property UsePreviewControl As [%$TOPIC/c7y620wc_en-us_VS_110_1_0_0_0_0%]
protected virtual [%$TOPIC/c7y620wc_en-us_VS_110_1_0_1_0_0%] UsePreviewControl { get; }
protected:
virtual property [%$TOPIC/c7y620wc_en-us_VS_110_1_0_2_0_0%] UsePreviewControl {
	[%$TOPIC/c7y620wc_en-us_VS_110_1_0_2_0_1%] get ();
}
abstract UsePreviewControl : [%$TOPIC/c7y620wc_en-us_VS_110_1_0_3_0_0%] with get 
override UsePreviewControl : [%$TOPIC/c7y620wc_en-us_VS_110_1_0_3_0_1%] with get

Property Value

Type: SystemBoolean
true, if the control designer uses a temporary copy of the control for design-time preview; otherwise, false, if the control designer uses the Component property for the control contained in the control designer.
Remarks

If the UsePreviewControl property is true, the ViewControl property returns a temporary copy of the control. Changes to the temporary control are not persisted to the document.

If the UsePreviewControl property is false, the ViewControl property returns an instance of the Component property for the control. Changes to the instance of the control are persisted.

The SupportsPreviewControl setting in the SupportsPreviewControlAttribute object is used to set the value of the UsePreviewControl property. Therefore, the SupportsPreviewControl setting determines the type of control that is returned by the ViewControl property in the base ControlDesigner class. If the SupportsPreviewControlAttribute is not specified in the control designer declaration, the ControlDesigner object behavior is equivalent to specifying the SupportsPreviewControl property as false.

Notes to Inheritors

Custom designers that are derived from the ControlDesigner class can override the UsePreviewControl property and ignore the SupportsPreviewControlAttribute object. Generally, to indicate that the ViewControl property always returns a temporary copy of the control, override the UsePreviewControl property to always return true. To indicate that the ViewControl property always returns an instance of the control, override the UsePreviewControl property to always return false. For example, the PreviewControlDesigner class derives from the ControlDesigner and always returns true for the UsePreviewControl property.

Version Information

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0
.NET Framework Security
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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