EntityDataSource Class

Definition

Namespace:

System.Web.UI.WebControls

Assembly:

System.Web.Entity.dll

Represents an Entity Data Model (EDM) to data-bound controls in an ASP.NET application.

public ref class EntityDataSource : System::Web::UI::DataSourceControl, System::Web::DynamicData::IDynamicDataSource, System::Web::UI::WebControls::IQueryableDataSource

[System.Drawing.ToolboxBitmap(typeof(System.Web.UI.WebControls.EntityDataSource), "EntityDataSource.ico")]
public class EntityDataSource : System.Web.UI.DataSourceControl, System.Web.DynamicData.IDynamicDataSource, System.Web.UI.WebControls.IQueryableDataSource

[<System.Drawing.ToolboxBitmap(typeof(System.Web.UI.WebControls.EntityDataSource), "EntityDataSource.ico")>]
type EntityDataSource = class
    inherit DataSourceControl
    interface IDynamicDataSource
    interface IDataSource
    interface IQueryableDataSource

Public Class EntityDataSource
Inherits DataSourceControl
Implements IDynamicDataSource, IQueryableDataSource

Inheritance

Object

Control

DataSourceControl

EntityDataSource

Attributes

ToolboxBitmapAttribute

Implements

IDynamicDataSource IDataSource IQueryableDataSource

Remarks

In this topic:

• Introduction

• Declarative Syntax

Introduction

You can use the EntityDataSource control together with a data-bound control to retrieve data from an EDM and to display, edit, and sort data on a Web page by using little or no code. For more information, see EntityDataSource Web Server Control Overview.

Declarative Syntax

<asp:EntityDataSource
    AutoGenerateOrderByClause="True|False"
    AutoGenerateWhereClause="True|False"
    AutoPage="True|False"
    AutoSort="True|False"
    CommandText="string"
    ConnectionString="string"
    ContextType="typed ObjectContext"
    ContextTypeName="string"
    DefaultContainerName="string"
    EnableDelete="True|False"
    EnableInsert="True|False"
    EnableUpdate="True|False"
    EnableViewState="True|False"
    EntitySetName="string"
    EntityTypeFilter="string"
    GroupBy="string"
    Include="string"
    OnContextCreated="ContextCreated event handler"
    OnContextCreating="ContextCreating event handler"
    OnContextDisposing="ContextDisposing event handler"
    OnDataBinding="DataBinding event handler"
    OnDeleted="Deleted event handler"
    OnDeleting="Deleting event handler"
    OnException="IDynamicDataSource.Exception event handler"
    OnInserted="Inserted event handler"
    OnInserting="Inserting event handler"
    OnSelected="Selected event handler"
    OnSelecting="Selecting event handler"
    OnUpdated="Updated event handler"
    OnUpdating="Updating event handler"
    OrderBy="string"
    runat="server"
    Select="string"
    StoreOriginalValuesInViewState="True|False"
    Where="string"
>
        <CommandParameters />
        <DeleteParameters />
        <GroupByParameters />
        <InsertParameters />
        <OrderByParameters />
        <SelectParameters />
        <UpdateParameters />
        <WhereParameters />
</asp:EntityDataSource>

Constructors

EntityDataSource()	Initializes a new instance of the EntityDataSource class.
EntityDataSource(EntityConnection)	Initializes a new instance of the EntityDataSource class with the provided connection.

Properties

Adapter	Gets the browser-specific adapter for the control. (Inherited from Control)
AppRelativeTemplateSourceDirectory	Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control)
AutoGenerateOrderByClause	Gets or sets a value that indicates whether the EntityDataSource control dynamically creates an ORDER BY clause based on values in the OrderByParameters collection.
AutoGenerateWhereClause	Gets or sets a value that indicates whether the EntityDataSource control dynamically creates a WHERE clause based on values defined in the WhereParameters collection.
AutoPage	Gets or sets a value that indicates whether the EntityDataSource control supports navigation through sections of the data at run time.
AutoSort	Gets or sets a value that indicates whether the EntityDataSource control supports sorting the data at run time.
BindingContainer	Gets the control that contains this control's data binding. (Inherited from Control)
ChildControlsCreated	Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control)
ClientID	Gets the server control identifier generated by ASP.NET. (Inherited from DataSourceControl)
ClientIDMode	This property is not used for data source controls. (Inherited from DataSourceControl)
ClientIDSeparator	Gets a character value representing the separator character used in the ClientID property. (Inherited from Control)
CommandParameters	Gets the parameter collection for the query.
CommandText	Gets or sets an Entity SQL command that defines the query.
ConnectionString	Gets or sets the connection string that is used to execute the query.
Context	Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control)
ContextType	Gets or sets the typed ObjectContext used by the EntityDataSource control.
ContextTypeName	Gets or sets the fully qualified name of the typed ObjectContext that is used by the EntityDataSource control.
Controls	Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from DataSourceControl)
DataItemContainer	Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control)
DataKeysContainer	Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control)
DefaultContainerName	Gets or sets the default container name.
DeleteParameters	Gets the collection of parameters that are used during a delete operation.
DesignMode	Gets a value indicating whether a control is being used on a design surface. (Inherited from Control)
EnableDelete	Gets or sets a value that indicates whether objects can be deleted through the EntityDataSource control.
EnableFlattening	Gets or sets the value that indicates whether you want to turn off wrapper creation.
EnableInsert	Gets or sets a value that indicates whether objects can be added through the EntityDataSource control.
EnableTheming	Gets a value indicating whether this control supports themes. (Inherited from DataSourceControl)
EnableUpdate	Gets or sets a value that indicates whether objects can be modified through the EntityDataSource control.
EnableViewState	Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control)
EntitySetName	Gets or sets the name of the entity set used by the EntityDataSource control.
EntityTypeFilter	Gets or sets the expression that limits the query to only results of a specific derived type.
Events	Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control)
GroupBy	Gets or sets the Entity SQL expression that specifies how to group the query results.
HasChildViewState	Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control)
ID	Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control)
IdSeparator	Gets the character used to separate control identifiers. (Inherited from Control)
Include	Gets or sets the expression that specifies the related objects to include in the query results.
InsertParameters	Gets the collection of parameters that are used during an insert operation.
IsChildControlStateCleared	Gets a value indicating whether controls contained within this control have control state. (Inherited from Control)
IsTrackingViewState	Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control)
IsViewStateEnabled	Gets a value indicating whether view state is enabled for this control. (Inherited from Control)
LoadViewStateByID	Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control)
NamingContainer	Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control)
OrderBy	Gets or sets the Entity SQL expression that specifies how to order the query results.
OrderByParameters	Gets the collection of parameters that are used to create the ORDER BY clause.
Page	Gets a reference to the Page instance that contains the server control. (Inherited from Control)
Parent	Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control)
RenderingCompatibility	Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control)
Select	Gets or sets the projection that defines the properties to include in the query results.
SelectParameters	Gets the collection of parameters that are used to create the projection.
Site	Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control)
SkinID	Gets the skin to apply to the DataSourceControl control. (Inherited from DataSourceControl)
StoreOriginalValuesInViewState	Gets or sets a value that indicates whether the data from the data source should be stored in view state to make sure that the data has not been changed by another process before it is updated or deleted.
TemplateControl	Gets or sets a reference to the template that contains this control. (Inherited from Control)
TemplateSourceDirectory	Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control)
UniqueID	Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control)
UpdateParameters	Gets the collection of parameters that are used during an update operation.
ValidateRequestMode	Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control)
ViewState	Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control)
ViewStateIgnoresCase	Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control)
ViewStateMode	Gets or sets the view-state mode of this control. (Inherited from Control)
Visible	Gets or sets a value indicating whether the control is visually displayed. (Inherited from DataSourceControl)
Where	Gets or sets the Entity SQL expression that specifies how to filter the query results.
WhereParameters	Gets the collection of parameters that are used to create the WHERE clause.

Methods

AddedControl(Control, Int32)	Called after a child control is added to the Controls collection of the Control object. (Inherited from Control)
AddParsedSubObject(Object)	Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control)
ApplyStyleSheetSkin(Page)	Applies the style properties that are defined in the page style sheet to the control. (Inherited from DataSourceControl)
BeginRenderTracing(TextWriter, Object)	Begins design-time tracing of rendering data. (Inherited from Control)
BuildProfileTree(String, Boolean)	Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control)
ClearCachedClientID()	Sets the cached ClientID value to null. (Inherited from Control)
ClearChildControlState()	Deletes the control-state information for the server control's child controls. (Inherited from Control)
ClearChildState()	Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control)
ClearChildViewState()	Deletes the view-state information for all the server control's child controls. (Inherited from Control)
ClearEffectiveClientIDMode()	Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control)
CreateChildControls()	Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Control)
CreateControlCollection()	Creates a collection to store child controls. (Inherited from DataSourceControl)
CreateView()	Creates a new instance of the EntityDataSourceView that is associated with this control.
DataBind()	Binds a data source to the invoked server control and all its child controls. (Inherited from Control)
DataBind(Boolean)	Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control)
DataBindChildren()	Binds a data source to the server control's child controls. (Inherited from Control)
Dispose()	Enables a server control to perform final clean up before it is released from memory. (Inherited from Control)
EndRenderTracing(TextWriter, Object)	Ends design-time tracing of rendering data. (Inherited from Control)
EnsureChildControls()	Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control)
EnsureID()	Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FindControl(String, Int32)	Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control)
FindControl(String)	Searches the current naming container for a server control with the specified id parameter. (Inherited from DataSourceControl)
Focus()	Sets input focus to the control. (Inherited from DataSourceControl)
GetDesignModeState()	Gets design-time data for a control. (Inherited from Control)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetRouteUrl(Object)	Gets the URL that corresponds to a set of route parameters. (Inherited from Control)
GetRouteUrl(RouteValueDictionary)	Gets the URL that corresponds to a set of route parameters. (Inherited from Control)
GetRouteUrl(String, Object)	Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control)
GetRouteUrl(String, RouteValueDictionary)	Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetUniqueIDRelativeTo(Control)	Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control)
GetView(String)	Gets the named data source view that is associated with the data source control.
GetViewNames()	Gets a collection of names representing the list of view objects that are associated with the EntityDataSource control.
HasControls()	Determines if the server control contains any child controls. (Inherited from DataSourceControl)
HasEvents()	Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control)
IsLiteralContent()	Determines if the server control holds only literal content. (Inherited from Control)
LoadControlState(Object)	Loads the state of the properties in the EntityDataSource control that need to be persisted.
LoadViewState(Object)	Restores view-state information from a previous page request that was saved by the SaveViewState() method. (Inherited from Control)
MapPathSecure(String)	Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnBubbleEvent(Object, EventArgs)	Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control)
OnDataBinding(EventArgs)	Raises the DataBinding event. (Inherited from Control)
OnInit(EventArgs)	Adds a LoadComplete event handler to the Page control that contains the EntityDataSource control.
OnLoad(EventArgs)	Raises the Load event. (Inherited from Control)
OnPreRender(EventArgs)	Raises the PreRender event. (Inherited from Control)
OnUnload(EventArgs)	Raises the Unload event.
OpenFile(String)	Gets a Stream used to read a file. (Inherited from Control)
RaiseBubbleEvent(Object, EventArgs)	Assigns any sources of the event and its information to the control's parent. (Inherited from Control)
RaiseDataSourceChangedEvent(EventArgs)	Raises the DataSourceChanged event. (Inherited from DataSourceControl)
RemovedControl(Control)	Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control)
Render(HtmlTextWriter)	Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control)
RenderChildren(HtmlTextWriter)	Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control)
RenderControl(HtmlTextWriter, ControlAdapter)	Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control)
RenderControl(HtmlTextWriter)	Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from DataSourceControl)
ResolveAdapter()	Gets the control adapter responsible for rendering the specified control. (Inherited from Control)
ResolveClientUrl(String)	Gets a URL that can be used by the browser. (Inherited from Control)
ResolveUrl(String)	Converts a URL into one that is usable on the requesting client. (Inherited from Control)
SaveControlState()	Saves the state of the properties in the EntityDataSource control that need to be persisted.
SaveViewState()	Saves any server control view-state changes that have occurred since the time the page was posted back to the server. (Inherited from Control)
SetDesignModeState(IDictionary)	Sets design-time data for a control. (Inherited from Control)
SetRenderMethodDelegate(RenderMethod)	Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control)
SetTraceData(Object, Object, Object)	Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. (Inherited from Control)
SetTraceData(Object, Object)	Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. (Inherited from Control)
ToString()	Returns a string that represents the current object. (Inherited from Object)
TrackViewState()	Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. This object is accessible through the ViewState property.

Events

ContextCreated	Occurs when the EntityDataSource has finished creating the ObjectContext that is used to work with entity data objects.
ContextCreating	Occurs when the EntityDataSource creates the ObjectContext that is used to work with entity data objects.
ContextDisposing	Occurs before an ObjectContext is disposed of.
DataBinding	Occurs when the server control binds to a data source. (Inherited from Control)
Deleted	Occurs after an object has been deleted from the data source.
Deleting	Occurs before an object is deleted from the data source.
Disposed	Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control)
Init	Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control)
Inserted	Occurs after a new object is created at the data source.
Inserting	Occurs before a new object is persisted to the data source.
Load	Occurs when the server control is loaded into the Page object. (Inherited from Control)
PreRender	Occurs after the Control object is loaded but prior to rendering. (Inherited from Control)
QueryCreated	Occurs after the EntityDataSource creates an Entity SQL query that was specified during the configuration of the EntityDataSource control.
Selected	Occurs after a query has been executed.
Selecting	Occurs before a query is constructed and executed.
Unload	Occurs when the server control is unloaded from memory. (Inherited from Control)
Updated	Occurs after changes to an object have been persisted to the data source.
Updating	Occurs before changes to an object are persisted to the data source.

Explicit Interface Implementations

IControlBuilderAccessor.ControlBuilder	For a description of this member, see ControlBuilder. (Inherited from Control)
IControlDesignerAccessor.GetDesignModeState()	For a description of this member, see GetDesignModeState(). (Inherited from Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary)	For a description of this member, see SetDesignModeState(IDictionary). (Inherited from Control)
IControlDesignerAccessor.SetOwnerControl(Control)	For a description of this member, see SetOwnerControl(Control). (Inherited from Control)
IControlDesignerAccessor.UserData	For a description of this member, see UserData. (Inherited from Control)
IDataBindingsAccessor.DataBindings	For a description of this member, see DataBindings. (Inherited from Control)
IDataBindingsAccessor.HasDataBindings	For a description of this member, see HasDataBindings. (Inherited from Control)
IDataSource.DataSourceChanged	Occurs when a data source control has changed in a way that affects data-bound controls. (Inherited from DataSourceControl)
IDataSource.GetView(String)	Gets the named DataSourceView object associated with the DataSourceControl control. Some data source controls support only one view, while others support more than one. (Inherited from DataSourceControl)
IDataSource.GetViewNames()	Gets a collection of names, representing the list of DataSourceView objects associated with the DataSourceControl control. (Inherited from DataSourceControl)
IDynamicDataSource.Exception	Occurs when validation fails in a partial methods or when an exception is raised.
IExpressionsAccessor.Expressions	For a description of this member, see Expressions. (Inherited from Control)
IExpressionsAccessor.HasExpressions	For a description of this member, see HasExpressions. (Inherited from Control)
IListSource.ContainsListCollection	Indicates whether the data source control is associated with one or more lists of data. (Inherited from DataSourceControl)
IListSource.GetList()	Gets a list of data source controls that can be used as sources of lists of data. (Inherited from DataSourceControl)
IParserAccessor.AddParsedSubObject(Object)	For a description of this member, see AddParsedSubObject(Object). (Inherited from Control)
IQueryableDataSource.RaiseViewChanged()	Notifies the data-bound control that a parameter object has changed and the data-bound control needs to refresh.

Extension Methods

ExpandDynamicWhereParameters(IDynamicDataSource)	Expands dynamic filters into Where parameters that are usable by the data source.
FindDataSourceControl(Control)	Returns the data source that is associated with the data control for the specified control.
FindFieldTemplate(Control, String)	Returns the field template for the specified column in the specified control's naming container.
FindMetaTable(Control)	Returns the metatable object for the containing data control.
GetDefaultValues(IDataSource)	Gets the collection of the default values for the specified data source.
GetMetaTable(IDataSource)	Gets the metadata for a table in the specified data source object.
GetTable(IDynamicDataSource)	Returns the MetaTable object that is associated with the specified data source control.
TryGetMetaTable(IDataSource, MetaTable)	Determines whether table metadata is available.

See also

• Entity Framework overview
• Working with Objects