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 virtual bool UsePreviewControl { get; }
protected:
property bool UsePreviewControl {
	virtual bool get();
}
abstract UsePreviewControl : bool with get
override UsePreviewControl : bool with get
Protected Overridable ReadOnly Property UsePreviewControl As Boolean

Property Value

Type:

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

Remarks

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

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

The setting in the SupportsPreviewControlAttribute object is used to set the value of the property. Therefore, the setting determines the type of control that is returned by the 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 property as false.

Notes to Inheritors:

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

Version Information
.NET Framework
Available since 2.0
Return to top