TimoSoft ButtonControls
1.10.4.207
|
The main interface (command button) More...
Inherits IDispatch.
Public Member Functions | |
HRESULT | About (void) |
Displays the control's credits More... | |
HRESULT | Click (void) |
Clicks the button 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... | |
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... | |
ButtonTypeConstants | ButtonType [get, set] |
Specifies the button's sub-type More... | |
BSTR | CommandLinkNote [get, set] |
Specifies the additional text displayed in a command link button 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... | |
OLE_YSIZE_PIXELS | DropDownArrowHeight [get, set] |
Specifies the height of the control's drop-down arrow More... | |
OLE_XSIZE_PIXELS | DropDownArrowWidth [get, set] |
Specifies the width of the control's drop-down arrow More... | |
SHORT | DropDownGlyph [get, set] |
Controls the appearance of the control's drop-down arrow More... | |
VARIANT_BOOL | DropDownOnRight [get, set] |
Controls the location of the control's drop-down arrow More... | |
VARIANT_BOOL | DropDownPushed [get, set] |
Specifies whether the split button's drop-down part is drawn like being pushed More... | |
DropDownStyleConstants | DropDownStyle [get, set] |
Controls the appearance of the control's drop-down arrow 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 | hDropDownImageList [get, set] |
Specifies the control's associated imagelist containing the drop-down arrows 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... | |
VARIANT_BOOL | KeepDropDownArrowAspectRatio [get, set] |
Controls the appearance of the control's drop-down arrow 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 | 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... | |
VARIANT_BOOL | ShowRightsElevationIcon [get, set] |
Specifies whether the control displays the Vista LUA icon More... | |
VARIANT_BOOL | ShowSplitLine [get, set] |
Controls the appearance of a drop-down button 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 | 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... | |
The main interface (command button)
This is the command button control's main interface. It wraps the control window.
HRESULT About | ( | void | ) |
Displays the control's credits
Displays some information about this control and its author.
HRESULT Click | ( | void | ) |
Clicks the button by code
HRESULT GetControlState | ( | [out, retval] ControlStateConstants * | pControlState | ) |
Retrieves a bit field describing the control's state
ControlStateConstants
enumeration, that describe the control's state.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.
[out] | idealWidth | The control's optimal width in pixels. |
[out] | idealHeight | The control's optimal height in pixels. |
HRESULT LoadSettingsFromFile | ( | [in] BSTR | file, |
[out, retval] VARIANT_BOOL * | pSucceeded | ||
) |
Loads the control's settings from the specified file
[in] | file | The file to read from. |
True
if the settings could be loaded; otherwise False
.HRESULT SaveSettingsToFile | ( | [in] BSTR | file, |
[out, retval] VARIANT_BOOL * | pSucceeded | ||
) |
Saves the control's settings to the specified file
[in] | file | The file to write to. |
True
if the settings could be saved; otherwise False
.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.
OLEDragDrop
event handler or if no drag images are used.
|
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.
|
getsetproperty |
|
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.
|
getset |
Specifies the button's sub-type
Retrieves or sets the control's command button sub-type. Any of the values defined by the ButtonTypeConstants
enumeration is valid.
|
getsetproperty |
Specifies the additional text displayed in a command link button
Retrieves or sets the text that is displayed below the button's caption if the ButtonType
property is set to btCommandLink
.
|
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.
|
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.
|
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.
|
getset |
Specifies the height of the control's drop-down arrow
Retrieves or sets the height (in pixels) of the drop-down part of a split button. If set to 0, the default height is used.
|
getset |
Specifies the width of the control's drop-down arrow
Retrieves or sets the width (in pixels) of the drop-down part of a split button.
|
getsetproperty |
Controls the appearance of the control's drop-down arrow
Retrieves or sets the code of the character, that is displayed as drop-down arrow in a split button, if the DropDownStyle
property is set to ddsGlyph
.
|
getset |
Controls the location of the control's drop-down arrow
Retrieves or sets whether the drop-down part of a split button is drawn to the right of its caption. If set to True
, the separator is displayed to the right; otherwise to the left of the caption.
|
getset |
Specifies whether the split button's drop-down part is drawn like being pushed
Retrieves or sets whether the drop-down part of a split button is drawn like being pushed. If set to True
, it is drawn like being pushed; otherwise not.
|
getset |
Controls the appearance of the control's drop-down arrow
Retrieves or sets which type of drop-down arrow to use in a split button. Any of the values defined by the DropDownStyleConstants
enumeration is valid.
|
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.
|
getset |
Specifies the control's font
Retrieves or sets the control's font. It's used to draw the caption.
|
getsetproperty |
|
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.
|
getsetproperty |
Specifies the control's associated imagelist containing the drop-down arrows
Retrieves or sets the handle to the imagelist containing the icons, that are displayed as drop-down arrow in a split button, if the DropDownStyle
property is set to ddsImage
. If set to 0, no icon is drawn.
The icon's index in the imagelist specifies the control state it is used for:
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.
|
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:
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.
|
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.
|
get |
Retrieves the control's window handle
Retrieves the control's window handle.
|
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.
|
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.
[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:
|
UseImprovedImageListSupport
is set to False
.
|
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).
|
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).
|
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).
|
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).
|
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
.
Button
window class, command buttons displaying a bitmap or icon won't use Windows XP themes.
|
getset |
Controls the appearance of the control's drop-down arrow
Retrieves or sets whether the drop-down arrow of a split button is shrinked or stretched, so that its aspect ratio remains the same when changing the drop-down arrow's size. If set to True
, the aspect ratio remains the same; otherwise not.
|
getset |
Controls the control's mouse cursor
Retrieves or sets a user-defined mouse cursor. It's used if MousePointer
is set to mpCustom
.
|
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.
|
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.
|
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.
|
getset |
Specifies whether the control is drawn like being pushed
Retrieves or sets whether the button is drawn like being pushed. If set to True
, it is drawn like being pushed; otherwise not.
|
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.
|
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.
|
getset |
Specifies whether the control displays the Vista LUA icon
Retrieves or sets whether the control displays an icon, which indicates, that clicking the control triggers an action, that requires elevated rights. If set to True
, the icon is displayed; otherwise not.
|
getset |
Controls the appearance of a drop-down button
Retrieves or sets whether the two parts of a split button are visually separated by a line. If set to True
, the separator is displayed; otherwise not.
|
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.
|
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.
|
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
.
|
getset |
Controls the location of the control's caption
Retrieves or sets the bottom margin (in pixels) of the control's text.
|
getset |
Controls the location of the control's caption
Retrieves or sets the left margin (in pixels) of the control's text.
|
getset |
Controls the location of the control's caption
Retrieves or sets the right margin (in pixels) of the control's text.
|
getset |
Controls the location of the control's caption
Retrieves or sets the top margin (in pixels) of the control's text.
|
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.
|
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.
|
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.
|
get |
Retrieves the control's version