COleControl Class Members
Construction/Destruction
Initialization
Control Modification Functions
Persistence
Update/Painting Functions
Dispatch Exceptions
Ambient Property Functions
Event Firing Functions
Stock Methods/Properties
OLE Control Sizing Functions
OLE Data Binding Functions
Simple Frame Functions
OLE Control Site Functions
Modal Dialog Functions
Windowless Operations
Inactive Pointer Handling Functions
Asynchronous Control Functions
Overridables
Change Notification Functions
OLE Interface Notification Functions
IViewObject Interface Notification Overridables
In-Place Activation Functions
Property Browsing Functions
Construction/Destruction
Initialization
InitializeIIDs |
Informs the base class of the IIDs the control will use. |
ResetStockProps |
Initializes COleControl stock properties to their default values. |
ResetVersion |
Initializes the version number to a given value. |
SetInitialSize |
Sets the size of an OLE control when first displayed in a container. |
Control Modification Functions
Persistence
Update/Painting Functions
DoSuperclassPaint |
Redraws an OLE control that has been subclassed from a Windows control. |
InvalidateControl |
Invalidates an area of the displayed control, causing it to be redrawn. |
IsOptimizedDraw |
Indicates whether the container supports optimized drawing for the current drawing operation. |
SelectFontObject |
Selects a custom Font property into a device context. |
SelectStockFont |
Selects the stock Font property into a device context. |
TranslateColor |
Converts an OLE_COLOR value to a COLORREF value. |
Dispatch Exceptions
GetNotSupported |
Prevents access to a control’s property value by the user. |
SetNotPermitted |
Indicates that an edit request has failed. |
SetNotSupported |
Prevents modification to a control’s property value by the user. |
ThrowError |
Signals that an error has occurred in an OLE control. |
Ambient Property Functions
Event Firing Functions
Stock Methods/Properties
DoClick |
Implementation of the stock DoClick method. |
Refresh |
Forces a repaint of a control’s appearance. |
GetAppearance |
Returns the value of the stock Appearance property. |
SetAppearance |
Sets the value of the stock Appearance property. |
GetBackColor |
Returns the value of the stock BackColor property. |
SetBackColor |
Sets the value of the stock BackColor property. |
GetBorderStyle |
Returns the value of the stock BorderStyle property. |
SetBorderStyle |
Sets the value of the stock BorderStyle property. |
GetEnabled |
Returns the value of the stock Enabled property. |
SetEnabled |
Sets the value of the stock Enabled property. |
GetForeColor |
Returns the value of the stock ForeColor property. |
SetForeColor |
Sets the value of the stock ForeColor property. |
GetFont |
Returns the value of the stock Font property. |
GetFontTextMetrics |
Returns the metrics of a CFontHolder object. |
GetStockTextMetrics |
Returns the metrics of the stock Font property. |
InternalGetFont |
Returns a CFontHolder object for the stock Font property. |
SetFont |
Sets the value of the stock Font property. |
SelectStockFont |
Selects the control’s stock Font property into a device context. |
GetHwnd |
Returns the value of the stock hWnd property. |
GetText |
Returns the value of the stock Text or Caption property. |
InternalGetText |
Retrieves the stock Caption or Text property. |
SetText |
Sets the value of the stock Text or Caption property. |
OLE Control Sizing Functions
OLE Data Binding Functions
Simple Frame Functions
OLE Control Site Functions
ControlInfoChanged |
Call this function after the set of mnemonics handled by the control has changed. |
GetClientSite |
Queries an object for the pointer to its current client site within its container. |
GetExtendedControl |
Retrieves a pointer to an extended control object belonging to the container. |
LockInPlaceActive |
Determines if your control can be deactivated by the container. |
TransformCoords |
Transforms coordinate values between a container and the control. |
Modal Dialog Functions
PreModalDialog |
Notifies the container that a modal dialog box is about to be displayed. |
PostModalDialog |
Notifies the container that a modal dialog box has been closed. |
Windowless Operations
ClipCaretRect |
Adjusts a caret rectangle if it is overlapped by a control. |
GetCapture |
Determines whether a windowless, activated control object has the mouse capture. |
GetClientRect |
Retrieves the size of the control's client area. |
GetDC |
Provides a means for a windowless control to get a device context from its container. |
GetFocus |
Determines whether the control has the focus. |
GetWindowlessDropTarget |
Override to allow a windowless control to be the target of drag and drop operations. |
InvalidateRgn |
Invalidates the container window's client area within the given region. Can be used to redraw windowless controls in the region. |
OnWindowlessMessage |
Processes window messages (other than mouse and keyboard messages) for windowless controls. |
ReleaseCapture |
Releases mouse capture. |
ReleaseDC |
Releases the display device context of a container of a windowless control. |
ScrollWindow |
Allows a windowless control to scroll an area within its in-place active image on the display. |
SetCapture |
Causes the control’s container window to take possession of the mouse capture on the control’s behalf. |
SetFocus |
Causes the control’s container window to take possession of the input focus on the control’s behalf. |
Inactive Pointer Handling Functions
ClientToParent |
Translates a point relative to the control's origin to a point relative to its container's origin. |
GetActivationPolicy |
Alters the default activation behavior of a control that supports the IPointerInactive interface. |
GetClientOffset |
Retrieves the difference between the upper left corner of the control's rectangular area and the upper left corner of its client area. |
OnInactiveMouseMove |
Override to have the container for the inactive control under the mouse pointer dispatch WM_MOUSEMOVE messages to the control. |
OnInactiveSetCursor |
Override to have the container for the inactive control under the mouse pointer dispatch WM_SETCURSOR messages to the control. |
ParentToClient |
Translates a point relative to the container's origin to a point relative to the control's origin. |
Asynchronous Control Functions
GetReadyState |
Returns the control's readiness state. |
InternalSetReadyState |
Sets the control's readiness state and fires the ready-state-change event. |
Load |
Resets any previous asynchronous data and initiates a new load of the control's asynchronous property. |
Overridables
DisplayError |
Displays stock Error events to the control’s user. |
DoPropExchange |
Serializes the properties of a COleControl object. |
GetClassID |
Retrieves the OLE class ID of the control. |
GetMessageString |
Provides status bar text for a menu item. |
IsSubclassedControl |
Called to determine if the control subclasses a Windows control. |
OnClick |
Called to fire the stock Click event. |
OnDoVerb |
Called after a control verb has been executed. |
OnDraw |
Called when a control is requested to redraw itself. |
OnDrawMetafile |
Called by the container when a control is requested to redraw itself using a metafile device context. |
OnEdit |
Called by the container to UI Activate an OLE control. |
OnEnumVerbs |
Called by the container to enumerate a control’s verbs. |
OnEventAdvise |
Called when event handlers are connected or disconnected from a control. |
OnKeyDownEvent |
Called after the stock KeyDown event has been fired. |
OnKeyPressEvent |
Called after the stock KeyPress event has been fired. |
OnKeyUpEvent |
Called after the stock KeyUp event has been fired. |
OnProperties |
Called when the control’s “Properties” verb has been invoked. |
OnResetState |
Resets a control’s properties to the default values. |
Change Notification Functions
OLE Interface Notification Functions
OnAmbientPropertyChange |
Called when an ambient property is changed. |
OnClose |
Notifies the control that IOleControl::Close has been called. |
OnFreezeEvents |
Called when a control’s events are frozen or unfrozen. |
OnGetControlInfo |
Provides mnemonic information to the container. |
OnMnemonic |
Called when a mnemonic key of the control has been pressed. |
OnRenderData |
Called by the framework to retrieve data in the specified format. |
OnRenderFileData |
Called by the framework to retrieve data from a file in the specified format. |
OnRenderGlobalData |
Called by the framework to retrieve data from global memory in the specified format. |
OnSetClientSite |
Notifies the control that IOleControl::SetClientSite has been called. |
OnSetData |
Replaces the control’s data with another value. |
OnSetExtent |
Called after the control’s extent has changed. |
OnSetObjectRects |
Called after the control’s dimensions have been changed. |
IViewObject Interface Notification Overridables
OnGetColorSet |
Notifies the control that IOleObject::GetColorSet has been called. |
OnGetNaturalExtent |
Override to retrieve the control's display size closest to the proposed size and extent mode. |
OnGetViewExtent |
Override to retrieve the size of the control's display areas (can be used to enable two-pass drawing). |
OnGetViewRect |
Override to convert control's size into a rectangle starting at a specific position. |
OnGetViewStatus |
Override to retrieve the control's view status. |
OnQueryHitPoint |
Override to query whether a control's display overlaps a given point. |
OnQueryHitRect |
Override to query whether a control's display overlaps any point in a given rectangle. |
In-Place Activation Functions
OnGetInPlaceMenu |
Requests the handle of the control’s menu that will be merged with the container menu. |
OnHideToolBars |
Called by the container when the control is UI deactivated. |
OnShowToolBars |
Called when the control has been UI activated. |
Property Browsing Functions
COleControl Overview | Base Class Members | Hierarchy Chart