Export (0) Print
Expand All

ControlDesigner.UsePreviewControl Property

Note: This property is new in the .NET Framework version 2.0.

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)

protected virtual bool UsePreviewControl { get; }
/** @property */
protected boolean get_UsePreviewControl ()

protected function get UsePreviewControl () : boolean

Property Value

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.

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

  • Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see .

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0
Show:
© 2014 Microsoft