lists.js

Adds new item at the end of the list.

Syntax

int Add (mixed item [, object parent=null])

Returns

Index of new item.

Adds multiple items (even recursive) at the end of the list.

Syntax

void AddItems (array items [, object parent=null])

Returns

-

Sets list items.

Syntax

void SetItems (array items)

Returns

-

Inserts new item at the position specified by index.

Syntax

int Insert (int index, mixed item [, object parent=null])

Returns

Index of new item.

Replaces item at the position specified by index.

Syntax

object Replace (int index, mixed item [, object parent=null])

Returns

Deleted item object.

Deletes all references to the item from list.

Syntax

void Remove (object item [, object parent=null])

Returns

-

Removes item at specified index from list.

Syntax

object Delete (int index [, object parent=null])

Returns

Deleted item object.

Deletes all items from the list.

Syntax

void Delete ([object parent=null])

Returns

-

Returns the index of the item in list.

Syntax

int IndexOf (object item, [object parent=null])

Returns

-

Gets/creates items by specified path.

Syntax

object GetPath (object parent, string path [, create=true, function oncreatefnc=null, mixed userdata])

Returns

-

Collapses an item.

Syntax

void Collapse (object item)

Returns

-

Expands an item.

Syntax

void Expand (object item)

Returns

-

Collapses all items in tree.

Syntax

void CollapseAll ([object parent=null])

Returns

-

Expands all items in tree.

Syntax

void ExpandAll ([object parent=null])

Returns

-

Collapses/Expands an item.

Syntax

void ToggleCollapsed (object item)

Returns

-

Sets item check state.

Syntax

void CheckItem (object item [, enum state = nglChecked])

Constants

Returns

-

Checks all items in tree.

Syntax

void CheckAll ([object parent=null])

Returns

-

Unchecks all items in tree.

Syntax

void UncheckAll ([object parent=null])

Returns

-

Gets references to all checked items.

Syntax

array GetChecked ()

Returns

Array of items.

Clicks the item.

Syntax

void ClickItem (it [, event ev])

Parameters

Returns

-

Sets item visibility.

Syntax

void SetItemVisible (object item [, bool visible = true])

Returns

-

Sets enabled state of the item.

Syntax

void SetItemEnabled (object item [, bool enabled = true])

Returns

-

Performs a sort on the list.

Syntax

void Sort ([object item, bool recursion=true])

Returns

-

See also

OnCompareItem

Recursive scan items in list.

Syntax

int Scan (function scanfnc [, object parent=null, mixed userdata])

Returns

-

Recursive scan only visible items in list.

Syntax

int ScanVisible (function scanfnc [, object parent=null, mixed userdata])

Returns

-

Locates an item in list by given key.

Syntax

object FindItem (mixed key [, int partial=0, bool ignorecase=true, bool visibleonly=false])

Returns

-

Locates an item by given ID.

Syntax

object FindItemByID (string id)

Returns

-

Gets focused item.

Syntax

object GetItemFocus ()

Returns

-

Sets focus to specified item.

Syntax

void SetItemFocus (object item)

Returns

-

Locates first visible item in a list.

Syntax

object FirstVisibleItem ([object item=null])

Returns

-

Locates previous visible item in a list.

Syntax

object PrevVisibleItem (object item [, bool subitems=true])

Returns

-

Locates next visible item in a list.

Syntax

object NextVisibleItem (object item [, bool subitems=true])

Returns

-

Locates last visible item in a list.

Syntax

object LastVisibleItem ([object item=null])

Returns

-

Clears selection.

Syntax

void ClearSelected ()

Returns

-

Adds item to selection.

Syntax

void SelectItem (object item [, bool state=true])

Returns

-

Gets references to all selected items.

Syntax

array GetSelected ()

Returns

Array of items.

Determines if given item is selected.

Syntax

array IsItemSelected (object item)

Returns

TRUE if item is selected.

Update item(s) checked state.  Faster then updating whole control by calling Update() method.

Syntax

void UpdateChecked (object item [, bool recursion=false, bool setall=undefined])

void UpdateChecked ()

Returns

-

Update item(s) collapsed state.  Faster then updating whole control by calling Update() method.

Syntax

void UpdateCollapsed (object item [, bool recursion=false, bool setall=undefined])

void UpdateCollapsed ()

Returns

-

Converts Controls definition into real controls.

Syntax

void CreateItemControls ([object item=null, bool recursive=true])

Returns

-

Adds control to ItemsControls array.

Syntax

void AddItemControl (object obj)

Returns

-

Removes control ftom ItemsControls array.

Syntax

void RemoveItemControl (object obj)

Returns

-

Prevents the updating of the list until the EndUpdate method is called.

Syntax

void BeginUpdate ()

Parameters

Returns

-

See also

EndUpdate

Performs the repaints deferred by a call to BeginUpdate.

Syntax

void EndUpdate ()

Parameters

Returns

-

See also

BeginUpdate

Sets current page.

Syntax

void SetPage (int page)

Returns

-

Constants

Switches to next page.

Syntax

void NextPage ()

Returns

-

Switches to previous page.

Syntax

void PrevPage ()

Returns

-

Switches to first page.

Syntax

void FirstPage ()

Returns

-

Switches to last page.

Syntax

void LastPage ()

Returns

-

Checks if previous page is available.

Syntax

bool IsPrevPageAvailable ()

Returns

TRUE if previous page is available.

Checks if next page is available.

Syntax

bool IsNextPageAvailable ()

Returns

TRUE if next page is available.

Returns page number by given item index.

Syntax

int PageByIndex (int index)

Returns

Page number.

Sets visible paging elements.

Syntax

void SetPagingType (int pagingtype [, bool update=true])

Returns

-

Sets number of items in list.

Syntax

void SetLength (int length)

Returns

-

Gets number of items in list.

Syntax

int GetLength ()

Returns

Number of items.

Determines if list is using dynamic data from server.

Syntax

bool IsDynamicData ()

Returns

TRUE if list loads dynamic data from server.

Gets current ngRPC for server data loading if dynamic.

Syntax

ngRPC GetRPC ()

Returns

Instance of ngRPC or null if not dynamic.

Provides access to top level items on current page.

Syntax

array GetPageTopItems ()

Returns

Array of items on current page.

Invalidates loaded data from server.

Syntax

void InvalidateData ([int idx=0, int cnt=max])

Returns

-

Invalidates data from server on current page.

Syntax

void Refresh ()

Returns

-

Switches to the first page, clears selection and invalidates all data loaded from server if list is dynamic.

Syntax

void Reset ([bool doclear=false])

Returns

-

Recursive scan items on current page.

Syntax

bool ScanPageItems (function scanfnc [, bool recursive=true, mixed userdata])

Returns

-

Recursive scan visible items on current page..

Syntax

bool ScanVisiblePageItems (function scanfnc [, bool recursive=true, mixed userdata])

Returns

-

Shows default loading control, if available.

Syntax

void ShowLoading (bool visible)

Returns

-