CStockPropImpl Class

  • Article

This class provides methods for supporting stock property values.

Important

This class and its members cannot be used in applications that execute in the Windows Runtime.

template < 
class T, 
class InterfaceName,  
const IID* piid= &_ATL_IIDOF(InterfaceName),  
const GUID* plibid= &CComModule::m_libid,  
WORD wMajor= 1, 
WORD wMinor= 0,  
class tihclass= CcomTypeInfoHolder 
> 
class ATL_NO_VTABLE CStockPropImpl : 
public IDispatchImpl< InterfaceName, piid, plibid, wMajor, 
   wMinor, tihclass>

Parameters

  • T
    The class implementing the control and deriving from CStockPropImpl.

  • InterfaceName
    A dual interface exposing the stock properties.

  • piid
    A pointer to the IID of InterfaceName.

  • plibid
    A pointer to the LIBID of the type library containing the definition of InterfaceName.

  • wMajor
    The major version of the type library. The default value is 1.

  • wMinor
    The minor version of the type library. The default value is 0.

  • tihclass
    The class used to manage the type information for T. The default value is CComTypeInfoHolder.

Members

Public Methods

get_Appearance

Call this method to get the paint style used by the control, for example, flat or 3D.

get_AutoSize

Call this method to get the status of the flag that indicates if the control cannot be any other size.

get_BackColor

Call this method to get the control's background color.

get_BackStyle

Call this method to get the control's background style, either transparent or opaque.

get_BorderColor

Call this method to get the control's border color.

get_BorderStyle

Call this method to get the control's border style.

get_BorderVisible

Call this method to get the status of the flag that indicates if the control's border is visible or not.

get_BorderWidth

Call this method to get the width (in pixels) of the control's border.

get_Caption

Call this method to get the text specified in an object's caption.

get_DrawMode

Call this method to get the control's drawing mode, for example, XOR Pen or Invert Colors.

get_DrawStyle

Call this method to get the control's drawing style, for example, solid, dashed, or dotted.

get_DrawWidth

Call this method to get the drawing width (in pixels) used by the control's drawing methods.

get_Enabled

Call this method to get the status of the flag that indicates if the control is enabled.

get_FillColor

Call this method to get the control's fill color.

get_FillStyle

Call this method to get the control's fill style, for example, solid, transparent, or cross-hatched.

get_Font

Call this method to get a pointer to the control's font properties.

get_ForeColor

Call this method to get the control's foreground color.

get_HWND

Call this method to get the window handle associated with the control.

get_MouseIcon

Call this method to get the picture properties of the graphic (icon, bitmap, or metafile) to be displayed when the mouse is over the control.

get_MousePointer

Call this method to get the type of mouse pointer displayed when the mouse is over the control, for example, arrow, cross, or hourglass.

get_Picture

Call this method to get a pointer to the picture properties of a graphic (icon, bitmap, or metafile) to be displayed.

get_ReadyState

Call this method to get the control's ready state, for example, loading or loaded.

get_TabStop

Call this method to get the flag that indicates if the control is a tab stop or not.

get_Text

Call this method to get the text that is displayed with the control.

get_Valid

Call this method to get the status of the flag that indicates if the control is valid or not.

get_Window

Call this method to get the window handle associated with the control. Identical to CStockPropImpl::get_HWND.

put_Appearance

Call this method to set the paint style used by the control, for example, flat or 3D.

put_AutoSize

Call this method to set the value of the flag that indicates if the control cannot be any other size.

put_BackColor

Call this method to set the control's background color.

put_BackStyle

Call this method to set the control's background style.

put_BorderColor

Call this method to set the control's border color.

put_BorderStyle

Call this method to set the control's border style.

put_BorderVisible

Call this method to set the value of the flag that indicates if the control's border is visible or not.

put_BorderWidth

Call this method to set the width of the control's border.

put_Caption

Call this method to set the text to be displayed with the control.

put_DrawMode

Call this method to set the control's drawing mode, for example, XOR Pen or Invert Colors.

put_DrawStyle

Call this method to set the control's drawing style, for example, solid, dashed, or dotted.

put_DrawWidth

Call this method to set the width (in pixels) used by the control's drawing methods.

put_Enabled

Call this method to set the flag that indicates if the control is enabled.

put_FillColor

Call this method to set the control's fill color.

put_FillStyle

Call this method to set the control's fill style, for example, solid, transparent, or cross-hatched.

put_Font

Call this method to set the control's font properties.

put_ForeColor

Call this method to set the control's foreground color.

put_HWND

This method returns E_FAIL.

put_MouseIcon

Call this method to set the picture properties of the graphic (icon, bitmap, or metafile) to be displayed when the mouse is over the control.

put_MousePointer

Call this method to set the type of mouse pointer displayed when the mouse is over the control, for example, arrow, cross, or hourglass.

put_Picture

Call this method to set the picture properties of a graphic (icon, bitmap, or metafile) to be displayed.

put_ReadyState

Call this method to set the control's ready state, for example, loading or loaded.

put_TabStop

Call this method to set the value of the flag that indicates if the control is a tab stop or not.

put_Text

Call this method to set the text that is displayed with the control.

put_Valid

Call this method to set the flag that indicates if the control is valid or not.

put_Window

This method calls CStockPropImpl::put_HWND, which returns E_FAIL.

putref_Font

Call this method to set the control's font properties, with a reference count.

putref_MouseIcon

Call this method to set the picture properties of the graphic (icon, bitmap, or metafile) to be displayed when the mouse is over the control, with a reference count.

putref_Picture

Call this method to set the picture properties of a graphic (icon, bitmap, or metafile) to be displayed, with a reference count.

Remarks

CStockPropImpl provides put and get methods for each stock property. These methods provide the code necessary to set or get the data member associated with each property and to notify and synchronize with the container when any property changes.

Visual C++ provides support for stock properties through its wizards. For more information about adding stock properties to a control, see the ATL Tutorial.

For backward compatibility, CStockPropImpl also exposes get_Window and put_Window methods that simply call get_HWND and put_HWND, respectively. The default implementation of put_HWND returns E_FAIL since HWND should be a read-only property.

The following properties also have a putref implementation:

  • Font

  • MouseIcon

  • Picture

The same three stock properties require their corresponding data member to be of type CComPtr or some other class that provides correct interface reference counting by means of the assignment operator.

Inheritance Hierarchy

T

IDispatchImpl

CStockPropImpl

Requirements

Header: atlctl.h

See Also

Reference

IDispatchImpl Class

Other Resources

ATL Class Overview