RadListView
RadListView is designed to give your the freedom to specify predefined or customized type of layout for the items displayed in the control and in the same time gives you integrated sorting, paging, grouping, editing, selecting, etc. capabilities. You can embed various controls of your choice in RadListView's templates and model their appearance in a custom manner. Thanks to its innovative architecture RadListView is extremely fast and generates very little output.
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
[EmbeddedSkin("ListView", typeof(RadListView))]
[EmbeddedSkin("ListView", "Default", typeof(RadListView))]
[ToolboxBitmap(typeof(RadListView), "Toolbox.Icons.ListView.png")]
[ControlValueProperty("SelectedValue")]
[ClientScriptResource("Telerik.Web.UI.RadListView", "Telerik.Web.UI.ListView.RadListViewScripts.js")]
[RequiredScript(typeof(jQuery))]
[TelerikToolboxCategory("Data")]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadListView))]
public class RadListView : RadCompositeDataBoundControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, INamingContainer, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IFeatureGroup, IRadPageableItemContainer, IPostBackEventHandler, IPageableItemContainerInheritance: objectControlWebControlBaseDataBoundControlDataBoundControlCompositeDataBoundControlRadCompositeDataBoundControlRadListView...
Implements:
Inherited Members
Constructors
public RadListView()Fields
public const string CancelCommandName = "Cancel"public const string ChangePageSizeCommandName = "ChangePageSize"public const string DeleteCommandName = "Delete"public const string DeselectCommandName = "Deselect"public const string EditCommandName = "Edit"public const string InitInsertCommandName = "InitInsert"public const string PageCommandName = "Page"public const string PerformInsertCommandName = "PerformInsert"public const string RebindListViewCommandName = "RebindListView"public const string SelectCommandName = "Select"public const string SortCommandName = "Sort"public const string UpdateCommandName = "Update"Properties
Gets or sets if the custom paging feature is enabled.
public virtual bool AllowCustomPaging { get; set; }Gets or sets if the custom sorting feature is enabled.
public virtual bool AllowCustomSorting { get; set; }Gets or sets the value indicating if more than one datafield can be sorted. The order is the same as the sequence of expressions in SortExpressions.
public virtual bool AllowMultiFieldSorting { get; set; }Gets or sets a value indicating whether RadListView will allow you to have multiple items in edit mode. The default value is false.
public virtual bool AllowMultiItemEdit { get; set; }true if you can have more than one item in edit mode. Otherwise, false. The default value is false.
Gets or sets a value indicating whether you will be able to select multiple items in Telerik RadListView. By default this property is set to false.
public virtual bool AllowMultiItemSelection { get; set; }true if you can have multiple dataItems selected at once. Otherwise, false. The default is false.
Allows and disallows the no-sort state when changing sort order.
public virtual bool AllowNaturalSort { get; set; }Allows and disallows the no-sort state when changing sort order.
Gets or sets a value indicating whether the automatic paging feature is enabled.
public virtual bool AllowPaging { get; set; }Allow RadListView equal items not to be reordered when sorting. Enables sorting result consistancy between 3.5, 4.0, 4.5 Framework
public bool AllowStableSort { get; set; }Gets or sets the custom content for the alternating data item in a RadListView control.
[TemplateContainer(typeof(RadListViewDataItem), BindingDirection.TwoWay)]
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual ITemplate AlternatingItemTemplate { get; set; }Gets or sets a value indicating whether Telerik RadListView should retrieve all data and ignore server paging in case of sorting.
public virtual bool CanRetrieveAllData { get; set; }true (default) if the retrieve all data feature is enabled; otherwise, false.
Gets or sets comma delimited list of data-field Names.
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[TypeConverter(typeof(RadListViewStringArrayConverter))]
public virtual string[] ClientDataKeyNames { get; set; }Comma delimited list of data-field Names.
Gets or sets ID of RadClientDataSource control that to be used for client side binding
public virtual string ClientDataSourceID { get; set; }Gets a reference to the RadListViewClientSettings object that allows you to set the properties of the client-side behavior and appearance in a Telerik RadListView control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public RadListViewClientSettings ClientSettings { get; }Gets or sets a value that indicates whether empty string values ("")
are automatically converted to null values when the data field is
updated in the data source.
public virtual bool ConvertEmptyStringToNull { get; set; }protected IEnumerable CurrentDataSource { get; set; }Gets or sets a value indicating the index of the currently active page in case paging is enabled (AllowPaging is true).
[Bindable(true)]
[Browsable(false)]
public int CurrentPageIndex { get; set; }The index of the currently active page in case paging is enabled.
Exceptions: ArgumentOutOfRangeExceptionvalue is out of range.
Gets or sets the custom content for the data group template in a RadListView control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public ListViewDataGroupCollection DataGroups { get; }Gets or sets an array of data-field names that will be used to populate the DataKeyValues collection, when the RadListViewcontrol is databinding.
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[TypeConverter(typeof(RadListViewStringArrayConverter))]
public virtual string[] DataKeyNames { get; set; }Gets collection of data key values.
[Browsable(false)]
public virtual RadListViewDataKeyArray DataKeyValues { get; }The collection of data key values.
Gets or sets a OData service DataModelID.
public virtual string DataModelID { get; set; }The OData service DataModelID.
public int DataSourceCount { get; }Gets or sets the name of the method to call in order to delete data
public string DeleteMethod { get; set; }Gets the edit indexes which represent the indexes of the items that are currenly in edit mode.
[Browsable(false)]
public RadListViewIndexesCollection EditIndexes { get; }The edit indexes which represent the indexes of the items that are currenly in edit mode.
Gets a collection of all RadListViewDataItem in edit mode.
[Browsable(false)]
public RadListViewDataItemCollection EditItems { get; }RadListViewDataItemCollection of all items that are in edit mode.
Gets or sets the custom content for the item in edit mode.
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TemplateContainer(typeof(RadListViewDataItem), BindingDirection.TwoWay)]
public virtual ITemplate EditItemTemplate { get; set; }An object that contains the custom content for the item in edit mode. The default is null, which indicates that this property is not set.
Gets or sets the Template that will be displayed if there are no records in the DataSource assigned.
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TemplateContainer(typeof(RadListView))]
public virtual ITemplate EmptyDataTemplate { get; set; }Gets or sets the user-defined content for the empty item that is rendered in a RadListView control when there are no more data items to display in the last row of the current data page.
[TemplateContainer(typeof(RadListViewItem))]
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual ITemplate EmptyItemTemplate { get; set; }Gets a collection of filter expressions for RadListView
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual RadListViewFilterExpressionCollection FilterExpressions { get; }Gets or sets the scope of the aggregates in a RadListView. Meaningful only in case of data grouping. Default value is AllItems
public virtual ListViewGroupAggregatesScope GroupAggregatesScope { get; set; }Gets or sets the number of items to display per group in a RadListView control. Default value is 1
public virtual int GroupItemCount { get; set; }value is out of range.
Gets or sets the ID for the group placeholder in a RadListView control.
public virtual string GroupPlaceholderID { get; set; }The ID for the group placeholder in a RadListView control. The default is "groupPlaceholder".
Gets or sets the user-defined content for the separator between groups in a RadListView control.
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
[TemplateContainer(typeof(RadListViewItem))]
public virtual ITemplate GroupSeparatorTemplate { get; set; }Gets or sets the custom content for group container in the RadListView control.
[TemplateContainer(typeof(RadListViewItem), BindingDirection.TwoWay)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
public virtual ITemplate GroupTemplate { get; set; }Gets the insert item of a RadListView control.
[Browsable(false)]
public RadListViewInsertItem InsertItem { get; protected set; }Gets or sets the location of the InsertItemTemplate template when it is rendered as part of the RadListView control.
public virtual RadListViewInsertItemPosition InsertItemPosition { get; set; }Gets or sets the custom content for an insert item in the RadListView control.
[TemplateContainer(typeof(RadListViewDataItem), BindingDirection.TwoWay)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
public virtual ITemplate InsertItemTemplate { get; set; }Gets or sets the name of the method to call in order to insert data
public string InsertMethod { get; set; }protected bool IsBoundToIQueryableCollection { get; }protected virtual bool IsBoundUsingOData { get; }protected bool IsDataBinding { get; set; }protected bool IsEnityDataSourceView { get; }Gets or sets a value indicating if the RadListView is currently in insert mode.
[Browsable(false)]
public bool IsItemInserted { get; set; }true, if the RadListView is currently in insert mode; otherwise, false.
The ItemInserted property indicates if the RadListView is currently in insert mode. After setting it you should call the Rebind() method.
protected bool IsLinqDataSourceView { get; }protected bool IsModelValid { get; set; }protected bool IsNeedDataSourceInProgress { get; set; }protected bool IsOpenAccessDataSourceView { get; }Gets or sets the ID for the item placeholder in a RadListView control.
public virtual string ItemPlaceholderID { get; set; }The ID for the item placeholder in a RadListView control. The default is "itemPlaceholder".
Gets a collection of RadListViewDataItem objects that represent the data items of the current page of data in a RadListView control.
[Browsable(false)]
public virtual RadListViewDataItemCollection Items { get; }Gets or sets the custom content for the separator between the items in a RadListView control.
[TemplateContainer(typeof(RadListViewItem))]
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual ITemplate ItemSeparatorTemplate { get; set; }Gets or sets the custom content for the data item in a RadListView control.
[TemplateContainer(typeof(RadListViewDataItem), BindingDirection.TwoWay)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
public virtual ITemplate ItemTemplate { get; set; }Gets or sets the custom content for the root container in a RadListView control.
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TemplateContainer(typeof(RadListView))]
public virtual ITemplate LayoutTemplate { get; set; }protected Control LayoutTemplateWrapper { get; set; }Gets or sets the ODataDataSource used for data binding.
public virtual string ODataDataSourceID { get; set; }Gets or sets a value indicating if the RadListView should override the default DataSourceControl sorting with its native sorting.
public virtual bool OverrideDataSourceControlSorting { get; set; }You can set this to true in case of ObjectDataSource with IEnumerable data without implemented sorting.
Gets the number of pages required to display the records of the data source in a RadListViewcontrol.
[Browsable(false)]
public virtual int PageCount { get; }Specify the maximum number of items that would appear in a page, when paging is enabled by AllowPaging property. Default value is 10.
public virtual int PageSize { get; set; }value is out of range.
ResolvedDataSource
ListViewEnumerableBase
protected virtual ListViewEnumerableBase ResolvedDataSource { get; }InvalidOperationException.
Gets a collection of indexes of the selected items.
[Browsable(false)]
public RadListViewIndexesCollection SelectedIndexes { get; }Gets a collection of the currently selected RadListViewDataItems
[Browsable(false)]
public RadListViewDataItemCollection SelectedItems { get; }Returns a RadListViewDataItemCollection of all selected data items.
Gets or sets the custom content for the selected item in a RadListView control.
[PersistenceMode(PersistenceMode.InnerProperty)]
[TemplateContainer(typeof(RadListViewDataItem), BindingDirection.TwoWay)]
[Browsable(false)]
public virtual ITemplate SelectedItemTemplate { get; set; }Gets the data key value of the selected item in a RadListView control.
[Browsable(false)]
public object SelectedValue { get; }The data key value of the selected row in a RadListView control.
[Browsable(false)]
public DataKey SelectedValues { get; }Gets a collection of sort expressions for RadListView
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual RadListViewSortExpressionCollection SortExpressions { get; }protected virtual int StartRowIndex { get; }protected override bool SupportsRenderingMode { get; }Overrides:
Gets or sets the name of the method to call in order to update data
public string UpdateMethod { get; set; }Gets a reference to the RadListViewValidationSettings object that allows you to set the properties of the validate operation in a RadListView control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public RadListViewValidationSettings ValidationSettings { get; }[Browsable(true)]
[Bindable(true)]
public virtual int VirtualItemCount { get; set; }value is out of range.
Methods
protected virtual void AutoDataBind(RadListViewRebindReason rebindReason)Removes all edit items that belong to the RadListView instance.
public void ClearEditItems()Removes all selected items that belong to RadListView instance.
public void ClearSelectedItems()protected override void CreateChildControls()Overrides:
When overridden in an abstract class, creates the control hierarchy that is used to render the composite data-bound control based on the values from the specified data source.
protected override int CreateChildControls(IEnumerable dataSource, bool dataBinding)An IEnumerable that contains the values to bind to the control.
dataBindingbooltrue to indicate that the CreateChildControls(IEnumerable, bool) is called during data binding; otherwise, false.
Returns:The number of items created by the CreateChildControls(IEnumerable, bool) .
Exceptions: InvalidOperationExceptionThe RadListView control does not have an item placeholder specified.
Overrides:
protected virtual RadListViewDataGroupItem CreateDataGroupItem()protected virtual RadListViewDataItem CreateDataItem(int displayIndex)protected virtual int CreateDataItems(Control container, IEnumerable dataSource, bool dataBinding)InvalidOperationException.
Creates a default DataSourceSelectArguments object used by the data-bound control if no arguments are specified.
protected override DataSourceSelectArguments CreateDataSourceSelectArguments()A DataSourceSelectArguments initialized to Empty.
Overrides:
protected virtual RadListViewItem CreateInsertItem()The RadListView control does not have an InsertItemTemplate template specified.
protected virtual int CreateItemsWithDataGroups(Control container, IEnumerable dataSource, bool dataBinding)protected virtual int CreateItemsWithGroups(Control container, IEnumerable dataSource, bool dataBinding)public override void DataBind()You should not call DataBind in NeedDataSource event handler. DataBind would take place automatically right after NeedDataSource handler finishes execution.
Overrides:
protected override void DescribeComponent(IScriptDescriptor descriptor)Overrides:
protected virtual void EnsureLayoutTemplate()The passed IDictionary object (like Hashtable for example) will be filled with the names/values of the corresponding RadListViewDataItem's bound values and data-key values if included.
public virtual void ExtractValuesFromItem(IDictionary newValues, RadListViewDataItem dataItem, bool includePrimaryKey)dataItem is null.
newValues is null.
protected override IEnumerable<ScriptReference> GetScriptReferences()Overrides:
Creates and instantiate layout template instance
protected virtual void InstantiateEmptyItemTemplate(Control container)protected virtual void InstantiateGroupSeparatorTemplate(Control container)protected virtual void InstantiateInsertItemTemplate(Control container)protected virtual void InstantiateItemSeparatorTemplate(Control container)Loads the client state data
protected override bool LoadClientState(Dictionary<string, object> clientState)Overrides:
Restores control-state information from a previous page request that was saved by the SaveControlState() method.
Raises the CustomAggregate event
protected virtual void OnCustomAggregate(ListViewCustomAggregateEventArgs e)protected virtual void OnFieldDescriptorsReady(RadFilterFildDesciptorsEventArgs e)Raises the ItemUpdating event.
protected virtual void OnItemCanceling(RadListViewCommandEventArgs e)Raises ItemCommand event
protected virtual void OnItemCommand(RadListViewCommandEventArgs e)Raises ItemCreated event
protected virtual void OnItemCreated(RadListViewItemEventArgs e)Raises ItemDataBound event
protected virtual void OnItemDataBound(RadListViewItemEventArgs e)Raises the ItemDeleted event.
protected virtual void OnItemDeleted(RadListViewDeletedEventArgs e)protected virtual void OnItemDeleting(RadListViewCommandEventArgs e)Raises the ItemDrop event
protected virtual void OnItemDrop(RadListViewItemDragDropEventArgs e)protected virtual void OnItemEditing(RadListViewCommandEventArgs e)protected virtual void OnItemInserted(RadListViewInsertedEventArgs e)protected virtual void OnItemInserting(RadListViewCommandEventArgs e)Raises the ItemUpdated event.
protected virtual void OnItemUpdated(RadListViewUpdatedEventArgs e)Raises the ItemUpdating event.
protected virtual void OnItemUpdating(RadListViewCommandEventArgs e)Raises NeedDataSource event
protected virtual void OnNeedDataSource(RadListViewNeedDataSourceEventArgs e)protected virtual void OnPageIndexChanged(RadListViewPageChangedEventArgs e)protected virtual void OnPageSizeChanged(RadListViewPageSizeChangedEventArgs e)protected virtual void OnSorting(RadListViewSortEventArgs e)protected virtual void OnTotalRowCountAvailable(RadDataPagerPageEventArgs e)Binds the data from the data source to the composite data-bound control.
protected override void PerformDataBinding(IEnumerable data)An IEnumerable that contains the values to bind to the composite data-bound control.
Overrides:
Perform delete operation, using the DataSourceControl API. Please make sure you have specified the correct DataKeyNames for the RadListView.
public virtual void PerformDelete(RadListViewDataItem editedItem, bool suppressRebind)Perform asynchronous delete operation, using the DataSourceControl API the Rebinds the grid. Please make sure you have specified the correct DataKeyNames for the RadListView. When the asynchronous operation calls back, RadListView will fire ItemDeleted event.
public virtual void PerformDelete(RadListViewDataItem editedItem)Performs asynchronous insert operation, using the DataSourceControl API, then Rebinds. When the asynchronous operation calls back, RadListView will fire ItemInserted event.
public virtual void PerformInsert()Insert item is available only when RadListView is in insert mode.
Performs asynchronous insert operation, using the DataSourceControl API, then Rebinds. When the asynchronous operation calls back, RadListView will fire ItemInserted event.
public virtual void PerformInsert(RadListViewInsertItem insertItem, bool suppressRebind)insertItem is null.
protected override void PerformSelect()Overrides:
Perform asynchronous update operation, using the DataSource control API. Please make sure you have specified the correct DataKeyNames for the RadListView. When the asynchronous operation calls back, RadListView will fire ItemUpdated event. The boolean property defines if RadListView will Rebind() after the update.
public virtual void PerformUpdate(RadListViewDataItem editedItem, bool suppressRebind)editedItem is
null.
Perform asynchronous update operation, using the DataSource control API and the Rebind method. Please, make sure you have specified the correct DataKeyNames for the RadListView. When the asynchronous operation calls back, RadListView will fire ItemUpdated event.
public void PerformUpdate(RadListViewDataItem editedItem)protected void PopulateDataKeys(object dataItem)There was a problem extracting DataKeyValues from the DataSource. Please ensure that DataKeyNames are specified correctly and all fields specified exist in the DataSource.
protected virtual void PrepareDataSource()public virtual void RaisePostBackEvent(string eventArgument)Implements:
Rebinds this instance and updates the RadListView.
public virtual void Rebind()protected virtual void RemoveItems()Renders the RadListView to the specified HTML writer.
protected override void Render(HtmlTextWriter writer)The HtmlTextWriter object that receives the control content.
Overrides:
protected override void RenderContents(HtmlTextWriter writer)Overrides:
protected virtual Control RetrivePlaceHolderControl(Control container, string placeholderId)The RadListView control does not have an item placeholder specified.
Saves any RadListView control state changes that have occurred since the time the page was posted back to the server.
protected override object SaveControlState()Returns the RadListView's current state. If there is no state associated with the control, this method returns null.
Overrides:
protected virtual void SetPageProperties(int startRowIndex, int maximumRows, bool databind)maximumRows is out of range.
startRowIndex is out of range.
Places the RadListView in insert mode, allowing user to insert a new data-item values.
public virtual void ShowInsertItem()Places the RadListView in insert mode, allowing user to insert a new data-item values. The InsertItem created will be bound to values found in defaultValues dictionary;
public virtual void ShowInsertItem(IDictionary defaultValues)values with which InsertItem will be populated
Places the RadListView in insert mode, allowing user to insert a new data-item values. The InsertItem created will be bound to the provided object;
public virtual void ShowInsertItem(object dataItem)object to which InsertItem will be bound
Places the RadListView in insert mode, allowing user to insert a new data-item values. The InsertItem created will be bound to values found in defaultValues dictionary;
public virtual void ShowInsertItem(RadListViewInsertItemPosition itemPosition, IDictionary defaultValues)position at which the insertItem will be shown
defaultValuesIDictionaryvalues with which InsertItem will be populated
Places the RadListView in insert mode, allowing user to insert a new data-item values. The InsertItem created will be bound to the provided object;
public virtual void ShowInsertItem(RadListViewInsertItemPosition itemPosition, object dataItem)position at which the insertItem will be shown
dataItemobjectobject to which InsertItem will be bound
Places the RadListView in insert mode, allowing user to insert a new data-item values.
public virtual void ShowInsertItem(RadListViewInsertItemPosition itemPosition)protected override void TrackViewState()Overrides:
Events
Occurs when a ListView grouped by custom aggregate
public event EventHandler<ListViewCustomAggregateEventArgs> CustomAggregateOccurs when the Cancel command is fired from any RadListViewDataItem
public event EventHandler<RadListViewCommandEventArgs> ItemCancelingRaised when a button in a RadListView control is clicked.
public event EventHandler<RadListViewCommandEventArgs> ItemCommandRaised when RadListViewItem is created
public event EventHandler<RadListViewItemEventArgs> ItemCreatedRaised when RadListViewItem is data bound
public event EventHandler<RadListViewItemEventArgs> ItemDataBoundOccurs when a delete operation is requested, after the RadListView control deletes the item.
public event EventHandler<RadListViewDeletedEventArgs> ItemDeletedOccurs when a delete operation is requested, but before the RadListView control deletes the item.
public event EventHandler<RadListViewCommandEventArgs> ItemDeletingOccurs when a ListView item is dragged and dropped on an HTML element
public event EventHandler<RadListViewItemDragDropEventArgs> ItemDropOccurs when an edit operation is requested, but before the RadListView item is put in edit mode
public event EventHandler<RadListViewCommandEventArgs> ItemEditingOccurs when an insert operation is requested, after the RadListView control has inserted the item in the data source.
public event EventHandler<RadListViewInsertedEventArgs> ItemInsertedOccurs when an insert operation is requested, but before the RadListView control performs the insert.
public event EventHandler<RadListViewCommandEventArgs> ItemInsertingOccurs when the Update command is fired from any RadListViewDataItem
public event EventHandler<RadListViewUpdatedEventArgs> ItemUpdatedOccurs when the Update command is fired from any RadListViewDataItem
public event EventHandler<RadListViewCommandEventArgs> ItemUpdatingRaised when LayoutTemplate is created
public event EventHandler<EventArgs> LayoutCreatedRaised when the RadListView is about to be bound and the data source must be assigned.
public event EventHandler<RadListViewNeedDataSourceEventArgs> NeedDataSourceFires when a paging action has been performed.
public event EventHandler<RadListViewPageChangedEventArgs> PageIndexChangedFires when PageSize has been changed.
public event EventHandler<RadListViewPageSizeChangedEventArgs> PageSizeChangedFires the SelectedIndexChanged event.
public event EventHandler<EventArgs> SelectedIndexChangedFires when PageSize has been changed.
public event EventHandler<RadListViewSortEventArgs> Sorting