AccessDataSourceDesigner Class

Definition

Provides design-time support in a visual designer for the AccessDataSource Web server control.

public ref class AccessDataSourceDesigner : System::Web::UI::Design::WebControls::SqlDataSourceDesigner
public class AccessDataSourceDesigner : System.Web.UI.Design.WebControls.SqlDataSourceDesigner
type AccessDataSourceDesigner = class
    inherit SqlDataSourceDesigner
Public Class AccessDataSourceDesigner
Inherits SqlDataSourceDesigner
Inheritance

Examples

This section provides two code examples. The first demonstrates how to extend the AccessDataSourceDesigner class. The second demonstrates how to derive a copy of the AccessDataSource class and associate it with a designer.

The following code example demonstrates how to extend the AccessDataSourceDesigner class. The code alters the placeholder that represents the control on the design surface and adds a property to the Properties grid.

// Shadow control properties with design time properties.
protected override void PreFilterProperties(IDictionary properties)
{
    // Call the base class method first.
    base.PreFilterProperties(properties);

    // Add the ConnectionString property to the property grid.
    PropertyDescriptor property =
        (PropertyDescriptor)properties["ConnectionString"];
    Attribute[] attributes = new Attribute[]
    {
        new BrowsableAttribute(true),
        new ReadOnlyAttribute(true)
    };
    properties["ConnectionString"] = TypeDescriptor.CreateProperty(
        GetType(), property, attributes);
}
' Shadow control properties with design time properties.
Protected Overrides Sub PreFilterProperties(ByVal properties As IDictionary)

    ' Call the base class method first.
    MyBase.PreFilterProperties(properties)

    ' Add the ConnectionString property to the property grid.
    Dim prop As PropertyDescriptor
    prop = CType(properties("ConnectionString"), PropertyDescriptor)

   Dim atts(1) As Attribute
    atts(0) = New BrowsableAttribute(True)
    atts(1) = New ReadOnlyAttribute(True)

    properties("ConnectionString") = TypeDescriptor.CreateProperty( _
        prop.GetType(), prop, atts)
End Sub

The following code example demonstrates how to derive a copy of the AccessDataSource class and associate it with the designer that was defined in the preceding example.

// Create a control and bind it to the ExampleAccessDataSourceDesigner.
[AspNetHostingPermission(System.Security.Permissions.SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(System.Security.Permissions.SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
[Designer(typeof(CustomControls.Design.ExampleAccessDataSourceDesigner))]
public class ExampleAccessDataSource : AccessDataSource
{
    // Does nothing extra
}
' Create a control and bind it to the ExampleAccessDataSourceDesigner.
<AspNetHostingPermission(System.Security.Permissions.SecurityAction.Demand, _
    Level:=System.Web.AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(System.Security.Permissions.SecurityAction.InheritanceDemand, _
    Level:=System.Web.AspNetHostingPermissionLevel.Minimal)> _
<Designer("CustomControls.Design.ExampleAccessDataSourceDesigner")> _
Public Class ExampleAccessDataSource
    Inherits AccessDataSource

    ' Does nothing extra
End Class

Remarks

In a visual designer, when you switch from Source to Design view, the markup source code that describes the AccessDataSource control is parsed and a design-time version of the control, which is just a placeholder, is created on the design surface. When you switch back to Source view, the design-time control, which includes the values of the properties in the Properties grid, is persisted to the markup source code and edited into the markup for the Web page.

Constructors

AccessDataSourceDesigner()

Initializes a new instance of the AccessDataSource class.

Properties

ActionLists

Gets a list of items that are used to create an action list menu at design time.

(Inherited from DataSourceDesigner)
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

Gets or sets the DHTML behavior that is associated with the designer.

(Inherited from HtmlControlDesigner)
CanConfigure

Gets a value indicating whether the Configure() method can be called by the design host.

(Inherited from SqlDataSourceDesigner)
CanRefreshSchema

Gets a value indicating whether the RefreshSchema(Boolean) method can be called by the design host.

(Inherited from SqlDataSourceDesigner)
Component

Gets the component this designer is designing.

(Inherited from ComponentDesigner)
ConnectionString

Gets or sets the string used to open a database.

(Inherited from SqlDataSourceDesigner)
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)
DataFile

Implements a designer property to shadow the DataFile property of the associated control.

DeleteQuery

Gets or sets the SqlDataSourceDesigner that supports delete queries.

(Inherited from SqlDataSourceDesigner)
DesignerState

Gets an object that is used to persist data for the associated control at design time.

(Inherited from ControlDesigner)
DesignTimeElement

Gets the design-time object representing the control that is associated with the HtmlControlDesigner object on the design surface.

(Inherited from HtmlControlDesigner)
DesignTimeElementView

Gets the view-control object for the control designer.

(Inherited from ControlDesigner)
DesignTimeHtmlRequiresLoadComplete

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)
InsertQuery

Gets or sets the SqlDataSourceDesigner that supports insert queries.

(Inherited from SqlDataSourceDesigner)
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

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)
ProviderName

Gets or sets the name of the .NET Framework data provider that the associated SqlDataSource control uses to connect to an underlying data source.

(Inherited from SqlDataSourceDesigner)
ReadOnly

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)
SelectCommand

Gets or sets the SQL query in the associated SqlDataSource for selecting data from the underlying database.

(Inherited from SqlDataSourceDesigner)
SelectQuery

Gets or sets the SqlDataSourceDesigner that supports select queries.

(Inherited from SqlDataSourceDesigner)
ShadowProperties

Gets a collection of property values that override user settings.

(Inherited from ComponentDesigner)
ShouldCodeSerialize

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)
SuppressingDataSourceEvents

Gets a value indicating whether the DataSourceChanged event or the RefreshSchema(Boolean) method occurs.

(Inherited from DataSourceDesigner)
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)
UpdateQuery

Gets or sets the SqlDataSourceDesigner that supports update queries.

(Inherited from SqlDataSourceDesigner)
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)

Methods

Configure()

Launches the data source configuration utility in the design host.

(Inherited from SqlDataSourceDesigner)
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)
CreateView(String)

Creates a new SqlDesignerDataSourceView instance using the specified name.

(Inherited from SqlDataSourceDesigner)
CreateViewControl()

Returns a copy of the associated control for viewing or rendering on the design surface.

(Inherited from ControlDesigner)
DeriveParameters(String, DbCommand)

Derives the parameters from the specified SQL command and adds corresponding Parameter objects to the command's parameters collection.

(Inherited from SqlDataSourceDesigner)
Dispose()

Releases all resources used by the ComponentDesigner.

(Inherited from ComponentDesigner)
Dispose(Boolean)

Releases the unmanaged resources that are used by the HtmlControlDesigner object and optionally releases the managed resources.

(Inherited from HtmlControlDesigner)
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)
GetConnectionString()

Gets the connection string that is valid at design time for the control that is associated with this designer.

GetDesignTimeHtml()

Retrieves the HTML markup for displaying the associated data source control at design time.

(Inherited from DataSourceDesigner)
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()

Retrieves the HTML markup to represent a Web server control at design time that will have no visual representation at run time.

(Inherited from ControlDesigner)
GetErrorDesignTimeHtml(Exception)

Retrieves the HTML markup that provides information about the specified exception.

(Inherited from ControlDesigner)
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()

Retrieves the persistable inner HTML markup of the control.

(Inherited from ControlDesigner)
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)
GetView(String)

Retrieves a DesignerDataSourceView object that is identified by the view name.

(Inherited from SqlDataSourceDesigner)
GetViewNames()

Gets a list of available views.

(Inherited from SqlDataSourceDesigner)
GetViewRendering()

Retrieves an object that contains the design-time markup for the content and regions of the associated control.

(Inherited from ControlDesigner)
InferParameterNames(DesignerDataConnection, String, SqlDataSourceCommandType)

Returns an array of parameters using the specified connection, command text, and command type.

(Inherited from SqlDataSourceDesigner)
Initialize(IComponent)

Initializes the control designer and loads the specified component.

(Inherited from ControlDesigner)
InitializeExistingComponent(IDictionary)

Reinitializes an existing component.

(Inherited from ComponentDesigner)
InitializeNewComponent(IDictionary)

Initializes a newly created component.

(Inherited from ComponentDesigner)
InitializeNonDefault()

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)

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()

Called when a behavior disassociates from the element.

(Inherited from HtmlControlDesigner)
OnBindingsCollectionChanged(String)

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()

Called when the associated Web server control has been resized in the design host at design time.

(Inherited from ControlDesigner)
OnDataSourceChanged(EventArgs)

Raises the DataSourceChanged event when the properties of the data source have changed and the SuppressingDataSourceEvents value is false.

(Inherited from DataSourceDesigner)
OnPaint(PaintEventArgs)

Called when the control designer draws the associated control on the design surface, if the CustomPaint value is true.

(Inherited from ControlDesigner)
OnSchemaRefreshed(EventArgs)

Raises the SchemaRefreshed event when the schema of the data source has changed and the SuppressingDataSourceEvents value is false.

(Inherited from DataSourceDesigner)
OnSetComponentDefaults()

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 add properties to, or remove them from, 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()

Raises the OnControlResize() event.

(Inherited from ControlDesigner)
RefreshSchema(Boolean)

Refreshes the schema from the underlying data source.

(Inherited from SqlDataSourceDesigner)
RegisterClone(Object, Object)

Registers internal data in a cloned control.

(Inherited from ControlDesigner)
ResumeDataSourceEvents()

Restores data source events after the data source events have been suppressed.

(Inherited from DataSourceDesigner)
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)
SuppressDataSourceEvents()

Postpones all data source events until after the ResumeDataSourceEvents() method is called.

(Inherited from DataSourceDesigner)
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)

Events

DataSourceChanged

Occurs when any property of the associated data source changes.

(Inherited from DataSourceDesigner)
SchemaRefreshed

Occurs after the schema has been refreshed.

(Inherited from DataSourceDesigner)

Explicit Interface Implementations

IDesignerFilter.PostFilterAttributes(IDictionary)

For a description of this member, see the PostFilterAttributes(IDictionary) method.

(Inherited from ComponentDesigner)
IDesignerFilter.PostFilterEvents(IDictionary)

For a description of this member, see the PostFilterEvents(IDictionary) method.

(Inherited from ComponentDesigner)
IDesignerFilter.PostFilterProperties(IDictionary)

For a description of this member, see the PostFilterProperties(IDictionary) method.

(Inherited from ComponentDesigner)
IDesignerFilter.PreFilterAttributes(IDictionary)

For a description of this member, see the PreFilterAttributes(IDictionary) method.

(Inherited from ComponentDesigner)
IDesignerFilter.PreFilterEvents(IDictionary)

For a description of this member, see the PreFilterEvents(IDictionary) method.

(Inherited from ComponentDesigner)
IDesignerFilter.PreFilterProperties(IDictionary)

For a description of this member, see the PreFilterProperties(IDictionary) method.

(Inherited from ComponentDesigner)
ITreeDesigner.Children

For a description of this member, see the Children property.

(Inherited from ComponentDesigner)
ITreeDesigner.Parent

For a description of this member, see the Parent property.

(Inherited from ComponentDesigner)

Applies to

See also