HierarchicalDataBoundControlDesigner Class
Definition
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 design-time support in a designer host for the HierarchicalDataBoundControl control.
public ref class HierarchicalDataBoundControlDesigner : System::Web::UI::Design::WebControls::BaseDataBoundControlDesignerpublic class HierarchicalDataBoundControlDesigner : System.Web.UI.Design.WebControls.BaseDataBoundControlDesignertype HierarchicalDataBoundControlDesigner = class
inherit BaseDataBoundControlDesignerPublic Class HierarchicalDataBoundControlDesigner
Inherits BaseDataBoundControlDesigner- Inheritance
-
HierarchicalDataBoundControlDesigner
- Derived
Examples
The following code example shows how to extend the HierarchicalDataBoundControlDesigner class to change the appearance of controls that are derived from the HierarchicalDataBoundControl control at design time.
The example derives the MyHierarchicalDataBoundControl class from the HierarchicalDataBoundControl. The MyHierarchicalDataBoundControl class is simply a copy of the HierarchicalDataBoundControl. The example also derives the MyHierarchicalDataBoundControlDesigner class from the HierarchicalDataBoundControlDesigner class and places a DesignerAttribute object for the MyHierarchicalDataBoundControlDesigner on the MyHierarchicalDataBoundControl class.
The MyHierarchicalDataBoundControlDesigner overrides the PreFilterProperties method to make the NamingContainer property visible in the Properties grid at design time. It overrides the GetDesignTimeHtml method to generate the markup for a placeholder if the design time markup is null or Empty, or if the design-time markup is an empty <span> block (that is, if there is no inner markup between the <span …> and </span> tags).
using System;
using System.IO;
using System.Web;
using System.Drawing;
using System.Web.UI.WebControls;
using System.Web.UI.Design.WebControls;
using System.Collections;
using System.ComponentModel;
using System.Security.Permissions;
namespace Examples.CS.WebControls.Design
{
// The MyHierarchicalDataBoundControl is a copy of the
// HierarchicalDataBoundControl.
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
[Designer(typeof(Examples.CS.WebControls.Design.
MyHierarchicalDataBoundControlDesigner))]
public class MyHierarchicalDataBoundControl :
HierarchicalDataBoundControl
{
} // MyHierarchicalDataBoundControl
// Override members of the ierarchicalDataBoundControlDesigner.
[ReflectionPermission(SecurityAction.Demand, Flags=ReflectionPermissionFlag.MemberAccess)]
public class MyHierarchicalDataBoundControlDesigner :
HierarchicalDataBoundControlDesigner
{
const string bracketClose = ">";
const string spanOpen = "<SPAN";
const string spanClose = "</SPAN>";
// Return the markup for a placeholder, if the inner markup is empty.
// For brevity, the code that is used to detect embedded white_space
// in the tags is not shown.
public override string GetDesignTimeHtml()
{
// Get the design-time markup from the base method.
string markup = base.GetDesignTimeHtml();
// If the markup is null or empty, return the markup
// for the placeholder.
if(string.IsNullOrEmpty(markup))
return GetEmptyDesignTimeHtml();
// Make the markup uniform case so that the IndexOf will work.
string MARKUP = markup.ToUpper();
int charX;
// Look for a <span ...> tag.
if ((charX = MARKUP.IndexOf(spanOpen)) >= 0)
{
// Find closing bracket of span open tag.
if ((charX = MARKUP.IndexOf(bracketClose,
charX+spanOpen.Length)) >= 0)
{
// If the inner markup of <span ...></span> is empty,
// return the markup for a placeholder.
if (string.Compare(MARKUP, charX + 1, spanClose, 0,
spanClose.Length) == 0)
return GetEmptyDesignTimeHtml();
}
}
// Return the original markup, if the inner markup is not empty.
return markup;
}
// Shadow the control properties with design-time properties.
protected override void PreFilterProperties(IDictionary properties)
{
string namingContainer = "NamingContainer";
// Call the base method first.
base.PreFilterProperties(properties);
// Make the NamingContainery visible in the Properties grid.
PropertyDescriptor selectProp =
(PropertyDescriptor)properties[namingContainer];
properties[namingContainer] =
TypeDescriptor.CreateProperty(selectProp.ComponentType,
selectProp, BrowsableAttribute.Yes);
} // PreFilterProperties
} // MyHierarchicalDataBoundControlDesigner
} // Examples.CS.WebControls.Design
Imports System.IO
Imports System.Web
Imports System.Drawing
Imports System.Web.UI.WebControls
Imports System.Web.UI.Design.WebControls
Imports System.Collections
Imports System.ComponentModel
Imports System.Security.Permissions
Namespace Examples.VB.WebControls.Design
' The MyHierarchicalDataBoundControl is a copy of the
' HierarchicalDataBoundControl.
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<Designer(GetType(Examples.VB.WebControls.Design. _
MyHierarchicalDataBoundControlDesigner))> _
Public Class MyHierarchicalDataBoundControl
Inherits HierarchicalDataBoundControl
End Class
' Override members of the HierarchicalDataBoundControlDesigner.
<ReflectionPermission(SecurityAction.Demand, Flags:=ReflectionPermissionFlag.MemberAccess)> _
Public Class MyHierarchicalDataBoundControlDesigner
Inherits HierarchicalDataBoundControlDesigner
Private Const bracketClose As String = ">"
Private Const spanOpen As String = "<SPAN"
Private Const spanClose As String = "</SPAN>"
' Return the markup for a placeholder, if the inner markup is empty.
' For brevity, the code that is used to detect embedded white_space
' in the tags is not shown.
Public Overrides Function GetDesignTimeHtml() As String
' Get the design-time markup from the base method.
Dim markup As String = MyBase.GetDesignTimeHtml()
' If the markup is null or empty, return the markup
' for the placeholder.
If String.IsNullOrEmpty(markup) Then
Return GetEmptyDesignTimeHtml()
End If
' Make the markup uniform case so that the IndexOf will work.
Dim markupUC As String = markup.ToUpper()
Dim charX As Integer
' Look for a <span ...> tag.
charX = markupUC.IndexOf(spanOpen)
If charX >= 0 Then
' Find closing bracket of span open tag.
charX = markupUC.IndexOf(bracketClose, charX + spanOpen.Length)
If charX >= 0 Then
' If the inner markup of <span ...></span> is empty,
' return the markup for a placeholder.
If String.Compare(markupUC, charX + 1, _
spanClose, 0, spanClose.Length) = 0 Then
Return GetEmptyDesignTimeHtml()
End If
End If
End If
' Return the original markup, if the inner markup is not empty.
Return markup
End Function ' GetDesignTimeHtml
' Shadow the control properties with design-time properties.
Protected Overrides Sub PreFilterProperties( _
ByVal properties As IDictionary)
Dim namingContainer As String = "NamingContainer"
' Call the base method first.
MyBase.PreFilterProperties(properties)
' Make the NamingContainery visible in the Properties grid.
Dim selectProp As PropertyDescriptor = _
CType(properties(namingContainer), PropertyDescriptor)
properties(namingContainer) = _
TypeDescriptor.CreateProperty(selectProp.ComponentType, _
selectProp, BrowsableAttribute.Yes)
End Sub
End Class
End Namespace ' Examples.VB.WebControls.Design
Remarks
In a designer host, when the user switches from Source to Design view, the markup source code that describes a control that is derived from the HierarchicalDataBoundControl abstract class is parsed and a design-time version of the control is created on the design surface. When the user switches back to Source view, the design-time control is persisted to markup source code and edited into the markup for the Web page. The HierarchicalDataBoundControlDesigner class provides design-time support for controls that are derived from the HierarchicalDataBoundControl in a designer host.
The HierarchicalDataBoundControlDesigner class properties provide the following functionality:
The ActionLists property returns a DesignerActionListCollection object, which typically contains an object that is derived from the DesignerActionList class for each level in the inheritance tree of the designer.
The DataSourceDesigner property provides access to the designer of the data source, if one is defined.
The DesignerView property gets the default view of the data source that is bound to the associated control.
The UseDataSourcePickerActionList property determines whether the control should render its default action lists for choosing and creating data sources.
The HierarchicalDataBoundControlDesigner class methods provide the following functionality:
The ConnectToDataSource method performs the actions that are necessary to connect to the current data source.
The CreateDataSource method creates a new data source for the associated control.
The DataBind method binds the associated control that is derived from the HierarchicalDataBoundControl class to a design-time data source.
The DisconnectFromDataSource method performs the actions that are necessary to disconnect from the current data source.
The GetDesignTimeDataSource method gets a data source that can be used at design time for the associated control.
The GetSampleDataSource method constructs a sample data source that can be used at design time for the associated control.
The PreFilterProperties method is used to remove properties from or add additional properties to or to shadow properties of the associated control that is derived from the HierarchicalDataBoundControl class.
Constructors
| HierarchicalDataBoundControlDesigner() |
Initializes a new instance of the HierarchicalDataBoundControlDesigner class. |
Properties
| ActionLists |
Gets the designer action list collection for this designer. |
| 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. (Inherited from BaseDataBoundControlDesigner) |
| DataSourceDesigner |
Provides access to the designer of the data source, when one is selected for data binding. |
| DataSourceID |
Gets or sets the value of the DataSourceID property of the underlying BaseDataBoundControl object. (Inherited from BaseDataBoundControlDesigner) |
| DesignerState |
Gets an object that is used to persist data for the associated control at design time. (Inherited from ControlDesigner) |
| DesignerView |
Gets the default view of the data source that is bound to the associated control. |
| 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 |
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) |
| SetTextualDefaultProperty | (Inherited from ComponentDesigner) |
| 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) |
| UseDataSourcePickerActionList |
Gets a value that indicates whether the control should render its default action lists, which contain a data source ID drop-down list and related tasks. |
| 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 |
| Visible |
Gets a value that indicates whether the control is visible at design time. (Inherited from ControlDesigner) |
Methods
| ConnectToDataSource() |
Performs the actions that are necessary to connect to the current data source. |
| CreateDataSource() |
Creates a new data source for the associated control. |
| 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(BaseDataBoundControl) |
Binds the associated control to the design-time data source. |
| DisconnectFromDataSource() |
Performs the actions that are necessary to disconnect 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. (Inherited from BaseDataBoundControlDesigner) |
| 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) |
| GetBounds() |
Retrieves the coordinates of the rectangle representing the boundaries for the control as displayed on the design surface. (Inherited from ControlDesigner) |
| GetDesignTimeDataSource() |
Gets a data source that can be used at design time for the associated control. |
| GetDesignTimeHtml() |
Generates the markup that is used to render the control at design time. (Inherited from BaseDataBoundControlDesigner) |
| GetDesignTimeHtml(DesignerRegionCollection) |
Retrieves the HTML markup to display the control and populates the collection with the current control designer regions. (Inherited from ControlDesigner) |
| GetEditableDesignerRegionContent(EditableDesignerRegion) |
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. (Inherited from BaseDataBoundControlDesigner) |
| GetErrorDesignTimeHtml(Exception) |
Provides the markup that is used to render the control at design time when an error has occurred. (Inherited from BaseDataBoundControlDesigner) |
| GetHashCode() |
Serves as the default hash function. (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) |
| GetSampleDataSource() |
Constructs a sample data source that can be used at design time for the associated control. |
| GetService(Type) |
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(IComponent) |
Prepares the designer to view, edit, and design the associated control. (Inherited from BaseDataBoundControlDesigner) |
| InitializeExistingComponent(IDictionary) |
Reinitializes an existing component. (Inherited from ComponentDesigner) |
| InitializeNewComponent(IDictionary) |
Initializes a newly created component. (Inherited from ComponentDesigner) |
| InitializeNonDefault() |
Obsolete.
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(ComponentDesigner) |
Gets the InheritanceAttribute of the specified ComponentDesigner. (Inherited from ComponentDesigner) |
| IsPropertyBound(String) |
Obsolete.
Retrieves a value indicating whether the specified property on the associated control is data-bound. (Inherited from ControlDesigner) |
| Localize(IDesignTimeResourceWriter) |
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(DesignerAutoFormat) |
Called when a predefined, automatic formatting scheme has been applied to the associated control. (Inherited from ControlDesigner) |
| OnBehaviorAttached() |
Called when the control designer is attached to a Behavior object. (Inherited from ControlDesigner) |
| OnBehaviorDetaching() |
Obsolete.
Called when a behavior disassociates from the element. (Inherited from HtmlControlDesigner) |
| OnBindingsCollectionChanged(String) |
Obsolete.
Called when the data-binding collection changes. (Inherited from ControlDesigner) |
| OnClick(DesignerRegionMouseEventArgs) |
Called by the design host when the user clicks the associated control at design time. (Inherited from ControlDesigner) |
| OnComponentChanged(Object, ComponentChangedEventArgs) |
Called when the associated control changes. (Inherited from ControlDesigner) |
| OnComponentChanging(Object, ComponentChangingEventArgs) |
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(Boolean) |
Called when the data source of the associated BaseDataBoundControl object changes. (Inherited from BaseDataBoundControlDesigner) |
| OnPaint(PaintEventArgs) |
Called when the control designer draws the associated control on the design surface, if the CustomPaint value is |
| OnSchemaRefreshed() |
Called when the data source of the associated BaseDataBoundControl object loads a new schema. (Inherited from BaseDataBoundControlDesigner) |
| OnSetComponentDefaults() |
Obsolete.
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(IDictionary) |
Allows a designer to change or remove items from the set of attributes that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner) |
| PostFilterEvents(IDictionary) |
Allows a designer to change or remove items from the set of events that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner) |
| PostFilterProperties(IDictionary) |
Allows a designer to change or remove items from the set of properties that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner) |
| PreFilterAttributes(IDictionary) |
Allows a designer to add to the set of attributes that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner) |
| PreFilterEvents(IDictionary) |
Sets the list of events that are exposed at design-time for the TypeDescriptor object for the component. (Inherited from HtmlControlDesigner) |
| PreFilterProperties(IDictionary) |
Used by the designer to remove properties from or add additional properties to the display in the Properties grid or to shadow properties of the associated control. |
| RaiseComponentChanged(MemberDescriptor, Object, Object) |
Notifies the IComponentChangeService that this component has been changed. (Inherited from ComponentDesigner) |
| RaiseComponentChanging(MemberDescriptor) |
Notifies the IComponentChangeService that this component is about to be changed. (Inherited from ComponentDesigner) |
| RaiseResizeEvent() |
Obsolete.
Raises the OnControlResize() event. (Inherited from ControlDesigner) |
| RegisterClone(Object, Object) |
Registers internal data in a cloned control. (Inherited from ControlDesigner) |
| SetEditableDesignerRegionContent(EditableDesignerRegion, String) |
Specifies the content for an editable region of the control at design time. (Inherited from ControlDesigner) |
| SetRegionContent(EditableDesignerRegion, String) |
Specifies the content for an editable region in the design-time view of the control. (Inherited from ControlDesigner) |
| SetViewFlags(ViewFlags, Boolean) |
Assigns the specified bitwise ViewFlags enumeration to the specified flag value. (Inherited from ControlDesigner) |
| 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) |
