Bitrix Site Manager

CAdminList

The CAdminList class is used to render a report table on Control Panel pages and perform service actions.

Methods

Method Description
CAdminList The class constructor.
AddHeaders Creates table columns.
AddAdminContextMenu Creates items for a Control Panel page context menu adds them to a menu.
IsUpdated Returns true is any of the table rows have been changed when editing the table rows.
EditAction Returns true if table rows have been edited and changes need to be saved.
GroupAction Returns true if any group action have been performed on the table rows and changes are to be saved.
ActionRedirect Returns a string which is a JavaScript call required to redirect a user to the specified page.
ActionAjaxReload Returns a string which is a JavaScript call required for dynamic list update using the specified URL.
ActionDoGroup Returns a string which is a JavaScript call required to update a list dynamically using the specified URL.
ActionPost Returns a string which is a JavaScript call that redirects a user to a specified page using the POST method dispatching a form that contains a list of changes.
CheckListMode Examines the required table rendering mode.
InitFilter Initialises the filter.
AddRow Adds a new row to the table.
AddFooter Adds a footer to the report table.
Display Displays the prepared report table.
AddGroupActionTable Creates a menu of available group actions that can be performed on the list elements.
DisplayList Displays the prepared report table.
AddUpdateError Registers errors that occur when saving changes of the table rows.
AddGroupError Registers errors that occur when processing group actions performed on the table rows.
AddFilterError Registers errors that occur when performing group actions on the table rows.

Examples

You can find the detailed example of a report page here.