|
(SST) ShlWAPIFunctionInfo Version 1.0 |
|---|---|
| Developer Reference |
| Acquires a window handle to the in-place edit control/field of the TListItem that is currently being edited. |
| 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 RetEditHandle() : HWND; | |
| Parameters | |
|---|---|
| None | |
| Return Values |
|---|
| If a TListItem is being edited at the time of the call, the returned, unsigned, 32-bit integer, of type HWND, is a non-zero value, that is the window handle of the in-place edit control. If an item is not being edited, the function returns 0. |
| Remarks |
|---|
| The returned window handle is also available in the form of property EditHandle, and reading the property should be preferred to calling the RetEditHandle function directly. |
| The function calls the inherited, TCustomListView IsEditing method to determine if an item is currently being edited. If IsEditing returns TRUE, it calls the ListView_GetEditControl function/macro to obtain the returned window handle. Otherwise, the function simply exits, returning 0. |
| The returned handle should never be freed/destroyed (for example by calling DestroyWindow). |
| Requirements | |
|---|---|
| Unit | (Declared and implemented in) SSTNewUnit.pas |
| Library | SSTNewUnit.dcu/SSTNewUnit.obj |
| Unicode | Implemented as ANSI version only. |
| See Also |
|---|
| TSSTAdvancedListView, Methods, EditHandle, CopyEditText, CutEditText, PasteEditText, ClearEditText, ClearEditSel, EditSelectAll. EditClearUndo, EditUndo, EditCanUndo. |
| Windows APIs: ListView_GetEditControl. |
|
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 |