Indicates whether a control designer requires a preview instance of the control at design time. This class cannot be inherited.
Assembly: System.Design (in System.Design.dll)
Thetype exposes the following members.
|Equals||Determines whether the specified object represents the same preview attribute setting as the current instance of the class. (Overrides Attribute.Equals(Object).)|
|Finalize||Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)|
|GetHashCode||Returns the hash code for this instance of the class. (Overrides Attribute.GetHashCode().)|
|GetType||Gets the Type of the current instance. (Inherited from Object.)|
|IsDefaultAttribute||Indicates whether the current instance of the class is set to the default preview attribute value. (Overrides Attribute.IsDefaultAttribute().)|
|Match||When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)|
|MemberwiseClone||Creates a shallow copy of the current Object. (Inherited from Object.)|
|ToString||Returns a string that represents the current object. (Inherited from Object.)|
|_Attribute.GetIDsOfNames||Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)|
|_Attribute.GetTypeInfo||Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)|
|_Attribute.GetTypeInfoCount||Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)|
|_Attribute.Invoke||Provides access to properties and methods exposed by an object. (Inherited from Attribute.)|
Apply the attribute to a control designer class to indicate the type of preview control that is supported by the control designer. Use this attribute to change a preview control for design-time rendering without affecting the actual persisted instance of the associated control.
Typically, you specify the when declaring a custom designer class that is derived from the ControlDesigner class. The value of the SupportsPreviewControl property for the 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.
For example, the CalendarDesigner class is marked with the set to true. The designer uses the preview control with the automatic style formatting task, which allows the user to preview various autoformat styles that can be applied to the calendar. As the user selects different autoformat styles in the user interface, the selected style scheme is applied to the preview control. Applying a new style to the preview control does not change the scheme that is applied to the instance of the Calendar control in the designer.
Designer classes derived from the ControlDesigner class can override the UsePreviewControl and ViewControl members, and ignore the attribute. To determine the expected behavior for ViewControl and UsePreviewControl, see the reference documentation for the derived control designer class.
For general information about using attributes, see Attributes Overview and Extending Metadata Using Attributes. For more information about design-time attributes, see Attributes and Design-Time Support.
The following code example demonstrates how to mark a control designer with the attribute. The code example derives an ASP.NET server control from the Label class and associates the ASP.NET server control with a custom control designer implementation. The control designer class declaration is marked with the SupportsPreviewControl attribute set to true. The control designer overrides the GetDesignTimeHtml method and encloses the design-time HTML for the control in italic tags.
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.