Back to Devexpress

TreeListSettings Members

aspnetmvc-devexpress-dot-web-dot-mvc-dot-treelistsettings-dot-underscore-members.md

latest24.4 KB
Original Source

TreeListSettings Members

Contains the TreeList extension settings.

Constructors

NameDescription
TreeListSettings()Initializes a new instance of the TreeListSettings class with default settings.

Properties

NameDescription
AccessibilityCompliantEnables accessibility support.
AccessKeyGets or sets the access key that allows you to quickly navigate to the ASP.NET MVC extension. Inherited from SettingsBase.
AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from SettingsBase.
AutoFilterCellEditorCreateEnables you to assign editors to individual filter row cells.
AutoFilterCellEditorInitializeEnables initializing the cell editors displayed within the filter row cells.
AutoGenerateColumnsGets or sets whether columns are automatically created for all fields in the underlying data source.
AutoGenerateServiceColumnsGets or sets whether columns are automatically created for service fields in the underlying data source.
BeforeGetCallbackResultAllows you to perform custom actions after a callback sent by the current extension has been processed on the server, but prior to the time the respective callback result render is formed.
BeforeHeaderFilterFillItemsEnables you to provide custom filter items instead of default ones displayed within the Header Filter.
CallbackRouteValuesDefines the callback routing logic by specifying the names of a Controller and an Action which should handle callbacks.
CaptionGets or sets the text to render in an HTML caption element in a TreeList.
CellEditorInitializeEnables initializing the cell editors displayed within the edit cells.
ClientLayoutEnables you to save and restore the previously saved layout of a TreeList.
ClientSideEventsGets an object that lists the client-side events specific to the TreeListSettings.
ClientVisibleGets or sets a value that specifies the initial visibility state of an extension on the client.
ColumnsProvides access to a TreeList’s column collection.
CommandColumnProvides access to the TreeList’s command column.
CommandColumnButtonInitializeEnables individual command buttons to be initialized.
ControlStyleProvides access to the style settings declared at the root level of the TreeList’s wrapped web server control.
CustomActionRouteValuesDefines the custom callback routing logic by specifying the names of a Controller and an Action which should handle custom callbacks initiated by the MVCxClientTreeList.PerformCallback method.
CustomColumnDisplayTextEnables custom display text to be provided for any cell.
CustomDataActionRouteValuesDefines the custom callback routing logic by specifying the names of a Controller and an Action which should handle custom data callbacks initiated by the MVCxClientTreeList.PerformCustomDataCallback method.
CustomFilterExpressionDisplayTextEnables you to display custom text within the filter bar, corresponding to the current filter expression.
CustomJSPropertiesEnables you to supply any server data that can then be parsed on the client.
CustomNodeSortEnables you to sort data manually using custom rules.
CustomSummaryCalculateEnables you to calculate summary values manually.
CustomUnboundColumnDataEnables data to be supplied to unbound columns.
DataBindingAllows you to perform custom actions before a TreeList is bound to a data source.
DataBoundEnables you to perform a custom action after the TreeList has been bound to its data source.
DataCacheModeGets or sets whether data caching is enabled.
DeleteSelectedNodesRouteValuesDefines the callback routing logic by specifying the names of a Controller and an Action which should handle callbacks related to selected node(s) deletion.
EnableCallbackAnimationGets or sets a value that specifies whether a specific animation effect is used when a tree list’s content is updated via a callback.
EnabledGets or sets a value that indicates whether the MVC Extension is enabled, allowing it to respond to end-user interactions. Inherited from SettingsBase.
EnablePagingCallbackAnimationGets or sets a value that specifies whether a specific animation effect is used when changing pages.
EnablePagingGesturesGets or sets a value specifying whether an end-user can switch pages with a swipe gesture.
EnableThemingGets or sets a value indicating whether themes apply to this extension. Inherited from SettingsBase.
EncodeHtmlGets or sets whether to encode editor value and content. Inherited from SettingsBase.
FilterControlColumnsCreatedEnables you to customize the filter control column collection after it is created.
FilterControlCriteriaValueEditorCreateEnables you to replace the default criteria value editor with a custom one.
FilterControlCriteriaValueEditorInitializeEnables the editors displayed within the criteria value to be initialized.
FilterControlCustomValueDisplayTextEnables you to specify the entered filter value’s custom display text to be displayed when the filter’s condition value editor is inactive.
FilterControlOperationVisibilityEnables you to dynamically hide operation items (such as the Equals, Contains, etc.) of the FilterControl’s operation dropdown menu.
FilterControlParseValueEnables you to process and modify an entered value before it is actually accepted by the filter.
HeaderFilterEditorInitializeOccurs when a header filter editor is initialized.
HeaderFilterFillItemsEnables you to provide custom filter items displayed within a filter dropdown.
HeightGets or sets the height of the extension. Inherited from SettingsBase.
HtmlCommandCellPreparedEnables the settings of individual command cells to be changed.
HtmlDataCellPreparedEnables the settings of individual cells to be changed.
HtmlRowPreparedEnables the settings of individual rows to be changed.
ImagesProvides access to the settings that define images displayed within the TreeList’s elements.
ImagesEditorsProvides access to the settings that define images displayed within the TreeList’s editors.
ImagesFilterControlProvides access to the settings that define images displayed within the filter builder.
InitEnables you to perform custom actions when an extension is initialized. Inherited from SettingsBase.
InitNewNodeEnables you to initialize added nodes.
KeyboardSupportGets or sets a value that specifies whether keyboard navigation is available within the TreeList.
KeyFieldNameGets or sets the name of the data source key field.
NameSpecifies the unique identifier name for the extension. Inherited from SettingsBase.
NodesProvides access to the root nodes child collection.
ParentFieldNameGets or sets the data source field which contains parent node values.
PreRenderAllows custom processing to be implemented before the extension is rendered to the page. Inherited from SettingsBase.
PreviewEncodeHtmlGets or sets whether to encode preview row content.
PreviewFieldNameGets or sets the name of the data source field whose values are displayed within preview rows.
ProcessColumnAutoFilterEnables you to apply custom filter criteria.
ProcessOnClickRowFilterEnables you to apply custom filter criteria when the filter row is in the OnClick mode.
RightToLeftSpecifies whether to apply right-to-left representation to the extension.
RootValueGets or sets the value that root nodes contain in the field specified by the TreeListSettings.ParentFieldName property.
SearchPanelEditorCreateEnables you to replace the default search panel editor with a custom one.
SearchPanelEditorInitializeEnables you to customize the properties of an editor displayed within the search panel.
SettingsProvides access to the TreeList’s display options.
SettingsBehaviorProvides access to the extension’s behavior settings.
SettingsCookiesProvides access to the extension’s cookie settings.
SettingsCustomizationWindowProvides access to the customization window’s settings.
SettingsDataSecurityProvides access to the TreeList’s security settings that allow you to disable data modification operations (edit, insert, delete).
SettingsEditingProvides access to the TreeList’s edit settings.
SettingsExportProvides access to the TreeList’s export settings.
SettingsFilterControlProvides access to the filter control’s settings.
SettingsLoadingPanelProvides access to the loading panel’s settings.
SettingsPagerProvides access to the pager’s settings.
SettingsPopupProvides access to the settings of different grid popup elements.
SettingsResizingProvides access to the TreeList’s resizing settings.
SettingsSearchPanelProvides access to the search panel’s settings.
SettingsSelectionProvides access to the extension’s selection options.
SettingsTextProvides access to the extension’s text settings.
SkinIDGets or sets the skin to apply to the control. Inherited from SettingsBase.
StyleGets a collection of all cascading style sheet (CSS) properties applied to an extension. Inherited from SettingsBase.
StylesProvides access to the style settings that control the appearance of the TreeList’s elements.
StylesEditorsProvides access to style settings defining the appearance of TreeList’s editors.
StylesPagerProvides access to the style settings that control the appearance of the pager displayed within the TreeList.
StylesPopupProvides access to the style settings defining the appearance of different popup elements within a tree list
StylesToolbarProvides access to the style settings that define the appearance of toolbars.
SummaryProvides access to TreeList summary items.
SummaryTextGets or sets a value that describes the TreeList’s contents.
TabIndexGets or sets the tab index of the control element of the web page. Inherited from SettingsBase.
ThemeGets or sets the name of the theme to be applied to the extension. Inherited from SettingsBase.
ToolbarItemClickFires after a toolbar item has been clicked.
ToolbarsGets the collection of toolbars in the TreeListSettings control.
ToolTipGets or sets a UI element’s tooltip text. Inherited from SettingsBase.
VirtualModeNodeCreatedOccurs when the TreeList functions in virtual mode after a node has been created.
WidthGets or sets the width of the extension. Inherited from SettingsBase.

Methods

NameDescription
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetType()Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
SetDataCellTemplateContent(Action<TreeListDataCellTemplateContainer>)Allows you to provide a template to render a data cell.
SetDataCellTemplateContent(String)Allows you to provide a template to render a data cell.
SetEditFormTemplateContent(Action<TreeListEditFormTemplateContainer>)Allows you to provide a template to render the edit form.
SetEditFormTemplateContent(String)Allows you to provide a template to render the edit form.
SetFilterCellTemplateContent(Action<TreeListFilterCellTemplateContainer>)Allows you to specify a filter cell template.
SetFilterCellTemplateContent(String)Allows you to specify a filter cell template.
SetFilterRowTemplateContent(Action<TreeListFilterRowTemplateContainer>)Allows you to specify a filter row template.
SetFilterRowTemplateContent(String)Allows you to specify a filter row template.
SetFooterCellTemplateContent(Action<TreeListFooterCellTemplateContainer>)Allows you to provide a template to render a footer cell.
SetFooterCellTemplateContent(String)Allows you to provide a template to render a footer cell.
SetGroupFooterCellTemplateContent(Action<TreeListFooterCellTemplateContainer>)Allows you to provide a template to render a group footer cell.
SetGroupFooterCellTemplateContent(String)Allows you to provide a template to render a group footer cell.
SetHeaderCaptionTemplateContent(Action<TreeListHeaderTemplateContainer>)Allows you to provide a template to render the column header’s caption.
SetHeaderCaptionTemplateContent(String)Allows you to provide a template to render the column header’s caption.
SetPreviewTemplateContent(Action<TreeListPreviewTemplateContainer>)Allows you to provide a template to render a preview row.
SetPreviewTemplateContent(String)Allows you to provide a template to render a preview row.
ToString()Returns a string that represents the current object. Inherited from Object.

See Also

TreeListSettings Class

DevExpress.Web.Mvc Namespace