SftTree/DLL 7.5 - Tree Control

ItemIgnore

Defines whether the item is excluded from optimal column width and row header width calculation.

C

BOOL WINAPI SftTree_GetItemIgnore(HWND hwndCtl, int index);
BOOL WINAPI SftTree_SetItemIgnore(HWND hwndCtl, int index, BOOL fIgnore);
BOOL WINAPI SftTreeSplit_GetItemIgnore(HWND hwndCtl, int index);
BOOL WINAPI SftTreeSplit_SetItemIgnore(HWND hwndCtl, int index, BOOL fIgnore);

C++

BOOL CSftTree::GetItemIgnore(int index) const;
BOOL CSftTree::SetItemIgnore(int index, BOOL fIgnore = TRUE);
BOOL CSftTreeSplit::GetItemIgnore(int index) const;
BOOL CSftTreeSplit::SetItemIgnore(int index, BOOL fIgnore = TRUE);

Parameters

hwndCtl

The window handle of the tree control.

index

The zero-based index of the item which is to be excluded from optimal column width and row header width calculation.

fIgnore

Set to TRUE to exclude the item index from optimal column width and row header width calculation, otherwise set to FALSE.

Returns

GetItemIgnore returns TRUE if the item is excluded from optimal column width and row header width calculation, otherwise FALSE is returned.

SetItemIgnore returns TRUE if the function was successful, otherwise FALSE is returned.

Comments

The GetItemIgnore and SetItemIgnore functions define whether the item is excluded from optimal column width and row header width calculation.

If an item is ignored, CalcOptimalColumnWidth, CalcOptimalRowHeaderWidth, MakeColumnOptimal and MakeRowHeaderOptimal will not consider the item when calculating the optimal column or row header width.

Individual cells can be ignored using the SetCellInfo function by setting the value SFTTREECELL_IGNORE in the flag2 member of the SFTTREE_CELL structure.

In a tree control using a virtual data source, SetItemIgnore cannot be used and an error is returned. The flag2 member of the SFTTREE_ITEM structure is used instead.

See Also C/C++ API | Categories | Notifications