SftBox/OCX 4.5

SftBoxItems Object (ISftBoxItems Interface)

Softel vdm, Inc.

The SftBoxItems object describes all items in a SftBox/OCX control. The SftBoxItems object can be accessed through the control's Items property. A control has only one SftBoxItems object.
 
An individual item's SftBoxItem object can be accessed through the control's Item property.

Properties and methods shown grayed are provided for compatibility with older releases only and should no longer be used.

Property/Method

Description

Add

Adds a new item.

AddFontNames

Adds a list of available fonts.

AddFontSizes

Adds a list of available font sizes.

AddFontStyles

Adds a list of available font styles.

Appearance

Defines the appearance of all items.

BackColor

Defines the default background color for all items.

BackColorOdd

Defines the default background color for all items in odd numbered rows.

Clear

Removes all items.

ClearCellImages

Removes the cell images from all items.

ClearCellPictures

Removes all cell pictures.

ClearItemImages

Removes the item images from all items.

ClearLabelImages

Removes the label images from all items.

ClearLabelPictures

Removes all label pictures.

ClearPictures

Removes all item pictures.

Collapse

Collapses all items so no child items are visible.

Copy

Copies an item.

CopyAfter

Copies items to a new position in the control.

Count

Returns the number of items in the control.

CursorSelect

Defines the selection behavior of cursor movement.

DeleteEvent

Defines the use of the ItemDeleted event.

DropHighlightStyle

Defines the appearance of the drop target item (Items.DropIndex property).

DropHilightColor

Defines the color used for the drop target (Items.DropIndex property).

DropIndex

Defines the drop target item.

DropScrolling

Defines automatic vertical scrolling when using the Items.DropIndex property.

DropTargetInnerBorderColor

Defines the inner border color for items as drop targets during a drag & drop operation.

DropTargetInnerFill1

Defines the starting color used to fill the selection outline for items as drop targets during a drag & drop operation.

DropTargetInnerFill2

Defines the ending color used to fill the selection outline for items as drop targets during a drag & drop operation.

DropTargetOutlineBorderColor

Defines the outline border color for items as drop targets during a drag & drop operation.

Expand

Expands all items so their dependents become visible.

Find

Searches items using text.

FindCellData

Searches cell data (Cell.Data property).

FindCellDataTag

Searches cell data (Cell.DataTag property).

FindCellDataTagV

Searches cell data (Cell.DataTag property).

FindCellDataV

Searches cell data (Cell.Data property).

FindCellTag

Searches cell data (Cell.DataTag property).

FindCellTagV

Searches cell data (Cell.Tag property).

FindCellValue

Searches cell data (Cell.Value property).

FindCellValueV

Searches cell values (Cell.Value property).

FindDataTag

Searches item data (Item.DataTag property).

FindTag

Searches item data (Item.DataTag property).

FirstShown

Returns the index of the first visible item in the combo box control.

FlybyHighlight

Defines whether items are underlined as the mouse cursor moves over an item.

ForeColor

Defines the default foreground color for all items.

ForeColorOdd

Defines the default foreground color for all items in odd numbered rows.

GetPosition

Returns the current item's position and dimensions in the edit or static portion.

GetPositionPix

Returns the current item's position and dimensions in the edit or static portion in pixels.

GetPositionV

Returns the current item's position and dimensions in the edit or static portion.

GrayedColor

Defines the default foreground color for all disabled items.

GridHorizontalColor

Defines the color used for horizontal grid lines.

GridStyle

Defines the use of grid lines.

GridVerticalColor

Defines the color used for vertical grid lines.

Height

Returns the height of items (fixed height control only).

HeightPix

Returns the height of items in pixels (fixed height control only).

HilightColor

Defines the color used for highlighted edges (Items.Appearance property).

HitTest

Returns the item found at given coordinates.

HitTestCell

Returns the cell found at given coordinates.

HitTestCellPix

Returns the cell found at given coordinates in pixels.

HitTestCellV

Returns the cell found at given coordinates.

HitTestPix

Returns the item found at given coordinates in pixels.

HitTestV

Returns the item found at given coordinates.

HorizontalExtent

Defines the current horizontal scrolling extent.

HorizontalOffset

Defines the horizontal scrolling offset.

HotInnerBorderColor

Defines the inner border color for items when the mouse cursor is on the item.

HotInnerFill1

Defines the starting color used to fill the selection outline for items when the mouse cursor is on the item.

HotInnerFill2

Defines the ending color used to fill the selection outline for items when the mouse cursor is on the item.

HotOutlineBorderColor

Defines the outline border color for items when the mouse cursor is on the item.

Indentation

Defines the indentation for item levels.

IndentationPix

Defines the indentation for item levels.

InheritBackColor

Defines the color use of the area to the left of the first column.

Insert

Inserts a new item.

InsertAfter

Inserts a new item following the specified index position.

ItemImageExpandable

Defines the default graphic used to display an expandable item's item image.

ItemImageExpanded

Defines the default graphic used to display an expanded item's item image.

ItemImageLeaf

Defines the default graphic used to display a leaf item's item image.

ItemIndex

Returns the item index given an item ID.

LastShown

Returns the index of the last visible item in the combo box control.

Lines

Defines the maximum number of text lines for all items.

MaxHeightPix

Defines the maximum height of all items.

MinHeightPix

Defines the minimum height of all items.

Move

Moves an item.

MoveAfter

Moves items to a new position in the combo box control.

NoFocusStyle

Defines the display style of selected items when the control does not have the input focus.

OutlineStyle

Defines the display style of the selection outline.

RecalcHorizontalExtent

Recalculates the optimal horizontal scrolling extent.

Remove

Deletes an item.

Select

Searches items using text and selects the item found.

SelectBackColor

Defines the default background color for selected items when the controls has the input focus.

SelectBackColorNoFocus

Defines the default background color for selected items when the controls does not have the input focus.

SelectEnabledItemsOnly

Defines whether only enabled items can be selected by the user using the mouse or keyboard.

SelectForeColor

Defines the default foreground color for selected items when the controls has the input focus.

SelectForeColorNoFocus

Defines the default foreground color for selected items when the controls does not have the input focus.

SelectHotInnerBorderColor

Defines the inner border color for selected items when the mouse cursor is on the item.

SelectHotInnerFill1

Defines the starting color used to fill the selection outline for selected items when the mouse cursor is on the item.

SelectHotInnerFill2

Defines the ending color used to fill the selection outline for selected items when the mouse cursor is on the item.

SelectHotOutlineBorderColor

Defines the outline border color for selected items when the mouse cursor is on the item.

SelectInnerBorderColor

Defines the inner border color for selected items.

SelectInnerFill1

Defines the starting color used to fill the selection outline for selected items.

SelectInnerFill2

Defines the ending color used to fill the selection outline for selected items.

Selection

Defines the currently selected item.

SelectionStyle

Defines the appearance of the currently selected item.

SelectNoFocusInnerBorderColor

Defines the inner border color for selected items when the control does not have the input focus.

SelectNoFocusInnerFill1

Defines the starting color used to fill the selection outline for selected items when the control does not have the input focus.

SelectNoFocusInnerFill2

Defines the ending color used to fill the selection outline for selected items when the control does not have the input focus.

SelectNoFocusOutlineBorderColor

Defines the outline border color for selected items when the control does not have the input focus.

SelectOutlineBorderColor

Defines the outline border color for selected items.

ShadowColor

Defines the color used for dark edges (Items.Appearance property).

Sort

Sorts items.

Style

Defines the fixed/variable height style of all items.

Top

Defines the first item displayed in the drop down portion.

TreeLineColor

Defines the color used for tree lines connecting related items.

TreeLineGrayedColor

Defines the color used for tree lines of disabled items.

TreeLineStyle

Defines the appearance of tree lines connecting related items.

Properties and methods shown grayed are provided for compatibility with older releases only and should no longer be used.

See Also  Object Hierarchy


Feedback / comments / error reports for this topic
© 2008 - Softel vdm, Inc. - www.softelvdm.com