ControlDesigner.UsePreviewControl Property

protected:
 virtual property bool UsePreviewControl { bool get(); };

protected virtual bool UsePreviewControl { get; }

member this.UsePreviewControl : bool

Protected Overridable ReadOnly Property UsePreviewControl As 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.

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.

Applies to

See also

• SupportsPreviewControlAttribute
• ViewControl
• GetViewRendering
• PreviewControlDesigner
• ASP.NET Control Designers Overview