|
(SST) ShlWAPIFunctionInfo Version 1.0 |
|---|---|
| Developer Reference |
| Determines how many, if any, items in a TSSTAdvancedListView are checked. |
| Scope |
|---|
| Protected (i.e. the method can only be accessed from code in a descendant class or the unit it which it is implemented). |
| Syntax | |
|---|---|
| Function RetNumChecked() : INTEGER; | |
| Parameters | |
|---|---|
| None | |
| Return Values |
|---|
| If the inherited, CheckBoxes proprerty is TRUE, the returned, signed, 32-bit, integer value is the number of TListItems in the TListView that are checked. If checkboxes are not displayed, next to the item captions (i.e. the CheckBoxes property is FALSE), the function returns -1 (= $FFFF FFFF). |
| Remarks |
|---|
| The returned integer value is also available in the form of property NumChecked, and reading the property should be preferred to calling the RetNumChecked function directly. |
| In a first step the function queries property CheckBoxes. If CheckBoxes is TRUE, it proceeds by iterating through all items to determine how many of them are checked. If CheckBoxes is FALSE, the function exits, returning -1. |
| The function name is not RetCheckedCount (or GetCheckedCount), which would be more in keeping with the Delphi SDK naming conventions, in order to avoid naming conflicts with other declarations/implementations. |
| Requirements | |
|---|---|
| Unit | (Declared and implemented in) SSTNewUnit.pas |
| Library | SSTNewUnit.dcu/SSTNewUnit.obj |
| Unicode | Implemented as ANSI version only. |
| See Also |
|---|
| TSSTAdvancedListView, Methods, NumChecked, CheckSelected, UnCheckSelected, DeSelectAll, SelectAll. |
| Windows APIs: |
|
Document/Contents version 1.00 Page/URI last updated on April 30, 2022 |
Copyright © Stoelzel Software Technologie (SST) 2010 - 2017 |
Suggestions and comments mail to: webmaster@stoelzelsoftwaretech.com |