Click or drag to resize

LLBLGenProDataSource Class

General data source control which can be used in ASP.NET projects to perform design time databinding and runtime databinding.
Inheritance Hierarchy

Namespace:  SD.LLBLGen.Pro.ORMSupportClasses
Assembly:  SD.LLBLGen.Pro.ORMSupportClasses.Web (in SD.LLBLGen.Pro.ORMSupportClasses.Web.dll) Version: 5.10.0.0 (5.10.0)
Syntax
[ToolboxBitmapAttribute(typeof(LLBLGenProDataSource), "ToolBoxImage.ico")]
[DefaultEventAttribute("PerformSelect")]
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public class LLBLGenProDataSource : LLBLGenProDataSourceBase

The LLBLGenProDataSource type exposes the following members.

Constructors
  NameDescription
Public methodLLBLGenProDataSource
Initializes a new instance of the LLBLGenProDataSource2 class.
Top
Properties
  NameDescription
Protected propertyAdapter
Gets the browser-specific adapter for the control.
(Inherited from Control.)
Public propertyAllFieldsKeepEmptyStringAsValue
Gets / sets the allFieldsKeepEmptyStringAsValue value. Setting this parameter to true will disable FieldNamesKeepEmptyStringAsValue. Default: false.
(Inherited from LLBLGenProDataSourceBase.)
Public propertyAllowDuplicates
Gets or sets if the DataSourceControl should allow duplicate instances in the data retrieved. If DataContainerType is set to EntityCollection, this setting is ignored, as entitycollection fetches always filter out duplicates.
(Inherited from LLBLGenProDataSourceBase.)
Public propertyAppRelativeTemplateSourceDirectory
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
(Inherited from Control.)
Public propertyASPNetCacheDuration
Gets or sets the duration in minutes the state data is stored in the ASP.NET cache in between page postbacks. Only valid if CacheLocation is set to ASPNetCache.
(Inherited from LLBLGenProDataSourceBase.)
Public propertyBindingContainer
Gets the control that contains this control's data binding.
(Inherited from Control.)
Public propertyCacheLocation
Gets or sets the location where to store loaded data. Default is Viewstate.
(Inherited from LLBLGenProDataSourceBase.)
Protected propertyChildControlsCreated
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from Control.)
Public propertyClientID
Gets the server control identifier generated by ASP.NET.
(Inherited from DataSourceControl.)
Public propertyClientIDMode
This property is not used for data source controls.
(Inherited from DataSourceControl.)
Protected propertyClientIDSeparator
Gets a character value representing the separator character used in the ClientID property.
(Inherited from Control.)
Protected propertyContext
Gets the HttpContext object associated with the server control for the current Web request.
(Inherited from Control.)
Public propertyControls
Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from DataSourceControl.)
Public propertyDataContainerType
Gets or sets the type of the data container which contains the data inside this datasource control.
(Inherited from LLBLGenProDataSourceBase.)
Public propertyDataItemContainer
Gets a reference to the naming container if the naming container implements IDataItemContainer.
(Inherited from Control.)
Public propertyDataKeysContainer
Gets a reference to the naming container if the naming container implements IDataKeysControl.
(Inherited from Control.)
Protected propertyDesignMode
Gets a value indicating whether a control is being used on a design surface.
(Inherited from Control.)
Public propertyEnablePaging
Gets or sets whether Paging is enabled on this control. Default is false. If you're using paging in a bound control, be sure to set this property to true so the LLBLGenProDataSourceControl will perform server-side paging instead of loading everything in memory and leave the paging to the bound control.
(Inherited from LLBLGenProDataSourceBase.)
Public propertyEnableTheming
Gets a value indicating whether this control supports themes.
(Inherited from DataSourceControl.)
Public propertyEnableViewState
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.)
Public propertyEntityCollection
Gets or sets the entity collection contained in this object. Only valid if DataContainerType is set to EntityCollection.
Public propertyEntityCollectionTypeName
Gets or sets the name of the entity collection. Only valid if DataContainerType is set to EntityCollection
Protected propertyEvents
Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from Control.)
Public propertyFieldNamesKeepEmptyStringAsValue
Gets / sets the list of fieldnames for which "" is a valid value and which shouldn't be converted to null.
(Inherited from LLBLGenProDataSourceBase.)
Public propertyFilterToUse
Gets or sets the filter to use.
Public propertyGroupBy
Gets or sets the GroupByCollection to use. Only valid if DataContainerType is set to TypedList or TypedView
Public propertyGroupByToUse
Gets or sets the GroupByCollection to use. Only valid if DataContainerType is set to TypedList or TypedView
(Inherited from LLBLGenProDataSourceBase.)
Protected propertyHasChildViewState
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from Control.)
Public propertyID
Gets or sets the programmatic identifier assigned to the server control.
(Inherited from Control.)
Protected propertyIdSeparator
Gets the character used to separate control identifiers.
(Inherited from Control.)
Protected propertyIgnoreNullValuedSelectParameters
Gets or sets a value indicating whether select parameters which have the value null should be ignored (true) or not (false, default)
(Inherited from LLBLGenProDataSourceBase.)
Public propertyInsertParameters
Parameters which are used to construct a PredicateExpression for live filtering. Hook up control properties or other parameters with the datasource so the datasource can filter based on values in other controls.
(Inherited from LLBLGenProDataSourceBase.)
Protected propertyIsChildControlStateCleared
Gets a value indicating whether controls contained within this control have control state.
(Inherited from Control.)
Protected propertyIsTrackingViewState
Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from Control.)
Protected propertyIsViewStateEnabled
Gets a value indicating whether view state is enabled for this control.
(Inherited from Control.)
Public propertyLivePersistence
Gets or sets the value for LivePersistence, a flag which is used to determine whether fetches for data changes on the data (insert/update/delete) have to be propagated to the database directly (true) or have to be added to a UnitOfWork object (false). Default is true.
(Inherited from LLBLGenProDataSourceBase.)
Protected propertyLoadViewStateByID
Gets a value indicating whether the control participates in loading its view state by ID instead of index.
(Inherited from Control.)
Public propertyMaxNumberOfItemsToReturn
Gets or sets the maximum number of items to return. Is ignored if EnablePaging is specified.
(Inherited from LLBLGenProDataSourceBase.)
Public propertyNamingContainer
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.)
Public propertyPage
Gets a reference to the Page instance that contains the server control.
(Inherited from Control.)
Public propertyParent
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from Control.)
Public propertyPrefetchPathToUse
Gets or sets the PrefetchPath to use. Only valid if DataContainerType is set to EntityCollection
Public propertyRefetch
Gets / sets the flag whether the control should refetch the data at the next select call from the bound control(s). Set this flag to true when you've persisted the embedded UnitOfWork object. This will also clear the unitofwork object on the next select.
Public propertyRelationsToUse
Gets or sets the relations to use.
Public propertyRenderingCompatibility
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
(Inherited from Control.)
Public propertySelectParameters
Parameters which are used to construct a PredicateExpression for live filtering. Hook up control properties or other parameters with the datasource so the datasource can filter based on values in other controls.
(Inherited from LLBLGenProDataSourceBase.)
Public propertySite
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from Control.)
Public propertySkinID
Gets the skin to apply to the DataSourceControl control.
(Inherited from DataSourceControl.)
Public propertySorterToUse
Gets or sets the SortExpression to use.
(Inherited from LLBLGenProDataSourceBase.)
Public propertySortingMode
Gets / sets the sortingmode.
(Inherited from LLBLGenProDataSourceBase.)
Public propertyTemplateControl
Gets or sets a reference to the template that contains this control.
(Inherited from Control.)
Public propertyTemplateSourceDirectory
Gets the virtual directory of the Page or UserControl that contains the current server control.
(Inherited from Control.)
Public propertyThrowExceptionOnIllegalFieldInput
Gets or sets the flag which signals this datasource control when setting fields to new values it should throw an exception if one or more field values in the input are illegal and can't be converted to the field's .NET type.
(Inherited from LLBLGenProDataSourceBase.)
Public propertyTotalRowCount
Gets the total row count for the last query executed. Only valid if the query is a paging query and the datasource is ordered to obtain the total row count by the bound control.
(Inherited from LLBLGenProDataSourceBase.)
Public propertyTypedList
Gets or sets the typed list contained in this object. Only valid if DataContainerType is set to TypedList.
Public propertyTypedListTypeName
Gets or sets the name of the typed list type. Only valid if DataContainerType is set to TypedList
Public propertyTypedView
Gets or sets the typed view contained in this object. Only valid if DataContainerType is set to TypedView.
Public propertyTypedViewTypeName
Gets or sets the name of the typed view type. Only valid if DataContainerType is set to TypedView
Public propertyUniqueID
Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from Control.)
Public propertyUnitOfWorkObject
Gets the UnitOfWork object used by this control. Not defined if LivePersistence is set to true.
Public propertyUpdateParameters
Parameters which are used to construct a PredicateExpression for live filtering. Hook up control properties or other parameters with the datasource so the datasource can filter based on values in other controls.
(Inherited from LLBLGenProDataSourceBase.)
Public propertyValidateRequestMode
Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.
(Inherited from Control.)
Protected propertyViewState
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.)
Protected propertyViewStateIgnoresCase
Gets a value that indicates whether the StateBag object is case-insensitive.
(Inherited from Control.)
Public propertyViewStateMode
Gets or sets the view-state mode of this control.
(Inherited from Control.)
Public propertyVisible
Gets or sets a value indicating whether the control is visually displayed.
(Inherited from DataSourceControl.)
Top
Methods
  NameDescription
Protected methodAddedControl
Called after a child control is added to the Controls collection of the Control object.
(Inherited from Control.)
Protected methodAddParsedSubObject
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.)
Public methodApplyStyleSheetSkin
Applies the style properties that are defined in the page style sheet to the control.
(Inherited from DataSourceControl.)
Protected methodBeginRenderTracing
Begins design-time tracing of rendering data.
(Inherited from Control.)
Protected methodBuildProfileTree
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.)
Protected methodClearCachedClientID
Sets the cached ClientID value to null.
(Inherited from Control.)
Protected methodClearChildControlState
Deletes the control-state information for the server control's child controls.
(Inherited from Control.)
Protected methodClearChildState
Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from Control.)
Protected methodClearChildViewState
Deletes the view-state information for all the server control's child controls.
(Inherited from Control.)
Protected methodClearEffectiveClientIDMode
Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.
(Inherited from Control.)
Protected methodCreateChildControls
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.)
Protected methodCreateControlCollection
Creates a collection to store child controls.
(Inherited from DataSourceControl.)
Protected methodCreateStateDataObject
Creates the state data object.
(Inherited from LLBLGenProDataSourceBase.)
Public methodDataBind
Binds a data source to the invoked server control and all its child controls.
(Inherited from Control.)
Protected methodDataBind(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.)
Protected methodDataBindChildren
Binds a data source to the server control's child controls.
(Inherited from Control.)
Public methodDispose
Enables a server control to perform final clean up before it is released from memory.
(Inherited from Control.)
Protected methodEndRenderTracing
Ends design-time tracing of rendering data.
(Inherited from Control.)
Protected methodEnsureChildControls
Determines whether the server control contains child controls. If it does not, it creates child controls.
(Inherited from Control.)
Protected methodEnsureID
Creates an identifier for controls that do not have an identifier assigned.
(Inherited from Control.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindControl(String)
Searches the current naming container for a server control with the specified id parameter.
(Inherited from DataSourceControl.)
Protected methodFindControl(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.)
Public methodFocus
Sets input focus to the control.
(Inherited from DataSourceControl.)
Protected methodGetDesignModeState
Gets design-time data for a control.
(Inherited from Control.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetRouteUrl(Object)
Gets the URL that corresponds to a set of route parameters.
(Inherited from Control.)
Public methodGetRouteUrl(RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters.
(Inherited from Control.)
Public methodGetRouteUrl(String, Object)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from Control.)
Public methodGetRouteUrl(String, RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from Control.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUniqueIDRelativeTo
Returns the prefixed portion of the UniqueID property of the specified control.
(Inherited from Control.)
Protected methodGetView
Gets the view.
(Overrides LLBLGenProDataSourceBaseGetView.)
Protected methodGetView(String)
Gets the named data source view associated with the data source control.
(Inherited from LLBLGenProDataSourceBase.)
Protected methodGetViewNames
Gets a collection of names, representing the list of DataSourceView objects associated with the DataSourceControl control.
(Inherited from LLBLGenProDataSourceBase.)
Public methodHasControls
Determines if the server control contains any child controls.
(Inherited from DataSourceControl.)
Protected methodHasEvents
Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from Control.)
Protected methodInitClass
Inits the class
(Inherited from LLBLGenProDataSourceBase.)
Protected methodIsLiteralContent
Determines if the server control holds only literal content.
(Inherited from Control.)
Protected methodLoadControlState
Restores control-state information from a previous page request that was saved by the SaveControlState method.
(Inherited from LLBLGenProDataSourceBase.)
Protected methodLoadViewState
Restores view-state information from a previous page request that was saved by the SaveViewState method.
(Inherited from LLBLGenProDataSourceBase.)
Protected methodMapPathSecure
Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from Control.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnBubbleEvent
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from Control.)
Protected methodOnDataBinding
Raises the DataBinding event.
(Inherited from Control.)
Protected methodOnInit
Raises the Init event.
(Inherited from LLBLGenProDataSourceBase.)
Protected methodOnLoad
Raises the Load event.
(Inherited from Control.)
Protected methodOnPreRender
Raises the PreRender event.
(Inherited from Control.)
Protected methodOnUnload
Raises the Unload event.
(Inherited from Control.)
Protected methodOpenFile
Gets a Stream used to read a file.
(Inherited from Control.)
Protected methodRaiseBubbleEvent
Assigns any sources of the event and its information to the control's parent.
(Inherited from Control.)
Protected methodRaiseDataSourceChangedEvent
Raises the DataSourceChanged event.
(Inherited from DataSourceControl.)
Protected methodRemovedControl
Called after a child control is removed from the Controls collection of the Control object.
(Inherited from Control.)
Protected methodRender
Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
(Inherited from Control.)
Protected methodRenderChildren
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.)
Public methodRenderControl(HtmlTextWriter)
Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
(Inherited from DataSourceControl.)
Protected methodRenderControl(HtmlTextWriter, ControlAdapter)
Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.
(Inherited from Control.)
Protected methodResolveAdapter
Gets the control adapter responsible for rendering the specified control.
(Inherited from Control.)
Public methodResolveClientUrl
Gets a URL that can be used by the browser.
(Inherited from Control.)
Public methodResolveUrl
Converts a URL into one that is usable on the requesting client.
(Inherited from Control.)
Protected methodSaveControlState
Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Inherited from LLBLGenProDataSourceBase.)
Protected methodSaveViewState
Saves any server control view-state changes that have occurred since the time the page was posted back to the server.
(Inherited from LLBLGenProDataSourceBase.)
Public methodSelect
Selects data from the underlying storage using the parameters set. You don't need to call this method if you've setup databinding using DataSourceID values.
(Inherited from LLBLGenProDataSourceBase.)
Protected methodSetDesignModeState
Sets design-time data for a control.
(Inherited from Control.)
Public methodSetRenderMethodDelegate
Assigns an event handler delegate to render the server control and its content into its parent control.
(Inherited from Control.)
Public methodSetTraceData(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.)
Public methodSetTraceData(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.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodTrackViewState
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.
(Inherited from LLBLGenProDataSourceBase.)
Top
Events
  NameDescription
Public eventDataBinding
Occurs when the server control binds to a data source.
(Inherited from Control.)
Public eventDisposed
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.)
Public eventElementsFetched
Event which is raised when LivePersistence is set to true and the datasource control has performed a fetch of elements (be it entities, a typed list or a typedview). Use this event to be able to perform actions when a fetch takes place. The sender of the event is the datasource control so use that object to obtain the data fetched.
(Inherited from LLBLGenProDataSourceBase.)
Public eventEntityDeleted
Event which is raised when LivePersistence is set to true and an entity was deleted successfully. The deleted entity is part of the event args.
(Inherited from LLBLGenProDataSourceBase.)
Public eventEntityDeleting
Event which is raised when this datasource control is about to perform the delete action on an entity. If LivePersistence is set to false, this event is raised right before the entity to delete is added to the unitofwork(2) object. Cancelling this event will abort the delete action and the entity won't be inserted. The entity to delete is part of the event args.
(Inherited from LLBLGenProDataSourceBase.)
Public eventEntityInserted
Event which is raised when LivePersistence is set to true and an entity was inserted successfully. The inserted entity is part of the event args.
(Inherited from LLBLGenProDataSourceBase.)
Public eventEntityInserting
Event which is raised when this datasource control is about to perform the Insert action on an entity. If LivePersistence is set to false, this event is raised right before the entity to insert is added to the unitofwork(2) object. Cancelling this event will abort the insert action and the entity won't be inserted. The entity to insert is part of the event args.
(Inherited from LLBLGenProDataSourceBase.)
Public eventEntityUpdated
Event which is raised when LivePersistence is set to true and an entity was updated successfully. The updated entity is part of the event args.
(Inherited from LLBLGenProDataSourceBase.)
Public eventEntityUpdating
Event which is raised when this datasource control is about to perform the update action on an entity. If LivePersistence is set to false, this event is raised right before the entity to update is added to the unitofwork(2) object. Cancelling this event will abort the update action and the entity won't be inserted. The entity to update is part of the event args.
(Inherited from LLBLGenProDataSourceBase.)
Public eventInit
Occurs when the server control is initialized, which is the first step in its lifecycle.
(Inherited from Control.)
Public eventLoad
Occurs when the server control is loaded into the Page object.
(Inherited from Control.)
Public eventPerformGetDbCount
Event which is raised when LivePersistence is set to false and a GetDbCount has to be performed.
Public eventPerformSelect
Event which is raised when LivePersistence is set to false and a select has to be performed.
Public eventPerformWork
Event which is raised when LivePersistence is set to false and an insert/update/delete has to be performed.
Public eventPreRender
Occurs after the Control object is loaded but prior to rendering.
(Inherited from Control.)
Public eventUnload
Occurs when the server control is unloaded from memory.
(Inherited from Control.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIParserAccessorAddParsedSubObject
For a description of this member, see AddParsedSubObject(Object).
(Inherited from Control.)
Explicit interface implementationPrivate propertyIListSourceContainsListCollection
Indicates whether the data source control is associated with one or more lists of data.
(Inherited from DataSourceControl.)
Explicit interface implementationPrivate propertyIControlBuilderAccessorControlBuilder
For a description of this member, see ControlBuilder.
(Inherited from Control.)
Explicit interface implementationPrivate propertyIDataBindingsAccessorDataBindings
For a description of this member, see DataBindings.
(Inherited from Control.)
Explicit interface implementationPrivate eventIDataSourceDataSourceChanged
Occurs when a data source control has changed in a way that affects data-bound controls.
(Inherited from DataSourceControl.)
Explicit interface implementationPrivate propertyIExpressionsAccessorExpressions
For a description of this member, see Expressions.
(Inherited from Control.)
Explicit interface implementationPrivate methodIControlDesignerAccessorGetDesignModeState (Inherited from Control.)
Explicit interface implementationPrivate methodIListSourceGetList
Gets a list of data source controls that can be used as sources of lists of data.
(Inherited from DataSourceControl.)
Explicit interface implementationPrivate methodIDataSourceGetView
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.)
Explicit interface implementationPrivate methodIDataSourceGetViewNames
Gets a collection of names, representing the list of DataSourceView objects associated with the DataSourceControl control.
(Inherited from DataSourceControl.)
Explicit interface implementationPrivate propertyIDataBindingsAccessorHasDataBindings
For a description of this member, see HasDataBindings.
(Inherited from Control.)
Explicit interface implementationPrivate propertyIExpressionsAccessorHasExpressions
For a description of this member, see HasExpressions.
(Inherited from Control.)
Explicit interface implementationPrivate methodIControlDesignerAccessorSetDesignModeState
For a description of this member, see SetDesignModeState(IDictionary).
(Inherited from Control.)
Explicit interface implementationPrivate methodIControlDesignerAccessorSetOwnerControl
For a description of this member, see SetOwnerControl(Control).
(Inherited from Control.)
Explicit interface implementationPrivate propertyIControlDesignerAccessorUserData
For a description of this member, see UserData.
(Inherited from Control.)
Top
Remarks
SelfServicing specific
See Also