WebFormsRootDesigner Class

Reference

Definition

Namespace:: System.Web.UI.Design

Assembly:: System.Design.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides a base class for the design-time functionality of a Web Forms page and allows access to and manipulation of components and controls that are contained within the Web Forms page at design time.

public ref class WebFormsRootDesigner abstract : IDisposable, System::ComponentModel::Design::IDesignerFilter, System::ComponentModel::Design::IRootDesigner

public abstract class WebFormsRootDesigner : IDisposable, System.ComponentModel.Design.IDesignerFilter, System.ComponentModel.Design.IRootDesigner

type WebFormsRootDesigner = class
    interface IRootDesigner
    interface IDesigner
    interface IDisposable
    interface IDesignerFilter

Public MustInherit Class WebFormsRootDesigner
Implements IDesignerFilter, IDisposable, IRootDesigner

Inheritance: Object
WebFormsRootDesigner

Implements: IDesigner IDesignerFilter IRootDesigner IDisposable

Remarks

A design host, such as Visual Studio 2005, must provide its own derived version of the WebFormsRootDesigner class to control designers through the RootDesigner property of the designer. Control designers use the RootDesigner property to access and manipulate the containing Web Forms page at design time.

Notes to Implementers

When you inherit from the WebFormsRootDesigner class, you must override the following members:

The DocumentUrl, IsDesignerViewLocked, IsLoading, ReferenceManager, SupportedTechnologies, and Verbs properties.
The AddClientScriptToDocument(ClientScriptItem), AddControlToDocument(Control, Control, ControlLocation), GetClientScriptsInDocument(), GetControlViewAndTag(Control, IControlDesignerView, IControlDesignerTag), and RemoveControlFromDocument(Control) methods.

Constructors

WebFormsRootDesigner()

Initializes a new instance of the WebFormsRootDesigner class.

Properties

Component	Gets or sets the component that this designer is designing.
CurrentCulture	Gets the culture information for the current thread.
DocumentUrl	When overridden in a derived class, gets the URL at which the Web Forms page is located.
IsDesignerViewLocked	When overridden in a derived class, gets a value indicating whether the designer view is locked.
IsLoading	When overridden in a derived class, gets a value indicating whether the Web Forms page is still loading.
ReferenceManager	When overridden in a derived class, gets a WebFormsReferenceManager object that has information about the current Web Forms page.
SupportedTechnologies	Gets an array of technologies that the designer component can support for its display.
Verbs	Gets the design-time verbs that are supported by the designer.

Methods

AddClientScriptToDocument(ClientScriptItem)	When overridden in a derived class, adds a client script element to the current Web Forms page.
AddControlToDocument(Control, Control, ControlLocation)	When overridden in a derived class, adds a Web server control to the Web Forms page.
CreateDesignerActionService(IServiceProvider)	Returns a design-time DesignerActionService object.
CreateUrlResolutionService()	Returns an IUrlResolutionService that resolves relative URLs.
Dispose(Boolean)	Releases the unmanaged resources that are used by the WebFormsRootDesigner and optionally releases the managed resources.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize()	Frees the resources of the current WebFormsRootDesigner object before it is reclaimed by the garbage collector.
GenerateEmptyDesignTimeHtml(Control)	Generates empty HTML markup for a control at design time.
GenerateErrorDesignTimeHtml(Control, Exception, String)	Generates HTML markup that is used to display an error message at design time by using the specified control, exception, and message.
GetClientScriptsInDocument()	When overridden in a derived class, returns a ClientScriptItemCollection object that contains all client script items that are on the page.
GetControlViewAndTag(Control, IControlDesignerView, IControlDesignerTag)	When overridden in a derived class, returns both the current design-time view and the HTML markup for the specified control.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetService(Type)	Returns the requested service.
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetView(ViewTechnology)	Returns a view object that is determined by the provided ViewTechnology object.
Initialize(IComponent)	Initializes the WebFormsRootDesigner object using the specified component.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnLoadComplete(EventArgs)	Raises the LoadComplete event when the Web Forms page is completely loaded.
PostFilterAttributes(IDictionary)	Allows a designer to change or remove items from the set of attributes that the designer exposes through a TypeDescriptor object.
PostFilterEvents(IDictionary)	Allows a designer to change or remove items from the set of events that the designer exposes through a TypeDescriptor object.
PostFilterProperties(IDictionary)	Allows a designer to change or remove items from the set of properties that the designer exposes through a TypeDescriptor object.
PreFilterAttributes(IDictionary)	Allows a designer to add to the set of attributes that the designer exposes through a TypeDescriptor object.
PreFilterEvents(IDictionary)	Allows a designer to add items to the set of events that the designer exposes through a TypeDescriptor object.
PreFilterProperties(IDictionary)	Allows a designer to add items to the set of properties that the designer exposes through a TypeDescriptor object.
RemoveClientScriptFromDocument(String)	Removes the specified client script from the document at design time.
RemoveControlFromDocument(Control)	When overridden in a derived class, removes the specified control from the Web Forms page.
ResolveUrl(String)	Converts a relative URL into a fully qualified URL.
SetControlID(Control, String)	Sets the `ID` property of the specified control with the specified string.
ToString()	Returns a string that represents the current object. (Inherited from Object)

Events

LoadComplete

Occurs when the designer completes loading the Web Forms page.

Explicit Interface Implementations

IDesigner.DoDefaultAction()	For a description of this member, see DoDefaultAction().
IDesigner.Verbs	Gets or sets the design-time verbs that are supported by the designer. For a description of this member, see Verbs.
IDesignerFilter.PostFilterAttributes(IDictionary)	For a description of this member, see PostFilterAttributes(IDictionary).
IDesignerFilter.PostFilterEvents(IDictionary)	For a description of this member, see PostFilterEvents(IDictionary).
IDesignerFilter.PostFilterProperties(IDictionary)	For a description of this member, see PostFilterProperties(IDictionary).
IDesignerFilter.PreFilterAttributes(IDictionary)	For a description of this member, see PreFilterAttributes(IDictionary).
IDesignerFilter.PreFilterEvents(IDictionary)	For a description of this member, see PreFilterEvents(IDictionary).
IDesignerFilter.PreFilterProperties(IDictionary)	For a description of this member, see PreFilterProperties(IDictionary).
IDisposable.Dispose()	For a description of this member, see Dispose().
IRootDesigner.GetView(ViewTechnology)	Gets a view object for the specified view technology. For a description of this member, see GetView(ViewTechnology).
IRootDesigner.SupportedTechnologies	Gets an array of technologies that the designer component can support for its display. For a description of this member, see SupportedTechnologies.

Applies to