JVCL Help:GetItemCheckedState

 JVCL Help: GetItemCheckedState function

JVCL Functions

► JvDataProvider.pas Functions

[+] JvDataProvider.pas Functions

JEDI Visual Component Library Help

• Packages
• Files
  • Classes
  • Interfaces
  • Functions
  • Variables
  • Constants
  • Types
  • Records
• Project summary
• License

Search in JVCL Help

 

Search in all projects

 

Summary

Retrieve the checked state of the specified item.

run\JvDataProvider.pas

Pascal

 run\JvDataProvider.pas

 functionGetItemCheckedState(Item: IJvDataItem): TDataItemState;

Parameters

Parameters	Description
Item: IJvDataItem	Item to determine the checked state of.

run\JvDataProvider.pas

Description

GetItemCheckedState determines the checked state for the specified item. The following rules apply to determine the checked state:

• If a consumer is selected into the provider and the consumer supports theIJvDataConsumerItemState interface, the checked state is retrieved from the IJvDataConsumerItemState.Checked method.
• If the above did not apply or resulted in the disNotUsed state and the specified item supports the IJvDataItemStates, the state is copied from the IJvDataItemStates.Checked property.
• If both of the rules above did not apply, the result will be disUnused.
  

This function is often used by consumer sub services and/or provider implementations (e.g. rendering implementations) to determine the correct state for drawing.

run\JvDataProvider.pas

See Also

GetItemEnabledState, GetItemVisibleState, IJvDataConsumerItemState, IJvDataItemStates

run\JvDataProvider.pas

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

The JEDI Visual Component Library source is hosted at : link to view the current source code, link to the subversion repository