HeaderPane
Main
Hide
Share Link
Print

C/C++ API

Direct calls to the SftBox DLLs are used to communicate with the combo box control for maximum efficiency.

The class CSftBox defines all necessary functions to communicate with the combo box control.

The API Reference section lists C and C++ macros and functions. They are sorted alphabetically, but leading SftBox_, SftBox_Get and SftBox_Set text is not considered. E.g., when looking up the function SftBox_GetCurSel, look for topic CurSel, the leading SftBox_Get is dropped.

Definitions and Structures

NameDescription
LPFNSFTBOX_VGETITEMDefines the type of the virtual data source callback used by SftBox/DLL to retrieve information about one item as it is needed by the combo box control.
LPFNSFTBOX_VRELEASEITEMDefines the type of the virtual data source callback called by SftBox/DLL to release information previously returned by the LPFNSFTBOX_VGETITEM callback.
NM_SFTBOX_CHARThe NM_SFTBOX_CHAR structure is sent to the parent window with a WM_NOTIFY message (notification code NM_SFTBOX_CHAR_CODE) when a character is typed while the combo box control has the input focus.
NM_SFTBOX_KEYDOWNThe NM_SFTBOX_KEYDOWN structure is sent to the parent window with a WM_NOTIFY message (notification code NM_SFTBOX_KEYDOWN_CODE) when a key is pressed while the combo box control has the input focus.
NM_SFTBOX_KEYUPThe NM_SFTBOX_KEYUP structure is sent to the parent window with a WM_NOTIFY message (notification code NM_SFTBOX_KEYUP_CODE) when a key is released while the combo box control has the input focus.
SFT_PICTUREUsed to describe a picture component (a bitmap, icon or ImageList image, etc.).
SFTBOX_CELLThe SFTBOX_CELL structure is used with GetCellInfo and SetCellInfo to retrieve and set cell attributes and as part of the SFTBOX_ITEM structure (for a virtual data source).
SFTBOX_CELLINFOPARMThe SFTBOX_CELLINFOPARM structure is used as parameter for GetCellInfo and SetCellInfo to retrieve and set cell attributes.
SFTBOX_CLASSThe SFTBOX_CLASS preprocessor symbol defines the window class name of a combo box control.
SFTBOX_COLORSThe SFTBOX_COLORS structure is used with GetCtlColors and SetCtlColors to retrieve and set a combo box control's color attributes.
SFTBOX_COLUMNThe SFTBOX_COLUMN structure is used with GetColumns and SetColumns to retrieve and set column attributes.
SFTBOX_CONTROLThe SFTBOX_CONTROL structure is used with GetControlInfo and SetControlInfo to retrieve and set a combo box control's attributes.
SFTBOX_DELETEPARMThe SFTBOX_DELETEPARM structure is used as parameter for SetDeleteCallback to define an application-specific deletion callback routine, which is called whenever an item is removed from the combo box control.
SFTBOX_DELETEPROCDefines the type of a user-supplied callback routine, called by SftBox/DLL whenever an item is removed from the combo box control.
SFTBOX_DRAGINFOThe SFTBOX_DRAGINFO structure is used during drag & drop operations and can be retrieved using GetDragInfo.
SFTBOX_DWORD_PTRDefines a type large enough to hold a DWORD or a pointer value.
SFTBOX_IDDefines the type of an item ID.
SFTBOX_ITEMThe SFTBOX_ITEM structure is used by the callback function LPFNSFTBOX_VGETITEM to return the requested item information to SftBox/DLL when a virtual data source is used.
SFTBOX_MAXLEVELSThe SFTBOX_MAXLEVELS preprocessor symbol defines the highest item level supported.
SFTBOX_NOCOLORThe SFTBOX_NOCOLOR preprocessor symbol is used to indicate that the default color should be used.
SFTBOX_ROWThe SFTBOX_ROW structure is used with GetRowInfo and SetRowInfo to retrieve and set row header attributes and as part of the SFTBOX_ITEM structure (for a virtual data source).
SFTBOX_ROWINFOPARMThe SFTBOX_ROWINFOPARM structure is used as parameter for GetRowInfo and SetRowInfo to retrieve and set row header attributes.
SFTBOX_SORTPROCDefines the type of a user-supplied callback routine, called by SftBox/DLL to compare two items while sorting items using SortItems.
SFTBOX_SORTPROCEXDefines the type of a user-supplied callback routine, called by SftBox/DLL to compare two items while sorting items using SortItemsEx.
SFTBOX_STATICThe SFTBOX_STATIC preprocessor symbol selects static linking of SftBox/DLL to an application.
SFTBOX_TOOLTIPSPARMThe SFTBOX_TOOLTIPSPARM structure is used as parameter for SetToolTipsCallback, to define an application-specific ToolTips callback routine, which can define the ToolTip text when a ToolTip or ScrollTip is to be displayed.
SFTBOX_TOOLTIPSPROCDefines the type of a user-supplied callback routine, called by SftBox/DLL to allow an application to define the text shown when a ToolTip or ScrollTip is about to be displayed.
SFTBOX_VIRTUALDEFThe SFTBOX_VIRTUALDEF structure is used by VirtualInitialize to use the combo box control in virtual mode and to define the virtual data source.

Functions

NameDescription
AddStringAdds a new item to a combo box control. The new item is added as the last item at level 0.
ButtonsRegisters the size and sets the images used for expand/collapse buttons.
CalcCellFromPointCalculates the item index and column number given a point in combo box control client area coordinates.
CalcIndexFromPointCalculates the item index number given a point in combo box control client area coordinates.
CalcOptimalColumnWidthCalculates a column's optimal width so text and pictures are not clipped.
CalcOptimalRowHeaderWidthCalculates the optimal width for row headers so text and pictures are not clipped.
CaretColumnReturns the column where a mouse button was last clicked.
CellInfoDefines a cell's attributes.
CellRectReturns a cell's location.
ClearDeletes the selected text in the edit control portion, or removes the selection of a dropdown list combo box.
ColHeaderFontDefines the font used for column header text display.
CollapseCollapses a parent item.
ColumnsDefines the number of columns and column attributes.
ControlInfoDefines the combo box control's attributes.
CopyCopies text to the clipboard.
CopyItemCopies an item to a new position.
CountReturns the number of items in the combo box control.
CreateCreates a combo box control window and attaches it to the CSftBox object.
CrossColumnResizeDefines whether multiple columns can be resized during one column resizing operation.
CSftBox Constructor / DestructorStandard constructor and destructor.
CtlColorsDefines the combo box control's color attributes.
CurSelDefines the index of the selected item.
CustomCodeDefines optional product customization.
CutCopies text to the clipboard and removes it from the combo box control.
DarkModeDefines whether the combo box control is rendered using a dark color palette.
DeleteCallbackDefines a deletion callback routine, called when items are deleted.
DeleteDependentsDeletes an item's dependent items.
DeleteStringDeletes an item.
DependentReturns dependent item information for a parent item.
DependentCountReturns the number of dependents for a parent item.
DisableNoScrollDefines the scroll bar handling status.
DisplayColumnReturns the display column number given a real column number.
DPIReturns the effective DPI for the monitor the combo box control is currently displayed on.
DragInfoReturns drag & drop operation information in a SFTBOX_DRAGINFO structure.
DragTypeDefines the portions of the combo box control where a drag & drop operation can start.
DrawSelectionOutlineDraws a selection outline.
DropDownButtonDroppedPictureDefines the picture displayed on the dropdown button while the dropdown portion is shown.
DropDownButtonPictureDefines the picture displayed on the dropdown button.
DropDownButtonRectReturns the location of the dropdown button.
DropDownButtonStyleDefines the dropdown button's display style.
DropDownOptimalWidthDefines whether the dropdown portion is sized to its optimal width.
DropDownPositionDefines whether the dropdown portion is shown below or above the combo box.
DropHighlightDefines the current drag & drop target location.
DropHighlightStyleDefines the display attribute of the current drag & drop target item.
DroppedControlRectReturns the location of the dropdown portion.
DroppedHeightDefines the height of the dropdown portion.
DroppedStateReturns whether the dropdown portion is currently shown.
DroppedWidthDefines the width of the dropdown portion.
EditAlignDefines the text alignment in the edit control portion.
EditCtlFontDefines the font used in the edit control portion.
EditSearchColumnDefines the column used for searching and for the text shown in the edit control portion.
EditSearchModeDefines how the combo box control searches for a matching item as the user types.
EditSelDefines the selected text range in the edit control portion.
EnableSortIndicatorsEnables sort indicators in column headers.
ExpandExpands a parent item.
ExpandCollapseIndexReturns the zero-based index of the item to expand/collapse.
ExtendedUIDefines whether the extended user interface is used.
FindItemSearches item data.
FindStringSearches a string.
FindStringExSearches cells for a string.
FindStringExactSearches a string (exact match).
FirstDisplayColumnReturns the index of the first displayed column.
FlybyHighlightDefines whether the item under the mouse cursor is highlighted in the dropdown portion.
FontsAdds the names of the available fonts to the combo box control.
FontSizesAdds the available sizes of a font to the combo box control.
FontStylesAdds the available styles of a font to the combo box control.
FreeGDIPlusImageLoadedFromFileDeletes a GDI+ image obtained using LoadGDIPlusImageFromFile.
FreeGDIPlusImageLoadedFromResourceDeletes a GDI+ image obtained using LoadGDIPlusImageFromResource.
GDIPlusAvailableReturns whether GDI+ support is available.
GridStyleDefines the grid line display style.
HeaderDefines a column's header text.
HeaderButtonDefines the column number of the currently pressed column header button.
HeaderLengthReturns the length of a column's header text.
HeaderRectReturns the dimensions of the column header area.
HeaderStyleDefines the column header display style.
HighContrastModeDefines whether the combo box control honors the Windows High Contrast accessibility setting.
HorizontalExtentDefines the horizontal extent (in pixels) of the displayable area.
HorizontalOffsetDefines the current horizontal offset (in pixels) of the displayed area.
HoverButtonDefines whether the dropdown button changes its appearance when the mouse cursor is located on the button.
HWNDDropDownReturns the window handle of the dropdown portion.
HWNDDropDownButtonReturns the window handle of the dropdown button.
HWNDEditReturns the window handle of the edit control portion.
ImageScalingDefines how images drawn by the combo box control are scaled relative to the current monitor DPI.
IndentationDefines the indentation (in pixels) for item levels.
InheritBgColorDefines whether the area to the left of the first cell inherits the cell's background color.
InsertStringInserts a new item using a string.
ItemBitmapDefines an item's item picture using a bitmap handle.
ItemDataDefines an item's application-specific value.
ItemExpandDefines an item's expand status.
ItemExpandableDefines whether an item is expandable.
ItemHeightReturns an item's height (in pixels).
ItemHeightMinMaxDefines an item's minimum and maximum height (in pixels).
ItemIDReturns an item's ID.
ItemIndexReturns an item's index given an item ID.
ItemLabelDefines an item's label picture using a bitmap handle.
ItemLabelPictureDefines an item's label picture.
ItemLevelDefines an item's level number.
ItemLinesDefines the number of text lines used for item height calculation.
ItemPictureDefines an item's item picture.
ItemRectReturns an item's location in client area coordinates.
ItemShownDefines an item's visibility status.
ItemsShownReturns the number of items displayable in the dropdown portion, including partial items.
ItemStatusDefines an item's enabled/disabled status.
LimitTextLimits the number of characters the user can enter in the edit control portion.
LoadGDIPlusImageFromFileLoads a GDI+ image from a file.
LoadGDIPlusImageFromResourceLoads a GDI+ image from an application's or DLL's resources.
LocaleDefines the locale of the combo box control.
MakeColumnOptimalSets the optimal column width so that the text and pictures of all items can be displayed without being clipped horizontally.
MakeColumnVisibleScrolls the specified column into view horizontally so that it is displayed in the combo box control.
MakeRowHeaderOptimalSets the optimal row header width so that the text and pictures of all row headers can be displayed.
MakeRowVisibleScrolls the specified item into view vertically so that it is displayed in the dropdown portion.
MoveItemMoves an item to a new position.
NextShownReturns the next visible item.
NoFocusStyleDefines the display style of the selected item when the combo box control does not have the input focus.
OpenEndedDefines whether the last column is open-ended.
OverheadWidthReturns the width of the area added to the first column for hierarchical graphics components.
ParentReturns an item's parent index.
PasteInserts the clipboard contents in the edit control portion.
PicturesRegisters the size and sets the default item pictures used for all items.
PixelScalingDefines how caller-supplied pixel dimensions (column widths, indentation, etc.) are interpreted relative to the current monitor DPI.
PrevShownReturns the previous visible item.
ProcessMessageDefines whether a mouse click that hides the dropdown portion is also processed by the window under the mouse cursor.
ReadOnlyDefines whether the edit control portion is read-only.
RealColumnReturns the real column number given a display column number.
RecalcHorizontalExtentRecalculates the optimal horizontal scrolling extent.
RegisterAppRegisters an application with SftBox/DLL.
ReorderColumnsDefines whether columns can be reordered using column drag & drop.
ResetContentRemoves all items from the combo box control.
ResizeColumnReturns the column number of the column being resized.
ResizeHeaderDefines whether column headers are resizable by the user.
RollUpDelayedHides the dropdown portion after the specified time.
RollupOnChangeDefines whether the dropdown portion is hidden when items are added or removed.
RowColBitmapDefines the picture displayed in the row/column header.
RowColBitmapStyleDefines the position of the picture displayed in the row/column header.
RowColHeaderButtonDefines whether the row/column header button is currently down (pressed).
RowColHeaderRectReturns the dimensions of the row/column header area.
RowColHeaderStyleDefines the position of the text displayed in the row/column header.
RowColPictureDefines the picture displayed in the row/column header.
RowColTextDefines the row/column header text.
RowColTextLengthReturns the row/column header text length.
RowHeaderFontDefines the font used for row header text display.
RowHeaderLinesDefines the number of text lines used for row header height calculation.
RowHeaderRectReturns the dimensions of the row header area.
RowHeaderStyleDefines the position of text displayed in the row headers.
RowHeaderWidthDefines the width of the row header area.
RowInfoDefines an item's row header attributes.
RowTextDefines an item's row header text.
RowTextLengthReturns an item's row header text length.
ScrollTipsDefines whether ScrollTips are displayed during vertical scrolling.
SelectionStyleDefines the display style of the selected item.
SelectStringSearches a string and selects the matching item.
SelectStringExactSearches a string and selects the exactly matching item.
SelTextDefines the selected text in the edit control portion.
SelTextLengthReturns the length of the selected text in the edit control portion.
Show3DDefines the current display method used for items.
ShowBitmapsReturns a value indicating the presence of item pictures.
ShowButton0Defines the presence of level 0 expand/collapse buttons.
ShowButtonsDefines the presence of expand/collapse buttons (other than level 0).
ShowDropDownShows or hides the dropdown portion.
ShowGridDefines the presence of grid lines.
ShowHeaderDefines the presence and display style of column headers.
ShowHeaderDropDownDefines the presence of column headers in the dropdown portion.
ShowHeaderMainDefines the presence of column headers in the static portion.
ShowLabelsReturns the presence of label pictures.
ShowResizerDefines whether the dropdown portion can be resized by the user.
ShowRowColHeaderButtonDefines the row/column header's display style.
ShowRowHeaderDefines the row header display style.
ShowTreeLinesDefines the presence of tree lines.
ShowTruncatedDefines whether text is clipped or truncated using trailing "...".
SiblingReturns an item's sibling information.
SizeBoxDefines whether a size box is shown in the lower-right corner of the dropdown portion so the user can resize the dropdown portion by dragging it.
SortItemsSorts items.
SortItemsExSorts items using cell and item information.
TextDefines an item's cell text.
TextLengthReturns the length of an item's cell text.
ToolTipsCallbackDefines an application supplied callback function, which can define the ToolTip text when a ToolTip or ScrollTip is to be displayed.
TopIndexDefines the index number of the item shown at the top of the dropdown portion.
TopParentReturns the highest level parent index number for an item.
TreeLineStyleDefines the display style of tree lines.
UnregisterAppUnregisters an application from SftBox/DLL.
UpdateCaretExpandCollapseDefines whether the current item is updated when the expand/collapse buttons are used.
UserDataDefines the combo box control's application-specific value.
UseSmoothScrollDefines whether smooth scrolling is used.
UseThemesDefines whether the control can use Windows themes.
VAlignDefines the vertical alignment of tree lines, label pictures and item pictures.
VirtualCountDefines the number of items when using a virtual data source.
VirtualFlushDiscards cached item information of a combo box control using a virtual data source.
VirtualInitializeInitializes a combo box control for virtual mode and for use with a virtual data source.
VirtualItemChangedNotifies a combo box control using a virtual data source that items have been changed.

Last Updated 11/21/2026 - (email)
© 2026 Softel vdm, Inc.