 | List Class |
Represents a list of items.
Inheritance HierarchyNamespace: Dynamicweb.Controls
Assembly: Dynamicweb.Controls (in Dynamicweb.Controls.dll) Version: 4.2.3
SyntaxThe List type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | AllowMultiSelect |
Gets or sets value indicating whether to allow multi-select functionality.
|
| AllowToRemoveSorting |
When set, its possible to remove list sorting
|
| Columns |
Gets the collection of list columns.
|
| ContextMenuID |
ID of Dynamicweb.Controls.Contextmenu to display on right click.
|
| Count |
Number of items in list - if set shown in title.
|
| DoBlinkCollapseButton |
If set, the CollapseButton will blink, notifying the user of e.g. non-standard filter settings
|
| FilterBy |
Column to filter by.
|
| Filters |
Gets the collection of list filters.
|
| FilterString |
Value to filter by.
|
| Footer |
Footer of the list.
|
| HandlePagingManually |
When set to true only fill the list with one page and set the page number manually
|
| HandleSortingManually |
When set to true only fill the list by already sorted collection
|
| HasFilters |
Gets value indicating whether list has any filters attached.
|
| Height |
Width of the column.
|
| IsBeingSorted |
Indicates whether this List is being sorted.
|
| IsCollapsed | |
| IsRestoreState | |
| ItemCount |
Number of items in total. Calculated based on added items, but can be overruled if only
some items are added due to performance. PageNumber property to calculate how many to load.
|
| NoItemsMessage |
Message to display if the list has no items.
|
| OnClientCollapse |
Gets or sets the client site script that fires when the filters are collapsed (hidden)
|
| OnClientSelect | |
| OnClientUnCollapse |
Gets or sets the client site script that fires when the filters are uncollapsed (shown)
|
| PageCount |
Number of pages.
|
| PageNumber |
Current page.
|
| PageSize |
Number of items per page.
|
| Personalize |
Gets or sets value indicating whether to enable personal settings.
|
| RenderWithDiv |
Gets or sets value indicating whether to render the list in divs for the new UI.
|
| RowCount |
Gets the current count of rows in this List
|
| Rows | |
| SelectedRows |
Gets selected rows.
|
| ShowCollapseButton |
When set, its possible to hide and show the filter area
|
| ShowCount |
If set to True, the List will show number of rows and pages according to the number of Rows added
|
| ShowEmptyEndColumn | |
| ShowFooter |
Gets or sets value indicating whether to show list footer.
|
| ShowHeader |
Gets or sets value indicating whether to show list header.
|
| ShowPaging |
Gets or sets value indicating whether to show paging area.
|
| ShowTitle |
Gets or sets value indicating whether to show list title.
|
| SortColumnIndex |
Gets the column index (from the postback) that this list was sorted by.
|
| SortDirection |
Gets the sort direction (from the postback).
|
| StartCollapsed |
When set, the filter area starts collapsed
|
| StretchContent | Obsolete.
Gets or sets value indicating whether to stretch the list content to fit the parent container.
|
| Title |
Title of the list.
|
| TranslateTitle |
Gets or sets value indicating whether to translate the list title.
|
| UseCountForPaging |
If set to True, the List will show number of rows and pages according to the Count Property
|
| Width |
Width of the list.
|
Methods| Name | Description | |
|---|---|---|
 | AddRow |
Adds a row to the list.
|
| Clear |
Removes all rows from the list.
|
| GetAllItemIDs | |
| GetControlState | |
| GetRowsByInternalIds | |
| GetSelectedRows |
Retrieves all selected rows from current page.
|
| GetSelectedRowsFromAllPages |
Retrieves all selected rows from all pages.
|
| GetViewFrame |
Retrieves an array represeing a current view frame of the list.
|
| LoadResources | |
 | OnBeforeInitFilters | |
| OnFiltersApplied |
Fires FiltersApplied event.
|
| OnInit |
Handles list "Init" event.
|
| OnLoad |
Handles list "Load" event.
|
| OnPageIndexChanged |
Fires PageIndexChanged event.
|
| OnPageIndexChanging |
Fires PageIndexChanging event.
|
| OnPreRender |
Handles list "PreRender" event.
|
| OnRemoveSorting | |
| OnSort |
Fires Sort event.
|
| RaisePostBackChangingEvent | |
| RaisePostBackEvent |
Processes list events.
|
| RemoveRow |
Removes a row from the list.
|
| RemoveRowAt |
Removes the row at the specified index
|
| RemoveRowRange |
Removes a range of Rows from the List
|
| Render |
Renders list.
|
| RenderRows |
Renders list rows.
|
| SetupControlState | |
| SortRows(Int32, ListSortDirection) |
Sorts list rows.
|
| SortRows(ListColumn, ListSortDirection) |
Sorts list rows.
|
| SortRows(Int32, ListSortDirection, Boolean) |
Sorts list rows.
|
Events| Name | Description | |
|---|---|---|
 | BeforeInitFilters | |
| FiltersApplied |
Occurs when all filters are applied to the list rows.
|
| PageIndexChanged |
Occurs when page index has been changed.
|
| PageIndexChanging |
Occurs when the page index is changing.
|
| RemoveSorting |
Occurs when the list sorting is being removed
|
| RowExpand |
Ajax event which is fired when list row is being expanded.
|
| Sort |
Occurs when the list is being sorted.
|
RemarksSee Also