RadTreeList
RadTreeList is a data visualization control used for hierarchical representation of self-referencing data.
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
[ToolboxBitmap(typeof(RadTreeList), "Toolbox.Icons.TreeList.png")]
[EmbeddedSkin("TreeList", typeof(RadTreeList))]
[EmbeddedSkin("TreeList", "Default", typeof(RadTreeList))]
[ClientScriptResource("Telerik.Web.UI.RadTreeList", "Telerik.Web.UI.TreeList.RadTreeListScripts.js")]
[TelerikToolboxCategory("Data")]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadTreeList))]
[RequiredCss("Telerik.Web.UI.Skins.Common.common.css", RenderMode.Lightweight, typeof(RadTreeList))]
[RequiredScript(typeof(MaterialRipple))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Lightweight, typeof(RadTreeList))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Mobile, typeof(RadTreeList))]
public class RadTreeList : RadCompositeDataBoundControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IFeatureGroup, IPostBackEventHandler, INamingContainerInheritance: objectControlWebControlBaseDataBoundControlDataBoundControlCompositeDataBoundControlRadCompositeDataBoundControlRadTreeList...
Implements:
Inherited Members
Constructors
public RadTreeList()Fields
public const string CancelCommandName = "Cancel"public const string ChangePageSizeCommandName = "ChangePageSize"public const string DeleteCommandName = "Delete"public const string DeselectAllCommandName = "DeselectAll"public const string DeselectCommandName = "Deselect"public const string EditCommandName = "Edit"public const string ExpandCollapseCommandName = "ExpandCollapse"public const string ExportToExcelCommandName = "ExportToExcel"public const string ExportToPdfCommandName = "ExportToPdf"public const string ExportToWordCommandName = "ExportToWord"public const string FirstPageCommandArgument = "First"public const string InitInsertCommandName = "InitInsert"public const string LastPageCommandArgument = "Last"public const string NextPageCommandArgument = "Next"public const string PageCommandName = "Page"public const string PerformInsertCommandName = "PerformInsert"public const string PrevPageCommandArgument = "Prev"public const string RebindTreeListCommandName = "RebindTreeList"public const string ReorderCommandName = "Reorder"public const string SelectAllCommandName = "SelectAll"public const string SelectCommandName = "Select"public const string SortCommandName = "Sort"public const string SwapCommandName = "Swap"public const string UpdateCommandName = "Update"Properties
Enables TreeListItem's child items to be loaded on demand.
public virtual bool AllowLoadOnDemand { get; set; }Gets or sets the value indicating wheather more than one column can be sorted in a single RadTreeList. The order is the same as the sequence of expressions in SortExpressions.
public bool AllowMultiColumnSorting { get; set; }Gets or sets a value indicating whether multiple items can be simultaneously edited in RadTreeList. Default value is false.
public virtual bool AllowMultiItemEdit { get; set; }Gets or sets a value indicating whether you will be able to select multiple items in Telerik RadTreeList. By default this property is set to false.
public virtual bool AllowMultiItemSelection { get; set; }Gets or sets the value indicated whether the no-sort state when changing sort order will be allowed.
public bool AllowNaturalSort { get; set; }true, if the no-sort state when changing sort order will be allowed; otherwise, false. The default value is true.
Gets or sets a value indicating whether the automatic paging feature is enabled.
public virtual bool AllowPaging { get; set; }Enables recursive delete.
public bool AllowRecursiveDelete { get; set; }Gets or sets a value indicating whether child items will be selected recursively when a RadTreeList item is selected. Setting this property to true automatically enables MultiItemSelection in RadTreeList. Default value is false.
public virtual bool AllowRecursiveSelection { get; set; }Gets or sets a value indicating whether the sorting feature is enabled.
public virtual bool AllowSorting { get; set; }Allow RadTreeList 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 a reference to the TreeListTableItemStyle object that allows you to set the appearance of the alternating items in a Telerik RadTreeList control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public TreeListTableItemStyle AlternatingItemStyle { get; }Enable/Disable auto genrated columns
public virtual bool AutoGenerateColumns { get; set; }Get an array of automatically generated columns. This array is available when AutoGenerateColumns is set to true.
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[Browsable(false)]
public virtual TreeListColumn[] AutoGeneratedColumns { get; }An array of automatically generated columns.
Gets or sets a string that specifies a brief description of a RadTreeList. Related to Telerik RadTreeList accessibility compliance.
public virtual string Caption { get; set; }Gets or sets an array of data-field names that will be used to populate the ClientDataKeyValues collection, when the RadTreeListcontrol is databinding. This collection can later be accessed on the client, to get the key value(s).
[TypeConverter(typeof(TreeListStringArrayConverter))]
public virtual string[] ClientDataKeyNames { get; set; }Gets a collection of ClientDataKeyName objects that represent the parent data key value of the corresponding item specified with its item index and the client data key name (case-sensitive!). The key name should be one of the specified in the ClientDataKeyNames array.
[Browsable(false)]
public virtual TreeListDataKeyArray ClientDataKeyValues { get; }ClientExpandedIndexes
TreeListExpandedIndexesCollection
Gets a collection containing the indexes of all rendered items which will be expanded on the client.
[Browsable(false)]
public TreeListExpandedIndexesCollection ClientExpandedIndexes { get; }Gets a reference to the TreeListClientSettings object that allows you to set the properties of the client-side behavior and appearance in a Telerik RadTreeList control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public TreeListClientSettings ClientSettings { get; }Gets a TreeListColumnCollection of all columns in RadTreeList.
[PersistenceMode(PersistenceMode.InnerProperty)]
public TreeListColumnsCollection Columns { get; }Determines the position where the command item will be displayed in the control. Supported in Lightweight and Mobile modes only. Default value is None in Lightweight. In Mobile, the default value will be Top if either AllowColumnHide or AllowColumnReorder are enabled. Otherwise none.
public TreeListCommandItemDisplay CommandItemDisplay { get; set; }Provides access to the configuration of the command item. Available in Lightweight render mode only.
[PersistenceMode(PersistenceMode.InnerProperty)]
public TreeListCommandItemSettings CommandItemSettings { get; }Gets a reference to the TreeListCommandItemStyle object that allows you to set the appearance of the command item in a Telerik RadTreeList control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual TreeListCommandItemStyle CommandItemStyle { get; }Gets or sets a value of type CultureInfo representing the current culture of the control.
public CultureInfo Culture { 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 an array of data-field names that will be used to populate the DataKeyValues collection, when the RadTreeListcontrol is databinding.
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[TypeConverter(typeof(TreeListStringArrayConverter))]
public virtual string[] DataKeyNames { get; set; }Gets a collection of DataKeyValue objects that represent the data key value of the corresponding item specified with its item index and the data key name (case-sensitive!). The data key name should be one of the specified in the DataKeyNames array.
[Browsable(false)]
public virtual TreeListDataKeyArray DataKeyValues { get; }Gets or sets the name of the method to call in order to delete data
public string DeleteMethod { get; set; }Gets or sets the ItemTemplate, which is rendered with each tree list item.
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TemplateContainer(typeof(TreeListDetailTemplateItem), BindingDirection.TwoWay)]
public virtual ITemplate DetailTemplate { get; set; }Gets or sets the text direction. This property is related to Telerik RadTreeList support for Right-To-Left lanugages. It has two possible vales defined by TreeListTextDirection enumeration:
- LTR - left-to-right text
- RTL - right-to-left text
public virtual TreeListTextDirection Dir { get; set; }Contains various data editing related properties.
[PersistenceMode(PersistenceMode.InnerProperty)]
public TreeListEditFormSettings EditFormSettings { get; }EditIndexes
TreeListEditIndexesCollection
Gets a collection containing the indexes of all items which are currently in edit mode.
[Browsable(false)]
public TreeListEditIndexesCollection EditIndexes { get; }EditItems
TreeListEditItemCollection
Gets a collection of currently edited TreeListDataItem instances.
[Browsable(false)]
public TreeListEditItemCollection EditItems { get; }Gets a reference to the TreeListTableItemStyle object that allows you to set the appearance of the edit item in a Telerik RadTreeList control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public TreeListTableItemStyle EditItemStyle { get; }Gets or sets the editing mode for RadTreeList.
public TreeListEditMode EditMode { get; set; }When set to true enables support for WAI-ARIA
public bool EnableAriaSupport { get; set; }Gets or sets a value indicating whether RadTreeList will show NoRecordsTemplate if there is no items to display.
public bool EnableNoRecordsTemplate { get; set; }true if NoRecordsTemplate usage is enabled; otherwise, false. The default value is true.
Gets or sets a value indicating the width of the RadTreeList's ExpandCollapse column.
public Unit ExpandCollapseColumnWidth { get; set; }Gets or sets the expand / collapse mode for the RadTreeList items.
public TreeListExpandCollapseMode ExpandCollapseMode { get; set; }ExpandedIndexes
TreeListExpandedIndexesCollection
Gets a collection containing the indexes of all rendered items which are currently expanded.
[Browsable(false)]
public TreeListExpandedIndexesCollection ExpandedIndexes { get; }Returns a reference to the TreeListExportSettings object that contains export-specific settings.
[PersistenceMode(PersistenceMode.InnerProperty)]
public TreeListExportSettings ExportSettings { get; }Gets a reference to the TreeListTableItemStyle object that allows you to set the appearance of the footer item in a Telerik RadTreeList control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public TreeListTableItemStyle FooterItemStyle { get; }Gets or sets value indicating whether borders will be displayed when the RadTreeList is rendered.
public virtual TreeListGridLines GridLines { get; set; }Gets a reference to the TreeListTableItemStyle object that allows you to set the appearance of the header item in a Telerik RadTreeList control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public TreeListTableItemStyle HeaderStyle { get; }Gets or sets a value indicating whether the expand/collapse image of the treelist item should be visible when it does not have child items.
public virtual bool HideExpandCollapseButtonIfNoChildren { get; set; }InsertIndexes
TreeListEditIndexesCollection
Gets a collection containing the indexes of all items which are currently being inserted.
[Browsable(false)]
public TreeListEditIndexesCollection InsertIndexes { get; }InsertItems
TreeListEditItemCollection
Gets a collection of currently inserted TreeListDataItem instances.
[Browsable(false)]
public TreeListEditItemCollection InsertItems { get; }Gets or sets the name of the method to call in order to insert data
public string InsertMethod { get; set; }protected bool IsDataBinding { get; set; }Determines whether the control is currently exporting a file
public bool IsExporting { get; set; }Gets or sets a value indicating whether a root item is inserted in RadTreeList. Setting this property to true will show the root insert item if not already shown.
public virtual bool IsItemInserted { get; set; }protected bool IsNeedDataSourceInProgress { get; set; }Items
TreeListDataItemCollection
Gets a collection of all TreeListDataItem objects in the RadTreeList. These are only the items currently visible in the control.
[Browsable(false)]
public virtual TreeListDataItemCollection Items { get; }Gets a reference to the TreeListTableItemStyle object that allows you to set the appearance of a normal item in a Telerik RadTreeList control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public TreeListTableItemStyle ItemStyle { get; }Gets or sets a value indicating where RadTreeList will look for its .resx localization file. By default this file should be in the App_GlobalResources folder. However, if you cannot put the resource file in the default location or .resx files compilation is disabled for some reason (e.g. in a DotNetNuke environment), this property should be set to the location of the resource file.
public string LocalizationPath { get; set; }A relative path to the dialogs location. For example: "~/controls/RadTreeListResources/".
If specified, the LocalizationPath property will allow you to load the grid localization file from any location in the web application.
Template that will be displayed if there are no records in the DataSource assigned
[TemplateContainer(typeof(TreeListNoRecordsItem))]
[Browsable(false)]
[Bindable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public ITemplate NoRecordsTemplate { get; set; }Gets or sets the text that will be displayed in there is no NoRecordsTemplate defined and no records in the RadTreeList.
public string NoRecordsText { get; set; }Gets the number of pages required to display the records of the data source in a RadTreeListcontrol.
[Browsable(false)]
public virtual int PageCount { get; }Gets a reference to the TreeListPagerStyle object that allows you to set the appearance of the pager item in a Telerik RadTreeList control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual TreeListPagerStyle PagerStyle { get; }Gets or sets the custom content for the pager item in a RadTreeList control.
[Bindable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
[TemplateContainer(typeof(TreeListPagerItem))]
public ITemplate PagerTemplate { get; set; }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.
Gets or sets an array of data-field names that will be used to populate the ParentDataKeyValues collection, when the RadTreeListcontrol is databinding.
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[TypeConverter(typeof(TreeListStringArrayConverter))]
public virtual string[] ParentDataKeyNames { get; set; }Gets a collection of ParentDataKeyValue objects that represent the parent data key value of the corresponding item specified with its item index and the parent data key name (case-sensitive!). The key name should be one of the specified in the ParentDataKeyNames array.
[Browsable(false)]
public virtual TreeListDataKeyArray ParentDataKeyValues { get; }Enable/Disable persisting of the columns settings for the automatically generated columns during rebind(paging, sorting, expand/collapse). When set to TRUE, the settings like Colums width and HeaderStyle for each column will be persisted. When set to FALSE, the settings applied prior the DataBind, will be loosed. If the TreeList is bound to different set of data that contains different columns, the property should be set to FALSE(the default value). Set the property to TRUE, when you need to persist the column width during operations like Paging and Sorting. The AutoGeneratedColumnCreated event will be fired in both cases, so you can override the settings if needed.
public virtual bool PersistAutoGenerateColumnsStateOnRebind { get; set; }Returns a collection of all TreeListColumns which will be rendered in the control, including auto-generated ones
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[Browsable(false)]
public TreeListColumn[] RenderColumns { get; }SelectedIndexes
TreeListSelectedIndexesCollection
Gets a collection containing the indexes of all the selected items in the RadTreeList.
[Browsable(false)]
public TreeListSelectedIndexesCollection SelectedIndexes { get; }SelectedItems
TreeListDataItemCollection
Gets a collection of the currently selected RadTreeListDataItem
[Browsable(false)]
public TreeListDataItemCollection SelectedItems { get; }Returns a TreeListDataItemCollection of all selected data items.
Gets a reference to the TreeListTableItemStyle object that allows you to set the appearance of the selected item in a Telerik RadTreeList control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public TreeListTableItemStyle SelectedItemStyle { get; }Gets or set a value indicating whether the footer item of the TreeList will be shown.
[Bindable(true)]
public virtual bool ShowFooter { get; set; }The default value of this property is false.
Setting this property will affect all TreeList tables, unless they specify otherwise explicitly.
Gets or sets value indicating whether the control will show outer borders. The default value is true.
public virtual bool ShowOuterBorders { get; set; }Gets or sets value indicating whether the control will show outer tree lines. The default value is true.
public virtual bool ShowTreeLines { get; set; }Gets or sets a string value representing the name of the skin applied to the control
public override string Skin { get; set; }Overrides:
Gets a collection of sort expressions for RadTreeList
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual TreeListSortExpressionCollection SortExpressions { get; }Gets a reference to the TreeListSortingSettings object that allows you to set the properties of the sorting operation in a Telerik RadTreeList control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual TreeListSortingSettings SortingSettings { get; }Gets or sets the 'summary' attribute for the RadTreeList.
public virtual string Summary { get; set; }This attribute provides a summary of the table's purpose and structure for user agents rendering to non-visual media such as speech and Braille. This property is a part of Telerik RadTreeList accessibility features.
protected override bool SupportsRenderingMode { get; }Overrides:
protected override HtmlTextWriterTag TagKey { get; }Overrides:
Gets or sets the name of the method to call in order to update data
public string UpdateMethod { get; set; }Contains validation settings for RadTreeList.
[PersistenceMode(PersistenceMode.InnerProperty)]
public TreeListValidationSettings ValidationSettings { get; }Methods
protected override void AddAttributesToRender(HtmlTextWriter writer)Overrides:
Recursively selects or deselects all child items of a RadTreeList item specified by its hierarchical index. Updates the selected state of all the parent items of the specified item to reflect the recursive selection.
public virtual void ApplyRecursiveSelection(TreeListDataItem item, bool selected)The RadTreeListDataItem instance
selectedboolThe selected state of the item
Recursively selects or deselects all child items of a RadTreeList item specified by its hierarchical index. Updates the selected state of all the parent items of the specified item to reflect the recursive selection.
public virtual void ApplyRecursiveSelection(TreeListHierarchyIndex hierarchyIndex, bool selected)The hierarchical index of a RadTreeListDataItem
selectedboolThe selected state of the item
protected virtual void AutoDataBind(TreeListRebindReason rebindReason)protected virtual void CallItemCreated(TreeListItemCreatedEventArgs e)protected virtual void CallItemDataBound(TreeListItemDataBoundEventArgs e)protected void ClearAutoGeneratedColumns()protected void ClearRenderColumns()Removes all selected items that belong to RadTreeList instance.
public void ClearSelectedItems()Collapses all items.
public void CollapseAllItems()Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason
protected override void ControlPreRender()Overrides:
protected override int CreateChildControls(IEnumerable dataSource, bool dataBinding)Overrides:
protected void CreateCommandItem(ControlCollection tableRows, bool isTopItem)protected virtual TreeListDataItem CreateDataItem(int displayIndex, TreeListHierarchyIndex hierarchyIndex)protected virtual int CreateDataItems(IEnumerable<TreeListSourceItem> dataSource, ControlCollection tableRows)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 TreeListDetailTemplateItem CreateDetailTemplateItem(TreeListDataItem parentItem)protected virtual TreeListEditFormItem CreateEditFormItem(TreeListDataItem parentItem)protected void CreateHeaderItem(ControlCollection tableRows)protected virtual TreeListEditableItem CreateInsertItem(TreeListDataItem parentItem)protected void CreateMobileViews()protected void CreatePagerItem(ControlCollection tableRows, bool isTopItem)protected virtual void CreateRootInsertItem(ControlCollection tableRows)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:
Expands all items.
public void ExpandAllItems()Expands the specified TreeListDataItem to the specified level.
public void ExpandItemToLevel(TreeListDataItem item, int level)The TreeListDataItem to expand
levelintThe nested level to expand to
Expands all RadTreeList items to the specified level.
Exports RadTreeList content to Excel format
public void ExportToExcel()Exports RadTreeList content to PDF format
public void ExportToPdf()Exports RadTreeList content to Word format
public void ExportToWord()protected virtual void ExtractParentKeyValuesForChild(IDictionary keys, TreeListDataItem parentDataItem)The passed IDictionary object (like Hashtable for example) will be filled with the names/values of the corresponding TreeListEditableItem's bound values and data-key values if included.
public virtual void ExtractValuesFromItem(IDictionary newValues, TreeListEditableItem dataItem, bool includePrimaryKey)dataItem is null.
newValues is null.
Finds and returns an item with given key and value. This method supports both key and parent key parameters. If there are more than one items with the same value, this routine will return the first one.
Returns a TreeListColumn based on its UniqueName. Throws ArgumentException if the specified column is not found.
public TreeListColumn GetColumn(string columnUniqueName)Returns a TreeListColumn based on its UniqueName. Return null if the specified column is not found.
public TreeListColumn GetColumnSafe(string columnUniqueName)Returns a collection of TreeListItem objects based on their ItemType.
public TreeListItem[] GetItems(params TreeListItemType[] includeItemTypes)The ItemType, which will be used as a criteria for the collection.
Returns:A TreeListItems collection of objects based on their ItemType.
Returns the Maximum Nested Level.
protected override IEnumerable<ScriptReference> GetScriptReferences()Overrides:
Inserts a new item as a child item of the specified TreeListDataItem instance. The insert item will be databound to the specified object.
public virtual void InsertChildItem(TreeListDataItem parentItem, object newDataItem)The TreeListDataItem instance for which a child item is to be inserted.
newDataItemobjectThe object that will be passed as data context to the insert item.
Inserts a new item as a child item of the specified TreeListDataItem instance.
public void InsertChildItem(TreeListDataItem parentItem)The TreeListDataItem instance for which a child item is to be inserted.
Inserts a new root level item.
public void InsertItem()Inserts a new root level item. The insert form will be databound to the specified data item object.
protected virtual void LoadAutoGeneratedColumnsState(object columnsState)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.
protected virtual bool LoadSelectedState(Dictionary<string, object> clientState)Raises AutoGeneratedColumnCreated event
protected virtual void OnAutoGeneratedColumnCreated(TreeListAutoGeneratedColumnCreatedEventArgs e)protected virtual void OnCancelCommand(TreeListCommandEventArgs e)Raises NeedDataSource event
protected virtual void OnChildItemsDataBind(TreeListChildItemsDataBindEventArgs e)protected virtual void OnColumnsOrderChanged()protected virtual void OnCreateColumnEditor(TreeListCreateColumnEditorEventArgs e)Raises CreateCustomColumn event
protected virtual void OnCreateCustomColumn(TreeListCreateCustomColumnEventArgs e)protected virtual void OnDeleteCommand(TreeListCommandEventArgs e)protected virtual void OnEditCommand(TreeListCommandEventArgs e)Raises the TreeList Exporting event
protected virtual void OnExporting(TreeListExportingEventArgs e)Raises the TreeList InfrastructureExporting event
protected virtual void OnInfrastructureExporting(TreeListInfrastructureExportingEventArgs e)protected virtual void OnInsertCommand(TreeListCommandEventArgs e)Raises ItemCommand event
protected virtual void OnItemCommand(TreeListCommandEventArgs e)Raises the ItemDeleted event.
protected virtual void OnItemDeleted(TreeListDeletedEventArgs e)Raises the ItemDrop event
protected virtual void OnItemDrop(TreeListItemDragDropEventArgs e)protected virtual void OnItemInserted(TreeListInsertedEventArgs e)Raises the ItemUpdated event.
protected virtual void OnItemUpdated(TreeListUpdatedEventArgs e)Raises NeedDataSource event
protected virtual void OnNeedDataSource(TreeListNeedDataSourceEventArgs e)protected virtual void OnPageIndexChanged(TreeListPageChangedEventArgs e)protected virtual void OnPageSizeChanged(TreeListPageSizeChangedEventArgs e)Raises the TreeList PdfExporting event
protected virtual void OnPdfExporting(TreeListPdfExportingEventArgs e)Raises the SelectedIndexChanged event.
protected virtual void OnUpdateCommand(TreeListCommandEventArgs e)protected override void PerformDataBinding(IEnumerable data)Overrides:
Perform asynchronous delete operation, using the DataSourceControl API the Rebinds the grid. Please make sure you have specified the correct DataKeyNames for the RadTreeList. When the asynchronous operation calls back, RadTreeList will fire ItemDeleted event.
public virtual void PerformDelete(TreeListDataItem editedItem)Performs asynchronous insert operation, using the DataSourceControl API, then Rebinds. When the asynchronous operation calls back, RadTreeList will fire ItemInserted event.
public virtual void PerformInsert(TreeListEditableItem insertItem, bool suppressRebind)insertItem is null.
Performs asynchronous insert operation, using the DataSourceControl API, then Rebinds. When the asynchronous operation calls back, RadTreeList will fire ItemInserted event.
public virtual void PerformInsert(TreeListEditableItem insertItem)Insert item is available only when RadTreeList is in insert mode.
protected virtual void PerformReorder(TreeListItemDragDropEventArgs e)Perform asynchronous update operation, using the DataSource control API. Please make sure you have specified the correct DataKeyNames for the RadTreeList. When the asynchronous operation calls back, RadTreeList will fire ItemUpdated event. The boolean property defines if RadTreeList will Rebind() after the update.
public virtual void PerformUpdate(TreeListEditableItem 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 RadTreeList. When the asynchronous operation calls back, RadTreeList will fire ItemUpdated event.
public void PerformUpdate(TreeListEditableItem 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()Executed when post data changes should invoke a changed event
protected override void RaisePostDataChangedEvent()Overrides:
Forces RadTreeList to rebind to its assigned datasource.
public virtual void Rebind()protected override void RenderContents(HtmlTextWriter writer)Overrides:
Reorders the position of the two columns.
public void ReorderColumns(TreeListColumn column1, TreeListColumn column2)first column
column2TreeListColumnsecond column
Saves any RadTreeList control state changes that have occurred since the time the page was posted back to the server.
protected override object SaveControlState()Returns the RadTreeList's current state. If there is no state associated with the control, this method returns null.
Overrides:
protected virtual void SetStyleClasses()Swaps the position of the two columns.
public void SwapColumns(TreeListColumn column1, TreeListColumn column2)first column
column2TreeListColumnsecond column
protected override void TrackViewState()Overrides:
Events
Raised when a auto generated column is created.
public event EventHandler<TreeListAutoGeneratedColumnCreatedEventArgs> AutoGeneratedColumnCreatedpublic event EventHandler<TreeListCommandEventArgs> CancelCommandRaised when the TreeList item is about to be bound.
public event EventHandler<TreeListChildItemsDataBindEventArgs> ChildItemsDataBindOccurs when column's order in the columns collection is changed
public event EventHandler<TreeListColumnsOrderChangedEventArgs> ColumnsOrderChangedpublic event EventHandler<TreeListCreateColumnEditorEventArgs> CreateColumnEditorRaised when a custom column is recreated on postback.
public event EventHandler<TreeListCreateCustomColumnEventArgs> CreateCustomColumnpublic event EventHandler<TreeListCommandEventArgs> DeleteCommandpublic event EventHandler<TreeListCommandEventArgs> EditCommandTriggered when the export output is about to be sent to the file.
public event EventHandler<TreeListExportingEventArgs> ExportingProvides access to the Export Infrastructure before sending the file to the browser.
public event EventHandler<TreeListInfrastructureExportingEventArgs> InfrastructureExportingpublic event EventHandler<TreeListCommandEventArgs> InsertCommandRaised when a button in a RadTreeList control is clicked.
public event EventHandler<TreeListCommandEventArgs> ItemCommandpublic event EventHandler<TreeListItemCreatedEventArgs> ItemCreatedpublic event EventHandler<TreeListItemDataBoundEventArgs> ItemDataBoundOccurs when a delete operation is requested, after the RadTreeList control deletes the item.
public event EventHandler<TreeListDeletedEventArgs> ItemDeletedOccurs when a RadTreeList item is dragged and dropped on another item or an HTML element
public event EventHandler<TreeListItemDragDropEventArgs> ItemDropOccurs when an insert operation is requested, after the RadTreeList control has inserted the item in the data source.
public event EventHandler<TreeListInsertedEventArgs> ItemInsertedOccurs when the Update command is fired from any TreeListEditableItem
public event EventHandler<TreeListUpdatedEventArgs> ItemUpdatedRaised when the RadTreeList is about to be bound and the data source must be assigned.
public event EventHandler<TreeListNeedDataSourceEventArgs> NeedDataSourceFires when a paging action has been performed.
public event EventHandler<TreeListPageChangedEventArgs> PageIndexChangedFires when PageSize has been changed.
public event EventHandler<TreeListPageSizeChangedEventArgs> PageSizeChangedRaised before the HTML code is parsed to PDF binary
public event EventHandler<TreeListPdfExportingEventArgs> PdfExportingOccurs when a new item has been selected in the RadTreeList control or the currently selected item has changed.
public event EventHandler SelectedIndexChangedpublic event EventHandler<TreeListSortEventArgs> Sortingpublic event EventHandler<TreeListCommandEventArgs> UpdateCommand