BaseDataBoundControlDesigner Class (System.Web.UI.Design.WebControls)

United States (English)

Home Library Learn Samples Downloads Support Community Forums

.NET Framework Class Library

BaseDataBoundControlDesigner Class

Provides design-time support in a visual designer for controls that are derived from the BaseDataBoundControl class.

SystemObject
   System.ComponentModel.DesignComponentDesigner
     System.Web.UI.DesignHtmlControlDesigner
       System.Web.UI.DesignControlDesigner
        System.Web.UI.Design.WebControlsBaseDataBoundControlDesigner
           System.Web.UI.Design.WebControlsDataBoundControlDesigner
           System.Web.UI.Design.WebControlsHierarchicalDataBoundControlDesigner

Namespace: System.Web.UI.Design.WebControls
Assembly: System.Design (in System.Design.dll)

Syntax

Public MustInherit Class BaseDataBoundControlDesigner _
	Inherits [%$TOPIC/95d6thwb_en-us_VS_110_3_0_0_0_0%]

public abstract class BaseDataBoundControlDesigner : [%$TOPIC/95d6thwb_en-us_VS_110_3_0_1_0_0%]

public ref class BaseDataBoundControlDesigner abstract : public [%$TOPIC/95d6thwb_en-us_VS_110_3_0_2_0_0%]

[<[%$TOPIC/95d6thwb_en-us_VS_110_3_0_3_0_0%]>]
type BaseDataBoundControlDesigner =  
    class 
        inherit [%$TOPIC/95d6thwb_en-us_VS_110_3_0_3_0_1%] 
    end

The BaseDataBoundControlDesigner type exposes the following members.

Constructors

	Name	Description
	BaseDataBoundControlDesigner	Infrastructure. Initializes a new instance of the BaseDataBoundControlDesigner class.

Top

Properties

	Name	Description
	ActionLists	Gets the action list collection for the control designer. (Inherited from ControlDesigner.)
	AllowResize	Gets a value indicating whether the control can be resized in the design-time environment. (Inherited from ControlDesigner.)
	AssociatedComponents	Gets the collection of components associated with the component managed by the designer. (Inherited from ComponentDesigner.)
	AutoFormats	Gets the collection of predefined automatic formatting schemes to display in the Auto Format dialog box for the associated control at design time. (Inherited from ControlDesigner.)
	Behavior	Obsolete. Gets or sets the DHTML behavior that is associated with the designer. (Inherited from HtmlControlDesigner.)
	Component	Gets the component this designer is designing. (Inherited from ComponentDesigner.)
	DataBindings	Gets the data bindings collection for the current control. (Inherited from HtmlControlDesigner.)
	DataBindingsEnabled	Gets a value indicating whether data binding is supported by the containing region for the associated control. (Inherited from ControlDesigner.)
	DataSource	Gets or sets the value of the DataSource property for the associated control.
	DataSourceID	Gets or sets the value of the DataSourceID property of the underlying BaseDataBoundControl object.
	DesignerState	Gets an object that is used to persist data for the associated control at design time. (Inherited from ControlDesigner.)
	DesignTimeElement	Obsolete. Gets the design-time object representing the control that is associated with the HtmlControlDesigner object on the design surface. (Inherited from HtmlControlDesigner.)
	DesignTimeElementView	Obsolete. Gets the view-control object for the control designer. (Inherited from ControlDesigner.)
	DesignTimeHtmlRequiresLoadComplete	Obsolete. Gets a value indicating whether the design host must finish loading before the GetDesignTimeHtml method can be called. (Inherited from ControlDesigner.)
	Expressions	Gets the expression bindings for the current control at design time. (Inherited from HtmlControlDesigner.)
	HidePropertiesInTemplateMode	Infrastructure. Gets a value indicating whether the properties of the associated control are hidden when the control is in template mode. (Inherited from ControlDesigner.)
	ID	Gets or sets the ID string for the control. (Inherited from ControlDesigner.)
	InheritanceAttribute	Gets an attribute that indicates the type of inheritance of the associated component. (Inherited from ComponentDesigner.)
	Inherited	Gets a value indicating whether this component is inherited. (Inherited from ComponentDesigner.)
	InTemplateMode	Gets a value indicating whether the control is in either template viewing or editing mode in the design host. The InTemplateMode property is read-only. (Inherited from ControlDesigner.)
	IsDirty	Obsolete. Gets or sets a value indicating whether the Web server control has been marked as changed. (Inherited from ControlDesigner.)
	ParentComponent	Gets the parent component for this designer. (Inherited from ComponentDesigner.)
	ReadOnly	Obsolete. Gets or sets a value indicating whether the properties of the control are read-only at design time. (Inherited from ControlDesigner.)
	RootDesigner	Gets the control designer for the Web Forms page that contains the associated control. (Inherited from ControlDesigner.)
	ShadowProperties	Gets a collection of property values that override user settings. (Inherited from ComponentDesigner.)
	ShouldCodeSerialize	Obsolete. Gets or sets a value indicating whether to create a field declaration for the control in the code-behind file for the current design document during serialization. (Inherited from HtmlControlDesigner.)
	Tag	Gets an object representing the HTML markup element for the associated control. (Inherited from ControlDesigner.)
	TemplateGroups	Gets a collection of template groups, each containing one or more template definitions. (Inherited from ControlDesigner.)
	UsePreviewControl	Gets a value indicating whether the control designer uses a temporary preview control to generate the design-time HTML markup. (Inherited from ControlDesigner.)
	Verbs	Gets the design-time verbs supported by the component that is associated with the designer. (Inherited from ComponentDesigner.)
	ViewControl	Gets or sets a Web server control that can be used for previewing the design-time HTML markup. (Inherited from ControlDesigner.)
	ViewControlCreated	Gets or sets a value indicating whether a View control has been created for display on the design surface. (Inherited from ControlDesigner.)
	Visible	Gets a value that indicates whether the control is visible at design time. (Inherited from ControlDesigner.)

Top

Methods

	Name	Description
	ConnectToDataSource	When overridden in a derived class, typically unhooks events from the previous data source, and then attaches new events to the new data source.
	CreateDataSource	When overridden in a derived class, creates a new data source for the associated BaseDataBoundControl object.
	CreateErrorDesignTimeHtml(String)	Creates HTML markup to display a specified error message at design time. (Inherited from ControlDesigner.)
	CreateErrorDesignTimeHtml(String, Exception)	Creates the HTML markup to display a specified exception error message at design time. (Inherited from ControlDesigner.)
	CreatePlaceHolderDesignTimeHtml	Provides a simple rectangular placeholder representation that displays the type and ID of the control. (Inherited from ControlDesigner.)
	CreatePlaceHolderDesignTimeHtml(String)	Provides a simple rectangular placeholder representation that displays the type and ID of the control, and also additional specified instructions or information. (Inherited from ControlDesigner.)
	CreateViewControl	Returns a copy of the associated control for viewing or rendering on the design surface. (Inherited from ControlDesigner.)
	DataBind	When overridden in a derived class, performs the necessary actions to set up the associated control that is derived from the BaseDataBoundControl class.
	DisconnectFromDataSource	When overridden in a derived class, unhooks events from the current data source.
	Dispose	Releases all resources used by the ComponentDesigner. (Inherited from ComponentDesigner.)
	Dispose(Boolean)	Releases the unmanaged resources that are used by the BaseDataBoundControlDesigner object, and optionally releases the managed resources. (Overrides HtmlControlDesignerDispose(Boolean).)
	DoDefaultAction	Creates a method signature in the source code file for the default event on the component and navigates the user's cursor to that location. (Inherited from ComponentDesigner.)
	Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Attempts to free resources by calling Dispose(false) before the object is reclaimed by garbage collection. (Inherited from ComponentDesigner.)
	GetBounds	Retrieves the coordinates of the rectangle representing the boundaries for the control as displayed on the design surface. (Inherited from ControlDesigner.)
	GetDesignTimeHtml	Generates the markup that is used to render the control at design time. (Overrides ControlDesignerGetDesignTimeHtml.)
	GetDesignTimeHtml(DesignerRegionCollection)	Retrieves the HTML markup to display the control and populates the collection with the current control designer regions. (Inherited from ControlDesigner.)
	GetEditableDesignerRegionContent	Returns the content for an editable region of the design-time view of the associated control. (Inherited from ControlDesigner.)
	GetEmptyDesignTimeHtml	Provides the markup that is used to render the control at design time if the control is empty or if the data source cannot be retrieved. (Overrides ControlDesignerGetEmptyDesignTimeHtml.)
	GetErrorDesignTimeHtml	Provides the markup that is used to render the control at design time when an error has occurred. (Overrides ControlDesignerGetErrorDesignTimeHtml(Exception).)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetPersistenceContent	Retrieves the persistable inner HTML markup of the control at design time. (Inherited from ControlDesigner.)
	GetPersistInnerHtml	Obsolete. Retrieves the persistable inner HTML markup of the control. (Inherited from ControlDesigner.)
	GetService	Attempts to retrieve the specified type of service from the design mode site of the designer's component. (Inherited from ComponentDesigner.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetViewRendering	Retrieves an object that contains the design-time markup for the content and regions of the associated control. (Inherited from ControlDesigner.)
	Initialize	Prepares the designer to view, edit, and design the associated control. (Overrides ControlDesignerInitialize(IComponent).)
	InitializeExistingComponent	Reinitializes an existing component. (Inherited from ComponentDesigner.)
	InitializeNewComponent	Initializes a newly created component. (Inherited from ComponentDesigner.)
	InitializeNonDefault	Obsolete. Initializes the settings for an imported component that is already initialized to settings other than the defaults. (Inherited from ComponentDesigner.)
	Invalidate	Invalidates the whole area of the control that is displayed on the design surface and signals the control designer to redraw the control. (Inherited from ControlDesigner.)
	Invalidate(Rectangle)	Invalidates the specified area of the control that is displayed on the design surface and signals the control designer to redraw the control. (Inherited from ControlDesigner.)
	InvokeGetInheritanceAttribute	Gets the InheritanceAttribute of the specified ComponentDesigner. (Inherited from ComponentDesigner.)
	IsPropertyBound	Obsolete. Retrieves a value indicating whether the specified property on the associated control is data-bound. (Inherited from ControlDesigner.)
	Localize	Uses the provided resource writer to persist the localizable properties of the associated control to a resource in the design host. (Inherited from ControlDesigner.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnAutoFormatApplied	Called when a predefined, automatic formatting scheme has been applied to the associated control. (Inherited from ControlDesigner.)
	OnBehaviorAttached	Obsolete. Called when a behavior is associated with the element. (Inherited from HtmlControlDesigner.)
	OnBehaviorDetaching	Obsolete. Called when a behavior disassociates from the element. (Inherited from HtmlControlDesigner.)
	OnBindingsCollectionChanged	Obsolete. Called when the data-binding collection changes. (Inherited from ControlDesigner.)
	OnClick	Called by the design host when the user clicks the associated control at design time. (Inherited from ControlDesigner.)
	OnComponentChanged	Called when the associated control changes. (Inherited from ControlDesigner.)
	OnComponentChanging	Represents the method that will handle the ComponentChanging event for the associated control. (Inherited from ControlDesigner.)
	OnControlResize	Obsolete. Called when the associated Web server control has been resized in the design host at design time. (Inherited from ControlDesigner.)
	OnDataSourceChanged	Called when the data source of the associated BaseDataBoundControl object changes.
	OnPaint	Called when the control designer draws the associated control on the design surface, if the CustomPaint value is true. (Inherited from ControlDesigner.)
	OnSchemaRefreshed	Called when the data source of the associated BaseDataBoundControl object loads a new schema.
	OnSetComponentDefaults	Obsolete. Sets the default properties for the component. (Inherited from ComponentDesigner.)
	OnSetParent	Provides a way to perform additional processing when the associated control is attached to a parent control. (Inherited from HtmlControlDesigner.)
	PostFilterAttributes	Allows a designer to change or remove items from the set of attributes that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner.)
	PostFilterEvents	Allows a designer to change or remove items from the set of events that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner.)
	PostFilterProperties	Allows a designer to change or remove items from the set of properties that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner.)
	PreFilterAttributes	Allows a designer to add to the set of attributes that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner.)
	PreFilterEvents	Sets the list of events that are exposed at design-time for the TypeDescriptor object for the component. (Inherited from HtmlControlDesigner.)
	PreFilterProperties	Used by the designer to remove or add additional properties for display in the Properties grid or to shadow properties of the associated control. (Overrides ControlDesignerPreFilterProperties(IDictionary).)
	RaiseComponentChanged	Notifies the IComponentChangeService that this component has been changed. (Inherited from ComponentDesigner.)
	RaiseComponentChanging	Notifies the IComponentChangeService that this component is about to be changed. (Inherited from ComponentDesigner.)
	RaiseResizeEvent	Obsolete. Raises the OnControlResize event. (Inherited from ControlDesigner.)
	RegisterClone	Registers internal data in a cloned control. (Inherited from ControlDesigner.)
	SetEditableDesignerRegionContent	Specifies the content for an editable region of the control at design time. (Inherited from ControlDesigner.)
	SetRegionContent	Specifies the content for an editable region in the design-time view of the control. (Inherited from ControlDesigner.)
	SetViewFlags	Assigns the specified bitwise ViewFlags enumeration to the specified flag value. (Inherited from ControlDesigner.)
	ShowCreateDataSourceDialog	In a design host, such as Visual Studio 2005, displays a dialog box to assist the user in creating a data source.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdateDesignTimeHtml	Refreshes the design-time HTML markup for the associated Web server control by calling the GetDesignTimeHtml method. (Inherited from ControlDesigner.)

Top

Explicit Interface Implementations

	Name	Description
	IDesignerFilterPostFilterAttributes	For a description of this member, see the IDesignerFilterPostFilterAttributes method. (Inherited from ComponentDesigner.)
	IDesignerFilterPostFilterEvents	For a description of this member, see the IDesignerFilterPostFilterEvents method. (Inherited from ComponentDesigner.)
	IDesignerFilterPostFilterProperties	For a description of this member, see the IDesignerFilterPostFilterProperties method. (Inherited from ComponentDesigner.)
	IDesignerFilterPreFilterAttributes	For a description of this member, see the IDesignerFilterPreFilterAttributes method. (Inherited from ComponentDesigner.)
	IDesignerFilterPreFilterEvents	For a description of this member, see the IDesignerFilterPreFilterEvents method. (Inherited from ComponentDesigner.)
	IDesignerFilterPreFilterProperties	For a description of this member, see the IDesignerFilterPreFilterProperties method. (Inherited from ComponentDesigner.)
	ITreeDesignerChildren	For a description of this member, see the ITreeDesignerChildren property. (Inherited from ComponentDesigner.)
	ITreeDesignerParent	For a description of this member, see the ITreeDesignerParent property. (Inherited from ComponentDesigner.)

Top

Remarks

In a visual designer, when you switch from Source to Design view, the markup that describes a control that is derived from the BaseDataBoundControl class is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control code is persisted to the markup source and edited into the markup for the Web page.

Designers that are derived from the BaseDataBoundControlDesigner abstract base class provide design-time support for controls that are derived from the BaseDataBoundControl class.

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

System.Web.UI.Design.WebControls Namespace

BaseDataBoundControl

ControlDesigner

Other Resources

ASP.NET Control Designers Overview

Walkthrough: Creating a Basic Control Designer for a Web Server Control