IFrame Interface Reference

The main interface (frame) More...

Public Member Functions
HRESULT	About (void)
	Displays the control's credits
HRESULT	Click (void)
	Clicks the frame by code
HRESULT	GetControlState ([out, retval] ControlStateConstants *pControlState)
	Retrieves a bit field describing the control's state
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
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
VARIANT_BOOL	BorderVisible `[get, set]`
	Specifies whether the control's border and caption are drawn
ContentTypeConstants	ContentType `[get, set]`
	Controls the type of the control's caption
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
OLE_COLOR	ForeColor `[get, set]`
	Specifies the control's text color
HAlignmentConstants	HAlignment `[get, set]`
	Controls the horizontal alignment of the control's caption
OLE_HANDLE	hImageList `[get, set]`
	Specifies the control's associated imagelist
LONG	HoverTime `[get, set]`
	Controls when the `MouseHover` event is fired
OLE_HANDLE	hWnd `[get]`
	Retrieves the control's window handle
IconAlignmentConstants	IconAlignment `[get, set]`
	Controls the location of the control's icon
OLE_YSIZE_PIXELS	IconMarginBottom `[get, set]`
	Controls the location of the control's icon
OLE_XSIZE_PIXELS	IconMarginLeft `[get, set]`
	Controls the location of the control's icon
OLE_XSIZE_PIXELS	IconMarginRight `[get, set]`
	Controls the location of the control's icon
OLE_YSIZE_PIXELS	IconMarginTop `[get, set]`
	Controls the location of the control's icon
OLE_HANDLE	Image `[get, set]`
	Specifies the bitmap or icon displayed as caption
IPictureDisp	MouseIcon `[get, set]`
	Controls the control's mouse cursor
MousePointerConstants	MousePointer `[get, set]`
	Controls the control's mouse cursor
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
StyleConstants	Style `[get, set]`
	Controls the control's appearance
VARIANT_BOOL	SupportOLEDragImages `[get, set]`
	Controls the control's behavior in drag'n'drop operations
BSTR	Text `[get, set]`
	Specifies the control's caption
VARIANT_BOOL	UseSystemFont `[get, set]`
	Specifies whether the control uses the system font
BSTR	Version `[get]`
	Retrieves the control's version

Detailed Description

The main interface (frame)

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

See also:: _IFrameEvents

Member Function Documentation

HRESULT About ( void )

Displays the control's credits

Displays some information about this control and its author.

HRESULT Click ( void )

Clicks the frame by code

See also:: _IFrameEvents::Click

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:: ControlStateConstants

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

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

Property Documentation

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.

See also:: BorderStyle, Style, AppearanceConstants

OLE_COLOR BackColor [get, set]

Specifies the control's background color

Retrieves or sets the control's background color.

Remarks:: This property isn't supported for themed frames.

See also:: ForeColor

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.

See also:: Appearance, BorderVisible, Style, BorderStyleConstants

VARIANT_BOOL BorderVisible [get, set]

Specifies whether the control's border and caption are drawn

Retrieves or sets whether the control's border and caption are drawn. If set to True, the border and caption are drawn. If set to False, only the control's background is drawn.

See also:: BorderStyle, Text

ContentTypeConstants ContentType [get, set]

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

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.

See also:: DisabledEventsConstants

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 caption.

See also:: UseSystemFont, Text, ForeColor

OLE_COLOR ForeColor [get, set]

Specifies the control's text color

Retrieves or sets the control's text color.

Remarks:: This property isn't supported for themed frames.

See also:: BackColor, Text, Font

HAlignmentConstants HAlignment [get, set]

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, IconAlignment, HAlignmentConstants

OLE_HANDLE hImageList [get, set]

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 frame is in no special state.
1 - Used if the frame is in 'hot' state, i. e. it's below the mouse cursor.
2 - Currently not used.
3 - Used if the frame is disabled.
4 - Currently not used.
5 - (Tablet PC specific) Currently not used.

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 previous imagelist does NOT get auto-destroyed.

See also:: Image, Text, IconAlignment

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.

See also:: _IFrameEvents::MouseHover

OLE_HANDLE hWnd [get]

Retrieves the control's window handle

Retrieves the control's window handle.

Remarks:: This property is read-only.

See also:: _IFrameEvents::RecreatedControlWindow, _IFrameEvents::DestroyedControlWindow

IconAlignmentConstants IconAlignment [get, set]