Introduction
Knowledge Base
API Reference / Server-side / Telerik.Web.UI / RadClientDataSource
New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

RadClientDataSource

Class

This partial class defines RadClientDataSource control - a flexible and extensible server-side component for retrieving and providing data on the client under various forms and from different source such web and rest service, page method, other datasource controls and other means

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:
C#
[RequiredScript(typeof(jQueryPlugins))]
[RequiredScript(typeof(Html5Data))]
[ClientScriptResource("Telerik.Web.UI.RadClientDataSource", "Telerik.Web.UI.ClientDataSource.RadClientDataSourceScripts.js")]
[ToolboxBitmap(typeof(RadClientDataSource), "Toolbox.Icons.ClientDataSource.png")]
[TelerikToolboxCategory("Data")]
public class RadClientDataSource : Control, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IScriptControl, IControl, IControlResolver, IPostBackDataHandler, ICallbackEventHandler

Inheritance: objectControlRadClientDataSource

Derived Classes: WebServiceClientDataSource

Implements: ICallbackEventHandlerIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIPostBackDataHandlerIScriptControlIUrlResolutionService...

Inherited Members Control.ResolveAdapter()Control.HasEvents()Control.GetRouteUrl(object)Control.GetRouteUrl(string, object)Control.GetRouteUrl(RouteValueDictionary)Control.GetRouteUrl(string, RouteValueDictionary)Control.GetUniqueIDRelativeTo(Control)Control.ApplyStyleSheetSkin(Page)Control.OnDataBinding(EventArgs)Control.DataBind()Control.DataBind(bool)Control.DataBindChildren()Control.AddParsedSubObject(object)Control.EnsureID()Control.ClearChildState()Control.ClearChildControlState()Control.ClearChildViewState()Control.ClearEffectiveClientIDMode()Control.ClearCachedClientID()Control.Focus()Control.LoadControlState(object)Control.MapPathSecure(string)Control.OpenFile(string)Control.OnLoad(EventArgs)Control.BuildProfileTree(string, bool)Control.SaveControlState()Control.RenderChildren(HtmlTextWriter)Control.RenderControl(HtmlTextWriter)Control.RenderControl(HtmlTextWriter, ControlAdapter)Control.OnUnload(EventArgs)Control.Dispose()Control.RaiseBubbleEvent(object, EventArgs)Control.OnBubbleEvent(object, EventArgs)Control.AddedControl(Control, int)Control.CreateControlCollection()Control.CreateChildControls()Control.ResolveUrl(string)Control.ResolveClientUrl(string)Control.FindControl(string)Control.FindControl(string, int)Control.GetDesignModeState()Control.HasControls()Control.IsLiteralContent()Control.EnsureChildControls()Control.RemovedControl(Control)Control.SetDesignModeState(IDictionary)Control.SetRenderMethodDelegate(RenderMethod)Control.ClientIDModeControl.ClientIDControl.ClientIDSeparatorControl.ContextControl.AdapterControl.DesignModeControl.EventsControl.IDControl.EnableThemingControl.IsChildControlStateClearedControl.SkinIDControl.EnableViewStateControl.ViewStateModeControl.IsViewStateEnabledControl.NamingContainerControl.IdSeparatorControl.LoadViewStateByIDControl.PageControl.RenderingCompatibilityControl.TemplateControlControl.ParentControl.TemplateSourceDirectoryControl.AppRelativeTemplateSourceDirectoryControl.SiteControl.VisibleControl.UniqueIDControl.HasChildViewStateControl.ControlsControl.ValidateRequestModeControl.ViewStateControl.ViewStateIgnoresCaseControl.ChildControlsCreatedControl.IsTrackingViewStateControl.DisposedControl.DataBindingControl.InitControl.LoadControl.PreRenderControl.Unloadobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

RadClientDataSource()

C#
public RadClientDataSource()

Properties

Aggregates

Gets a collection of aggregates expressions for RadClientDataSource

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual ClientDataSourceAggregatesCollection Aggregates { get; }

AllowBatchOperations

Gets or sets a value indicating whether batch operations in the RadClientDataSource are enabled

        The default is false.
C#
public virtual bool AllowBatchOperations { get; set; }

AllowPaging

Gets or sets a value indicating whether the paging in RadClientDataSource is enabled

        The default is false.
C#
public virtual bool AllowPaging { get; set; }

AutoSync

Gets or sets a value indicating whether the RadClientDataSource would automatically save any changed data items by calling the sync method. By default changes are not automatically saved.

        The default is false.
C#
public virtual bool AutoSync { get; set; }

ClientEvents

Gets a reference to ClientDataSourceClientEvents class.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public ClientDataSourceClientEvents ClientEvents { get; }

CurrentPageIndex

Gets or sets a value indicating the index of the currente page

C#
[Bindable(true)]
[Browsable(false)]
public int CurrentPageIndex { get; set; }
Property Value:

The index of the current page.

DataSource

Contains settings about the different types of data sources used in RadClientDataSource.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual ClientDataSourceSettings DataSource { get; }

EnableServerAggregates

Gets or sets value indicating whether server-side aggregates are enabled

C#
public virtual bool EnableServerAggregates { get; set; }

EnableServerFiltering

Gets or sets value indicating whether server-side filtering is enabled

C#
public virtual bool EnableServerFiltering { get; set; }

EnableServerGrouping

Gets or sets value indicating whether server-side grouping is enabled

C#
public virtual bool EnableServerGrouping { get; set; }

EnableServerPaging

Gets or sets value indicating whether server-side paging is enabled

C#
public virtual bool EnableServerPaging { get; set; }

EnableServerSorting

Gets or sets value indicating whether server-side sorting is enabled

C#
public virtual bool EnableServerSorting { get; set; }

FilterExpression

Gets a collection of filter expressions for RadClientDataSource

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual ClientDataSourceFilterExpression FilterExpression { get; }

GroupExpressions

Gets a collection of group expressions for RadClientDataSource

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual ClientDataSourceGroupExpressionCollection GroupExpressions { get; }

PageSize

Gets or sets the maximum number of items that would appear on a page. Default value is 10.

C#
public virtual int PageSize { get; set; }

RegisterWithScriptManager

Gets or sets the value, indicating whether to register with the ScriptManager control on the page.

C#
public virtual bool RegisterWithScriptManager { get; set; }

Implements: IControl.RegisterWithScriptManager

If RegisterWithScriptManager is set to false the control can be rendered on the page using Web Services or normal callback requests/page methods.

Schema

Contains settings about the schema and model of the data used in RadClientDataSource.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual ClientDataSourceSchema Schema { get; }

SortExpressions

Gets a collection of sort expressions for RadClientDataSource

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual ClientDataSourceSortExpressionCollection SortExpressions { get; }

Methods

DescribeEvent(IScriptDescriptor, string, string)

C#
protected void DescribeEvent(IScriptDescriptor descriptor, string eventName, string handlerName)
Parameters:descriptorIScriptDescriptoreventNamestringhandlerNamestring

GetCallbackResult()

C#
public string GetCallbackResult()
Returns:

string

Implements: ICallbackEventHandler.GetCallbackResult()

GetScriptDescriptors()

Gets a collection of script descriptors that represent ECMAScript (JavaScript) client components.

C#
public IEnumerable<ScriptDescriptor> GetScriptDescriptors()
Returns:

IEnumerable<ScriptDescriptor>

An IEnumerable collection of ScriptDescriptor objects.

Implements: IScriptControl.GetScriptDescriptors()

GetScriptReferences()

Gets a collection of ScriptReference objects that define script resources that the control requires.

C#
public IEnumerable<ScriptReference> GetScriptReferences()
Returns:

IEnumerable<ScriptReference>

An IEnumerable collection of ScriptReference objects.

Implements: IScriptControl.GetScriptReferences()

LoadClientState(Dictionary<string, object>)

Loads the client state data

C#
protected virtual bool LoadClientState(Dictionary<string, object> clientState)
Parameters:clientStateDictionary<string, object>Returns:

bool

LoadPostData(string, NameValueCollection)

Executed when post data is loaded from the request

C#
protected virtual bool LoadPostData(string postDataKey, NameValueCollection postCollection)
Parameters:postDataKeystringpostCollectionNameValueCollectionReturns:

bool

LoadViewState(object)

C#
protected override void LoadViewState(object savedState)
Parameters:savedStateobject

Overrides: Control.LoadViewState(object)

OnInit(EventArgs)

C#
protected override void OnInit(EventArgs e)
Parameters:eEventArgs

Overrides: Control.OnInit(EventArgs)

OnPreRender(EventArgs)

C#
protected override void OnPreRender(EventArgs e)
Parameters:eEventArgs

Overrides: Control.OnPreRender(EventArgs)

RaiseCallbackEvent(string)

C#
public void RaiseCallbackEvent(string eventArgument)
Parameters:eventArgumentstring

Implements: ICallbackEventHandler.RaiseCallbackEvent(string)

RaisePostDataChangedEvent()

Executed when post data changes should invoke a chagned event

C#
protected virtual void RaisePostDataChangedEvent()

RegisterScriptControl()

Registers the control with the ScriptManager

C#
protected virtual void RegisterScriptControl()

RegisterScriptDescriptors()

C#
protected virtual void RegisterScriptDescriptors()

Render(HtmlTextWriter)

C#
protected override void Render(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: Control.Render(HtmlTextWriter)

SaveViewState()

C#
protected override object SaveViewState()
Returns:

object

Overrides: Control.SaveViewState()

TrackViewState()

C#
protected override void TrackViewState()

Overrides: Control.TrackViewState()

In this article
DefinitionConstructorsRadClientDataSource()PropertiesAggregatesAllowBatchOperationsAllowPagingAutoSyncClientEventsCurrentPageIndexDataSourceEnableServerAggregatesEnableServerFilteringEnableServerGroupingEnableServerPagingEnableServerSortingFilterExpressionGroupExpressionsPageSizeRegisterWithScriptManagerSchemaSortExpressionsMethodsDescribeEvent(IScriptDescriptor, string, string)GetCallbackResult()GetScriptDescriptors()GetScriptReferences()LoadClientState(Dictionary<string, object>)LoadPostData(string, NameValueCollection)LoadViewState(object)OnInit(EventArgs)OnPreRender(EventArgs)RaiseCallbackEvent(string)RaisePostDataChangedEvent()RegisterScriptControl()RegisterScriptDescriptors()Render(HtmlTextWriter)SaveViewState()TrackViewState()
Not finding the help you need?
Contact Support