Inherits IDispatch.
Public Member Functions | |
HRESULT | About (void) |
Displays the control's credits | |
HRESULT | GetCurrentKeyCombination ([in, out, defaultvalue(0)] ModifierKeysConstants *modifierKeys,[in, out, defaultvalue(0)] BYTE *keyCode) |
Retrieves the current key combination displayed by the control | |
HRESULT | LoadSettingsFromFile ([in] BSTR file,[out, retval] VARIANT_BOOL *pSucceeded) |
Loads the control's settings from the specified file | |
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 | |
HRESULT | SetCurrentKeyCombination ([in] ModifierKeysConstants modifierKeys,[in] BYTE keyCode) |
Sets the key combination displayed by the control | |
Properties | |
AppearanceConstants | Appearance [get, set] |
Controls the style of the control's outer border | |
OLE_COLOR | BackColor [get, set] |
Specifies the control's background color | |
BorderStyleConstants | BorderStyle [get, set] |
Controls the style of the control's inner border | |
ModifierKeysConstants | DefaultModifierKeys [get, set] |
Controls the automatic correction of invalid key combinations | |
DisabledEventsConstants | DisabledEvents [get, set] |
Controls which events are fired | |
VARIANT_BOOL | DontRedraw [get, set] |
Controls redrawing of the control | |
VARIANT_BOOL | Enabled [get, set] |
Controls whether the control accepts user input | |
IFontDisp | Font [get, set] |
Specifies the control's font | |
LONG | HoverTime [get, set] |
Controls when the MouseHover event is fired | |
OLE_HANDLE | hWnd [get] |
Retrieves the control's window handle | |
InvalidKeyCombinationsConstants | InvalidKeyCombinations [get, set] |
Specifies the kinds of key combinations that are handled as invalid | |
IPictureDisp | MouseIcon [get, set] |
Controls the control's mouse cursor | |
MousePointerConstants | MousePointer [get, set] |
Controls the control's mouse cursor | |
VARIANT_BOOL | ProcessContextMenuKeys [get, set] |
Specifies whether the ContextMenu event can be invoked using the keyboard | |
VARIANT_BOOL | RegisterForOLEDragDrop [get, set] |
Controls the control's behavior in drag'n'drop operations | |
RightToLeftConstants | RightToLeft [get, set] |
Controls the control's right-to-left features | |
VARIANT_BOOL | SupportOLEDragImages [get, set] |
Controls the control's behavior in drag'n'drop operations | |
BSTR | Text [get] |
Retrieves the current key combination as a string | |
VARIANT_BOOL | UseSystemFont [get, set] |
Specifies whether the control uses the system font | |
BSTR | Version [get] |
Retrieves the control's version |
HRESULT About | ( | void | ) |
Displays the control's credits
Displays some information about this control and its author.
HRESULT GetCurrentKeyCombination | ( | [in, out, defaultvalue(0)] ModifierKeysConstants * | modifierKeys, | |
[in, out, defaultvalue(0)] BYTE * | keyCode | |||
) |
Retrieves the current key combination displayed by the control
[out] | modifierKeys | The modifier keys that are part of the key combination. Any combination of the values defined by the ModifierKeysConstants enumeration is valid. |
[out] | keyCode | The virtual key code of the key that the key combination is based on. |
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 SetCurrentKeyCombination | ( | [in] ModifierKeysConstants | modifierKeys, | |
[in] BYTE | keyCode | |||
) |
Sets the key combination displayed by the control
[in] | modifierKeys | The modifier keys that are part of the key combination. Any combination of the values defined by the ModifierKeysConstants enumeration is valid. |
[in] | keyCode | The virtual key code of the key that the key combination is based on. |
modifierKeys
and keyCode
to 0 clears the key combination.
AppearanceConstants Appearance [get, set] |
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.
OLE_COLOR BackColor [get, set] |
Specifies the control's background color
Retrieves or sets the control's background color.
BorderStyleConstants BorderStyle [get, set] |
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.
ModifierKeysConstants DefaultModifierKeys [get, set] |
Controls the automatic correction of invalid key combinations
Retrieves or sets the combination of modifier keys, that is used automatically if the user enters an invalid key combination. Any combination of the values defined by the ModifierKeysConstants
enumeration is valid.
DisabledEventsConstants DisabledEvents [get, set] |
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.
VARIANT_BOOL DontRedraw [get, set] |
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.
VARIANT_BOOL Enabled [get, set] |
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.
IFontDisp Font [get, set] |
Specifies the control's font
Retrieves or sets the control's font. It's used to draw the control's content.
LONG HoverTime [get, set] |
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.
OLE_HANDLE hWnd [get] |
Retrieves the control's window handle
Retrieves the control's window handle.
InvalidKeyCombinationsConstants InvalidKeyCombinations [get, set] |
Specifies the kinds of key combinations that are handled as invalid
Retrieves or sets the types of key combinations, that the control won't accept. Any combination of the values defined by the InvalidKeyCombinationsConstants
enumeration is valid.
IPictureDisp MouseIcon [get, set] |
Controls the control's mouse cursor
Retrieves or sets a user-defined mouse cursor. It's used if MousePointer
is set to mpCustom
.
MousePointerConstants MousePointer [get, set] |
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.
VARIANT_BOOL ProcessContextMenuKeys [get, set] |
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 events get fired; otherwise not.
VARIANT_BOOL RegisterForOLEDragDrop [get, set] |
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.
RightToLeftConstants RightToLeft [get, set] |
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.
VARIANT_BOOL SupportOLEDragImages [get, set] |
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.
BSTR Text [get] |
Retrieves the current key combination as a string
Retrieves a (localized) string representation of the key combination currently displayed by the control.
VARIANT_BOOL UseSystemFont [get, set] |
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.
BSTR Version [get] |
Retrieves the control's version