JVCL Help:IJvDataItems.GetItemByID

From Project JEDI Wiki
Jump to navigationJump to search
JEDI Visual Component Library Help

Search in JVCL Help

 
Search in all projects
 

Summary

Retrieve an item from the list given its ID (or ID path).


Pascal

 functionGetItemByID(ID: string): IJvDataItem;


Parameters

Parameters Description
ID: string The ID or ID-path of the item to retrieve.


Description

GetItemByID retrieves a Data Item from the list given its ID or ID-path. Each item will be in tiated with an ID value which should be unique throughout the tree - although this is not enforced

  • and this method allows to retrieve an item given that ID.

The path is always considered relative to this list. If the ID string starts with a backslash (or forward slash; both are allowed), the path is considered from the root of the provider (GetProvider.GetItems).
Each '..' is considered as '1 level up the tree'.
As soon as a term in the path can't be retrieved the entire result will be nil. This can happen when to many '..' terms appear or one of the ID's in the path can't be found.


See Also

IJvDataItem.GetID, IJvDataItems.GetItem, IJvDataItems.GetItemByIndexPath


About

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page