JVCL Help:IJvDataConsumerItemSelect.SetItem

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

Search in JVCL Help

 
Search in all projects
 

Summary

Specify a new (root) item.


Pascal

 procedureSetItem(Value: IJvDataItem);


Parameters

Parameters Description
Value: IJvDataItem Item to be used as the active item or root item. Specify nil to use no item or use the entire tree.


Description

SetItem selects a new (root) item for the consumer.
For consumers that only allow a single item to be used, the new item is the item used by the consumer (specify nil if no item is to be selected).
For consumers that allow multiple items to be rendered, the new item is the item used as a root (specify nil if the entire tree is to be used). The consumer will only use items that are a child of the specified item; the item itself is not used.
If the specified item does not belong to the provider linked to the consumer or does not exist within the current active context of the consumer, and exception will be raised.


See Also

IJvDataConsumerContext, IJvDataConsumerItemSelect.GetItem, IJvDataItem


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