ICheckBox Interface Reference

The main interface (checkbox) More...

Inherits IDispatch.

Public Member Functions
HRESULT	About (void)
	Displays the control's credits More...
HRESULT	Click (void)
	Clicks the checkbox by code More...
HRESULT	GetControlState ([out, retval] ControlStateConstants *pControlState)
	Retrieves a bit field describing the control's state More...
HRESULT	GetIdealSize ([in, out, defaultvalue(0)] OLE_XSIZE_PIXELS *idealWidth, [in, out, defaultvalue(0)] OLE_YSIZE_PIXELS *idealHeight)
	Retrieves the control's optimal size More...
HRESULT	LoadSettingsFromFile ([in] BSTR file, [out, retval] VARIANT_BOOL *pSucceeded)
	Loads the control's settings from the specified file More...
HRESULT	Refresh (void)
	Advises the control to redraw itself
HRESULT	SaveSettingsToFile ([in] BSTR file, [out, retval] VARIANT_BOOL *pSucceeded)
	Saves the control's settings to the specified file More...
HRESULT	FinishOLEDragDrop (void)
	Finishes a pending drop operation More...

Properties
AppearanceConstants	Appearance [get, set]
	Controls the style of the control's outer border More...
VARIANT_BOOL	AutoToggleCheckMark [get, set]
	Controls how the control reacts to mouse clicks More...
OLE_COLOR	BackColor [get, set]
	Specifies the control's background color More...
BorderStyleConstants	BorderStyle [get, set]
	Controls the style of the control's inner border More...
VARIANT_BOOL	CheckMarkOnRight [get, set]
	Controls the checkmark's location relative to the control's caption More...
ContentTypeConstants	ContentType [get, set]
	Controls the type of the control's caption More...
DisabledEventsConstants	DisabledEvents [get, set]
	Controls which events are fired More...
VARIANT_BOOL	DontRedraw [get, set]
	Controls redrawing of the control More...
VARIANT_BOOL	Enabled [get, set]
	Controls whether the control accepts user input More...
IFontDisp	Font [get, set]
	Specifies the control's font More...
OLE_COLOR	ForeColor [get, set]
	Specifies the control's text color More...
HAlignmentConstants	HAlignment [get, set]
	Controls the horizontal alignment of the control's caption More...
OLE_HANDLE	hImageList [get, set]
	Specifies the control's associated imagelist More...
LONG	HoverTime [get, set]
	Controls when the MouseHover event is fired More...
OLE_HANDLE	hWnd [get]
	Retrieves the control's window handle More...
IconAlignmentConstants	IconAlignment [get, set]
	Controls the location of the control's icon More...
LONG	IconIndex ([in, defaultvalue(-1)] LONG controlState) [get, set]
	Specifies the control's icons More...
OLE_YSIZE_PIXELS	IconMarginBottom [get, set]
	Controls the location of the control's icon More...
OLE_XSIZE_PIXELS	IconMarginLeft [get, set]
	Controls the location of the control's icon More...
OLE_XSIZE_PIXELS	IconMarginRight [get, set]
	Controls the location of the control's icon More...
OLE_YSIZE_PIXELS	IconMarginTop [get, set]
	Controls the location of the control's icon More...
OLE_HANDLE	Image [get, set]
	Specifies the bitmap or icon displayed as caption More...
IPictureDisp	MouseIcon [get, set]
	Controls the control's mouse cursor More...
MousePointerConstants	MousePointer [get, set]
	Controls the control's mouse cursor More...
VARIANT_BOOL	MultiLine [get, set]
	Specifies whether the control displays text in multiple lines More...
VARIANT_BOOL	ProcessContextMenuKeys [get, set]
	Specifies whether the ContextMenu event can be invoked using the keyboard More...
VARIANT_BOOL	Pushed [get, set]
	Specifies whether the control is drawn like being pushed More...
VARIANT_BOOL	PushLike [get, set]
	Controls the control's appearance More...
VARIANT_BOOL	RegisterForOLEDragDrop [get, set]
	Controls the control's behavior in drag'n'drop operations More...
RightToLeftConstants	RightToLeft [get, set]
	Controls the control's right-to-left features More...
SelectionStateConstants	SelectionState [get, set]
	Specifies the state of the control's checkmark More...
StyleConstants	Style [get, set]
	Controls the control's appearance More...
VARIANT_BOOL	SupportOLEDragImages [get, set]
	Controls the control's behavior in drag'n'drop operations More...
BSTR	Text [get, set]
	Specifies the control's caption More...
OLE_YSIZE_PIXELS	TextMarginBottom [get, set]
	Controls the location of the control's caption More...
OLE_XSIZE_PIXELS	TextMarginLeft [get, set]
	Controls the location of the control's caption More...
OLE_XSIZE_PIXELS	TextMarginRight [get, set]
	Controls the location of the control's caption More...
OLE_YSIZE_PIXELS	TextMarginTop [get, set]
	Controls the location of the control's caption More...
VARIANT_BOOL	TriState [get, set]
	Specifies whether the control supports 3 states More...
VARIANT_BOOL	UseImprovedImageListSupport [get, set]
	Specifies whether the control uses code that makes usage of image lists easier More...
VARIANT_BOOL	UseSystemFont [get, set]
	Specifies whether the control uses the system font More...
VAlignmentConstants	VAlignment [get, set]
	Controls the vertical alignment of the control's caption More...
BSTR	Version [get]
	Retrieves the control's version More...

Detailed Description

The main interface (checkbox)

This is the checkbox control's main interface. It wraps the control window.

See also

_ICheckBoxEvents

Member Function Documentation

About()

HRESULT About

(

void

)

Displays the control's credits

Displays some information about this control and its author.

Click()

HRESULT Click

(

void

)

Clicks the checkbox by code

See also

_ICheckBoxEvents::Click

GetControlState()

HRESULT GetControlState

(

[out, retval] ControlStateConstants *

pControlState

)

Retrieves a bit field describing the control's state

Returns

A bit field of constants defined by the ControlStateConstants enumeration, that describe the control's state.

See also

Pushed, SelectionState, ControlStateConstants

GetIdealSize()

HRESULT GetIdealSize	(	[in, out, defaultvalue(0)] OLE_XSIZE_PIXELS *	idealWidth,
		[in, out, defaultvalue(0)] OLE_YSIZE_PIXELS *	idealHeight
	)

Retrieves the control's optimal size

Calculates the rectangle that best fits the control's text and image, if an imagelist is present.

Parameters

[out]	idealWidth	The control's optimal width in pixels.
[out]	idealHeight	The control's optimal height in pixels.

Remarks

Requires comctl32.dll version 6.0 or higher.

See also

Text, hImageList, TextMarginBottom, TextMarginLeft, TextMarginRight, TextMarginTop

LoadSettingsFromFile()

HRESULT LoadSettingsFromFile	(	[in] BSTR	file,
		[out, retval] VARIANT_BOOL *	pSucceeded
	)

Loads the control's settings from the specified file

Parameters

[in]

file

The file to read from.

Returns

True if the settings could be loaded; otherwise False.

See also

SaveSettingsToFile

SaveSettingsToFile()

HRESULT SaveSettingsToFile	(	[in] BSTR	file,
		[out, retval] VARIANT_BOOL *	pSucceeded
	)

Saves the control's settings to the specified file

Parameters

[in]

file

The file to write to.

Returns

True if the settings could be saved; otherwise False.

See also

LoadSettingsFromFile

FinishOLEDragDrop()

HRESULT FinishOLEDragDrop

(

void

)

Finishes a pending drop operation

During a drag'n'drop operation the drag image is displayed until the OLEDragDrop event has been handled. This order is intended by Microsoft Windows. However, if a message box is displayed from within the OLEDragDrop event, or the drop operation cannot be performed asynchronously and takes a long time, it may be desirable to remove the drag image earlier.
This method will break the intended order and finish the drag'n'drop operation (including removal of the drag image) immediately.

Remarks

This method will fail if not called from the OLEDragDrop event handler or if no drag images are used.

See also

_ICheckBoxEvents::OLEDragDrop, SupportOLEDragImages

Property Documentation

Appearance

AppearanceConstants Appearance

getset

Controls the style of the control's outer border

Retrieves or sets the kind of border that is drawn around the control. Any of the values defined by the AppearanceConstants enumeration is valid.

See also

BorderStyle, PushLike, Style, AppearanceConstants

AutoToggleCheckMark

VARIANT_BOOL AutoToggleCheckMark

getset

Controls how the control reacts to mouse clicks

Retrieves or sets whether the checkmark state is changed automatically if the user clicks on the control. If set to True, it is changed automatically; otherwise not.

See also

SelectionState, TriState, _ICheckBoxEvents::Click

BackColor

OLE_COLOR BackColor

getsetproperty

Specifies the control's background color

Retrieves or sets the control's background color.

Remarks

This property isn't supported for themed checkboxes.

See also

ForeColor

BorderStyle

BorderStyleConstants BorderStyle

getset

Controls the style of the control's inner border

Retrieves or sets the kind of inner border that is drawn around the control. Any of the values defined by the BorderStyleConstants enumeration is valid.

See also

Appearance, PushLike, Style, BorderStyleConstants

CheckMarkOnRight

VARIANT_BOOL CheckMarkOnRight

getsetproperty

Controls the checkmark's location relative to the control's caption

Retrieves or sets whether the control's checkmark is drawn to the right of the text specified by the Text property. If set to True, it is drawn to the right; otherwise to the left.

See also

RightToLeft, Text

ContentType

ContentTypeConstants ContentType

getset

Controls the type of the control's caption

Retrieves or sets what the control's caption consists of. Any of the values defined by the ContentTypeConstants enumeration is valid.

See also

Image, Text, ContentTypeConstants

DisabledEvents

DisabledEventsConstants DisabledEvents

getset

Controls which events are fired

Retrieves or sets the events that won't be fired. Disabling events increases performance. Any combination of the values defined by the DisabledEventsConstants enumeration is valid.

See also

DisabledEventsConstants

DontRedraw

VARIANT_BOOL DontRedraw

getset

Controls redrawing of the control

Enables or disables automatic redrawing of the control. Disabling redraw while doing large changes on the control may increase performance. If set to False, the control will redraw itself automatically; otherwise not.

Enabled

VARIANT_BOOL Enabled

getset

Controls whether the control accepts user input

Enables or disables the control for user input. If set to True, it reacts to user input; otherwise not.

Font

IFontDisp Font

getset

Specifies the control's font

Retrieves or sets the control's font. It's used to draw the caption.

See also

UseSystemFont, Text, ForeColor

ForeColor

OLE_COLOR ForeColor

getsetproperty

Specifies the control's text color

Retrieves or sets the control's text color.

Remarks

This property isn't supported for themed checkboxes.

See also

BackColor, Text, Font

HAlignment

HAlignmentConstants HAlignment

getset

Controls the horizontal alignment of the control's caption

Retrieves or sets the horizontal alignment of the control's caption. Any of the values defined by the HAlignmentConstants enumeration is valid.

See also

Text, VAlignment, IconAlignment, HAlignmentConstants

hImageList

OLE_HANDLE hImageList

getset

Specifies the control's associated imagelist

Retrieves or sets the handle to the imagelist containing the control's icons. If set to 0, no icon is drawn.
The icon's index in the imagelist specifies the control state it is used for:

• 0 - Used if the checkbox is in no special state.
• 1 - Used if the checkbox is in 'hot' state, i. e. it's below the mouse cursor.
• 2 - Used if the checkbox is pressed.
• 3 - Used if the checkbox is disabled.
• (4 - Used if the checkbox is the dialog's default button.)
• 5 - Used on Tablet PCs (I don't know when).

If the imagelist contains only one icon, it is used for all control states. If it contains more than one, but less than five (six on Tablet PCs), no icon will be drawn if the control is in a state that no icon is specified for.

Remarks

Requires comctl32.dll version 6.0 or higher.
The previously set image list does NOT get destroyed automatically.

See also

Image, Text, IconAlignment, UseImprovedImageListSupport, IconIndex, GetIdealSize

HoverTime

LONG HoverTime

getset

Controls when the MouseHover event is fired

Retrieves or sets the number of milliseconds the mouse cursor must be located over the control's client area before the MouseHover event is fired. If set to -1, the system hover time is used.

See also

_ICheckBoxEvents::MouseHover

hWnd

OLE_HANDLE hWnd

get

Retrieves the control's window handle

Retrieves the control's window handle.

Remarks

This property is read-only.

See also

_ICheckBoxEvents::RecreatedControlWindow, _ICheckBoxEvents::DestroyedControlWindow

IconAlignment

IconAlignmentConstants IconAlignment

getsetproperty

Controls the location of the control's icon

Retrieves or sets the alignment of the control's icon (which is taken from the imagelist specified by the hImageList property). Any of the values defined by the IconAlignmentConstants enumeration is valid.

Remarks

Requires comctl32.dll version 6.0 or higher.

See also

hImageList, HAlignment, VAlignment, IconAlignmentConstants

IconIndex

LONG IconIndex

getsetproperty

Specifies the control's icons

Retrieves or sets the zero-based indexes of the control's icons in the image list specified by the hImageList property. The control can use a different icon for each control state.

Parameters

[in]

controlState

The control state for the icon index shall be retrieved or set. If set to -1, the icon index is applied for all control states. The following control states exist: Icon 0 - Used if the checkbox is in no special state. Icon 1 - Used if the checkbox is in 'hot' state, i. e. it's below the mouse cursor. Icon 2 - Used if the checkbox is pressed. Icon 3 - Used if the checkbox is disabled. (Icon 4 - Used if the checkbox is the dialog's default button.) Icon 5 - Used on Tablet PCs (I don't know when). If a state's icon index is set to -1, no icon is drawn for this state.

Remarks

This property is ignored if the UseImprovedImageListSupport is set to False.

See also

UseImprovedImageListSupport, hImageList

IconMarginBottom

OLE_YSIZE_PIXELS IconMarginBottom

getsetproperty

Controls the location of the control's icon

Retrieves or sets the bottom margin (in pixels) of the control's icon (which is taken from the imagelist specified by the hImageList property).

Remarks

Requires comctl32.dll version 6.0 or higher.

See also

IconMarginLeft, IconMarginRight, IconMarginTop, hImageList

IconMarginLeft

OLE_XSIZE_PIXELS IconMarginLeft

getsetproperty

Controls the location of the control's icon

Retrieves or sets the left margin (in pixels) of the control's icon (which is taken from the imagelist specified by the hImageList property).

Remarks

Requires comctl32.dll version 6.0 or higher.

See also

IconMarginBottom, IconMarginRight, IconMarginTop, hImageList

IconMarginRight

OLE_XSIZE_PIXELS IconMarginRight

getsetproperty

Controls the location of the control's icon

Retrieves or sets the right margin (in pixels) of the control's icon (which is taken from the imagelist specified by the hImageList property).

Remarks

Requires comctl32.dll version 6.0 or higher.

See also

IconMarginBottom, IconMarginLeft, IconMarginTop, hImageList

IconMarginTop

OLE_YSIZE_PIXELS IconMarginTop

getsetproperty

Controls the location of the control's icon

Retrieves or sets the top margin (in pixels) of the control's icon (which is taken from the imagelist specified by the hImageList property).

Remarks

Requires comctl32.dll version 6.0 or higher.

See also

IconMarginBottom, IconMarginLeft, IconMarginRight, hImageList

Image

OLE_HANDLE Image

getsetproperty

Specifies the bitmap or icon displayed as caption

Retrieves or sets the image that is displayed as the control's caption if the ContentType property is set to ctBitmap or ctIcon.

Remarks

The image does NOT get destroyed automatically by the control.
Due to limitations in Windows' Button window class, checkboxes displaying a bitmap or icon won't use Windows XP themes.

See also

ContentType, Text, hImageList

MouseIcon

IPictureDisp MouseIcon

getset

Controls the control's mouse cursor

Retrieves or sets a user-defined mouse cursor. It's used if MousePointer is set to mpCustom.

See also

MousePointer, MousePointerConstants

MousePointer

MousePointerConstants MousePointer

getset

Controls the control's mouse cursor

Retrieves or sets the cursor's type that's used if the mouse cursor is placed within the control's client area. Any of the values defined by the MousePointerConstants enumeration is valid.

See also

MouseIcon, MousePointerConstants

MultiLine

VARIANT_BOOL MultiLine

getset

Specifies whether the control displays text in multiple lines

Retrieves or sets whether the control's caption is wrapped to multiple lines if it is too long to fit on a single line. If set to True, the text may be wrapped; otherwise not.

See also

Text

ProcessContextMenuKeys

VARIANT_BOOL ProcessContextMenuKeys

getset

Specifies whether the ContextMenu event can be invoked using the keyboard

Retrieves or sets whether the control fires the ContextMenu event if the user presses [SHIFT]+[F10] or [WINDOWS CONTEXTMENU]. If set to True, the event gets fired; otherwise not.

See also

_ICheckBoxEvents::ContextMenu

Pushed

VARIANT_BOOL Pushed

getset

Specifies whether the control is drawn like being pushed

Retrieves or sets whether the checkbox is drawn like being pushed. If set to True, it is drawn like being pushed; otherwise not.

See also

Click, GetControlState

PushLike

VARIANT_BOOL PushLike

getset

Controls the control's appearance

Retrieves or sets whether the checkbox is drawn like a push button. If set to True, it is drawn like a push button; otherwise it is drawn like a common checkbox.

See also

Appearance, BorderStyle, Style

RegisterForOLEDragDrop

VARIANT_BOOL RegisterForOLEDragDrop

getset

Controls the control's behavior in drag'n'drop operations

Retrieves or sets whether the control is registered as a target for OLE drag'n'drop. If set to True, the control accepts OLE drag'n'drop actions; otherwise not.

See also

SupportOLEDragImages, _ICheckBoxEvents::OLEDragEnter

RightToLeft

RightToLeftConstants RightToLeft

getsetproperty

Controls the control's right-to-left features

Enables or disables bidirectional features. Any combination of the values defined by the RightToLeftConstants enumeration is valid.

Attention

Changing this property destroys and recreates the control window.

See also

CheckMarkOnRight, RightToLeftConstants

SelectionState

SelectionStateConstants SelectionState

getset

Specifies the state of the control's checkmark

Retrieves or sets the state of the control's checkmark. Any of the values defined by the SelectionStateConstants enumeration is valid.

See also

AutoToggleCheckMark, TriState, GetControlState, SelectionStateConstants, _ICheckBoxEvents::SelectionStateChanged

Style

StyleConstants Style

getset

Controls the control's appearance

Retrieves or sets the control's drawing style. Any of the values defined by the StyleConstants enumeration is valid.

See also

Appearance, BorderStyle, PushLike, StyleConstants

SupportOLEDragImages

VARIANT_BOOL SupportOLEDragImages

getset

Controls the control's behavior in drag'n'drop operations

Retrieves or sets whether the control creates an IDropTargetHelper object, so that a drag image can be displayed during OLE drag'n'drop. If set to True, the control creates the object; otherwise not.

Remarks

Requires shell32.dll version 5.0 or higher.

See also

RegisterForOLEDragDrop, FinishOLEDragDrop, IDropTargetHelper

Text

BSTR Text

getsetproperty

Specifies the control's caption

Retrieves or sets the text that is displayed as the control's caption if the ContentType property is set to ctText.

See also

HAlignment, VAlignment, MultiLine, ForeColor, Font, ContentType, Image, hImageList, GetIdealSize

TextMarginBottom

OLE_YSIZE_PIXELS TextMarginBottom

getset

Controls the location of the control's caption

Retrieves or sets the bottom margin (in pixels) of the control's text.

Remarks

Requires comctl32.dll version 6.0 or higher.
Current versions of Windows don't seem to support text margins.

See also

TextMarginLeft, TextMarginRight, TextMarginTop, Text, GetIdealSize

TextMarginLeft

OLE_XSIZE_PIXELS TextMarginLeft

getset

Controls the location of the control's caption

Retrieves or sets the left margin (in pixels) of the control's text.

Remarks

Requires comctl32.dll version 6.0 or higher.
Current versions of Windows don't seem to support text margins.

See also

TextMarginBottom, TextMarginRight, TextMarginTop, Text, GetIdealSize

TextMarginRight

OLE_XSIZE_PIXELS TextMarginRight

getset

Controls the location of the control's caption

Retrieves or sets the right margin (in pixels) of the control's text.

Remarks

Requires comctl32.dll version 6.0 or higher.
Current versions of Windows don't seem to support text margins.

See also

TextMarginBottom, TextMarginLeft, TextMarginTop, Text, GetIdealSize

TextMarginTop

OLE_YSIZE_PIXELS TextMarginTop

getset

Controls the location of the control's caption

Retrieves or sets the top margin (in pixels) of the control's text.

Remarks

Requires comctl32.dll version 6.0 or higher.
Current versions of Windows don't seem to support text margins.

See also

TextMarginBottom, TextMarginLeft, TextMarginRight, Text, GetIdealSize

TriState

VARIANT_BOOL TriState

getset

Specifies whether the control supports 3 states

Retrieves or sets whether the control's checkmark supports 3 states. If set to True, it supports 3 states; otherwise only 2.

See also

SelectionState, AutoToggleCheckMark

UseImprovedImageListSupport

VARIANT_BOOL UseImprovedImageListSupport

getsetproperty

Specifies whether the control uses code that makes usage of image lists easier

The Windows native button control supports assignment of an image list to display an icon on the button, but it requires the icon to be the first one in the image list. For this reason each button needs its own image list, so the more buttons with icons are used, the more image lists have to be created and managed. This leads to bloated code.
TimoSoft ButtonControls can work around this issue and allow the client application to specify the icons used by a button individually, so that all buttons can share the same image list. However, this feature slightly changes the control's behavior, so it must be activated explicitly to keep backward compatibility.
If this property is set to True, the work-around is activated; otherwise not.

Remarks

This property cannot be set at run-time.

See also

hImageList, IconIndex

UseSystemFont

VARIANT_BOOL UseSystemFont

getsetproperty

Specifies whether the control uses the system font

Retrieves or sets whether the control uses the MS Shell Dlg font (which is mapped to the system's default GUI font) or the font specified by the Font property. If set to True, the system font; otherwise the specified font is used.

See also

Font

VAlignment

VAlignmentConstants VAlignment

getset

Controls the vertical alignment of the control's caption

Retrieves or sets the vertical alignment of the control's caption. Any of the values defined by the VAlignmentConstants enumeration is valid.

See also

Text, HAlignment, IconAlignment, VAlignmentConstants

Version

BSTR Version

get

Retrieves the control's version

Remarks

This property is read-only.