CStockPropImpl 类

项目
04/03/2023

此类提供用来支持常用属性值的方法。

重要

无法在 Windows 运行时中执行的应用程序中使用此类及其成员。

语法

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>

参数

T
实现控件并从 CStockPropImpl 派生的类。

InterfaceName
一个公开常用属性的双接口。

piid
一个指向 InterfaceName 的 IID 的指针。

plibid
一个指针，它指向包含 InterfaceName 的定义的类型库的 LIBID。

wMajor
类型库的主版本。默认值为 1。

wMinor
类型库的次版本。默认值为 0。

tihclass
用于管理 T 的类型信息的类。默认值为 CComTypeInfoHolder。

成员

公共方法

名称	说明
get_Appearance	调用此方法可获取控件使用的绘制样式，例如平面或 3D。
get_AutoSize	调用此方法可获取指示控件是否只能是此大小的标志的状态。
get_BackColor	调用此方法可获取控件的背景色。
get_BackStyle	调用此方法可获取控件的背景样式（透明或不透明）。
get_BorderColor	调用此方法可获取控件的边框颜色。
get_BorderStyle	调用此方法可获取控件的边框样式。
get_BorderVisible	调用此方法可获取指示控件的边框是否可见的标志的状态。
get_BorderWidth	调用此方法可获取控件的边框宽度（以像素为单位）。
get_Caption	调用此方法可获取对象描述文字中指定的文本。
get_DrawMode	调用此方法可获取控件的绘制模式，例如 XOR 笔或反色。
get_DrawStyle	调用此方法可获取控件的绘制样式，例如实线、虚线或点线。
get_DrawWidth	调用此方法可获取控件绘制方法使用的绘制宽度（以像素为单位）。
get_Enabled	调用此方法可获取指示是否启用控件的标志的状态。
get_FillColor	调用此方法可获取控件的填充颜色。
get_FillStyle	调用此方法可获取控件的填充样式，例如实心、透明或交叉阴影。
get_Font	调用此方法可获取指向控件字体属性的指针。
get_ForeColor	调用此方法可获取控件的前景色。
get_HWND	调用此方法可获取与控件关联的窗口句柄。
get_MouseIcon	调用此方法可获取将鼠标悬停在控件上方时要显示的图形（图标、位图或图元文件）的图片属性。
get_MousePointer	调用此方法可获取将鼠标悬停在控件上方时显示的鼠标指针类型，例如箭头、十字或沙漏。
get_Picture	调用此方法可获取指向要显示的图形（图标、位图或图元文件）的图片属性的指针。
get_ReadyState	调用此方法可获取控件的就绪状态，例如正在加载或已加载。
get_TabStop	调用此方法可获取指示控件是否为制表位的标志。
get_Text	调用此方法可获取与控件一起显示的文本。
getvalid	调用此方法可获取标志指示是否有效的标志的状态。
get_Window	调用此方法可获取与控件关联的窗口句柄。与 CStockPropImpl::get_HWND 完全相同。
put_Appearance	调用此方法可设置控件使用的绘制样式，例如平面或 3D。
put_AutoSize	调用此方法可设置指示控件是否只能是此大小的标志的值。
put_BackColor	调用此方法可设置控件的背景色。
put_BackStyle	调用此方法可设置控件的背景样式。
put_BorderColor	调用此方法可设置控件的边框颜色。
put_BorderStyle	调用此方法可设置控件的边框样式。
put_BorderVisible	调用此方法可设置指示控件的边框是否可见的标志的值。
put_BorderWidth	调用此方法可设置控件边框的宽度。
put_Caption	调用此方法可设置要与控件一起显示的文本。
put_DrawMode	调用此方法可设置控件的绘制模式，例如 XOR 笔或反色。
put_DrawStyle	调用此方法可设置控件的绘制样式，例如实线、虚线或点线。
put_DrawWidth	调用此方法可设置控件绘制方法使用的宽度（以像素为单位）。
put_Enabled	调用此方法可设置指示是否启用控件的标志。
put_FillColor	调用此方法可设置控件的填充颜色。
put_FillStyle	调用此方法可设置控件的填充样式，例如实心、透明或交叉阴影。
put_Font	调用此方法可设置控件的字体属性。
put_ForeColor	调用此方法可设置控件的前景色。
put_HWND	此方法返回 E_FAIL。
put_MouseIcon	调用此方法可设置将鼠标悬停在控件上方时要显示的图形（图标、位图或图元文件）的图片属性。
put_MousePointer	调用此方法可设置将鼠标悬停在控件上方时显示的鼠标指针类型，例如箭头、十字或沙漏。
put_Picture	调用此方法可设置要显示的图形（图标、位图或图元文件）的图片属性。
put_ReadyState	调用此方法可设置控件的就绪状态，例如正在加载或已加载。
put_TabStop	调用此方法可设置指示控件是否为制表位的标志的值。
put_Text	调用此方法可设置与控件一起显示的文本。
putvalid	调用此方法可设置指示控件是否有效的标志。
put_Window	此方法调用 CStockPropImpl::put_HWND，它会返回 E_FAIL。
putref_Font	调用此方法可设置控件的字体属性，具有引用计数。
putref_MouseIcon	调用此方法可设置将鼠标悬停在控件上方时要显示的图形（图标、位图或图元文件）的图片属性，具有引用计数。
putref_Picture	调用此方法可设置要显示的图形（图标、位图或图元文件）的图片属性，具有引用计数。

注解

CStockPropImpl 为每个常用属性提供 put 和 get 方法。这些方法提供了必要的代码来设置或获取与每个属性关联的数据成员，并在任何属性发生更改时通知容器且与容器同步。

Visual Studio 通过其向导提供对常用属性的支持。若要详细了解如何向控件添加常用属性，请参阅 ATL 教程。

为了向后兼容，CStockPropImpl 还公开 get_Window 和 put_Window，它们只是用来分别调用 get_HWND 和 put_HWND。由于 HWND 应为只读属性，因此 put_HWND 的默认实现将返回 E_FAIL。

以下属性还具有 putref 实现：

字体
MouseIcon
图片

这三个常用属性要求其相应的数据成员为类型 CComPtr 或通过赋值运算符提供正确接口引用计数的其他某种类。

继承层次结构

T

IDispatchImpl

CStockPropImpl

要求

标头：atlctl.h

CStockPropImpl::get_Appearance

调用此方法可获取控件使用的绘制样式，例如平面或 3D。

HRESULT STDMETHODCALLTYPE get_Appearance(SHORT pnAppearance);

参数

pnAppearance
用于接收控件绘制样式的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_AutoSize

调用此方法可获取指示控件是否只能是此大小的标志的状态。

HRESULT STDMETHODCALLTYPE get_Autosize(VARIANT_BOOL* pbAutoSize);

参数

pbAutoSize
用于接收标志状态的变量。如果为 TRUE，则表示控件只能是此大小。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_BackColor

调用此方法可获取控件的背景色。

HRESULT STDMETHODCALLTYPE get_BackColor(OLE_COLOR* pclrBackColor);

参数

pclrBackColor
用于接收控件的背景色的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_BackStyle

调用此方法可获取控件的背景样式（透明或不透明）。

HRESULT STDMETHODCALLTYPE get_BackStyle(LONG* pnBackStyle);

参数

pnBackStyle
用于接收控件的背景样式的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_BorderColor

调用此方法可获取控件的边框颜色。

HRESULT STDMETHODCALLTYPE get_BorderColor(OLE_COLOR* pclrBorderColor);

参数

pclrBorderColor
用于接收控件的边框颜色的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_BorderStyle

调用此方法可获取控件的边框样式。

HRESULT STDMETHODCALLTYPE get_BorderStyle(LONG* pnBorderStyle);

参数

pnBorderStyle
用于接收控件的边框样式的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_BorderVisible

调用此方法可获取指示控件的边框是否可见的标志的状态。

HRESULT STDMETHODCALLTYPE get_BorderVisible(VARIANT_BOOL* pbBorderVisible);

参数

pbBorderVisible
用于接收标志状态的变量。如果为 TRUE，则表示控件的边框可见。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_BorderWidth

调用此方法可获取控件边框的宽度。

HRESULT STDMETHODCALLTYPE get_BorderWidth(LONG* pnBorderWidth);

参数

pnBorderWidth
用于接收控件的边框宽度的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_Caption

调用此方法可获取对象描述文字中指定的文本。

HRESULT STDMETHODCALLTYPE get_Caption(BSTR* pbstrCaption);

参数

pbstrCaption
要与控件一起显示的文本。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_DrawMode

调用此方法可获取控件的绘制模式，例如 XOR 笔或反色。

HRESULT STDMETHODCALLTYPE get_DrawMode(LONG* pnDrawMode);

参数

pnDrawMode
用于接收控件的绘制模式的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_DrawStyle

调用此方法可获取控件的绘制样式，例如实线、虚线或点线。

HRESULT STDMETHODCALLTYPE get_DrawStyle(LONG* pnDrawStyle);

参数

pnDrawStyle
用于接收控件的绘制样式的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_DrawWidth

调用此方法可获取控件绘制方法使用的绘制宽度（以像素为单位）。

HRESULT STDMETHODCALLTYPE get_DrawWidth(LONG* pnDrawWidth);

参数

pnDrawWidth
用于接收控件的宽度值（以像素为单位）的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_Enabled

调用此方法可获取指示是否启用控件的标志的状态。

HRESULT STDMETHODCALLTYPE get_Enabled(VARIANT_BOOL* pbEnabled);

参数

pbEnabled
用于接收标志状态的变量。如果为 TRUE，则表示已启用控件。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_FillColor

调用此方法可获取控件的填充颜色。

HRESULT STDMETHODCALLTYPE get_FillColor(OLE_COLOR* pclrFillColor);

参数

pclrFillColor
用于接收控件的填充颜色的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_FillStyle

调用此方法可获取控件的填充样式，例如实心、透明或交叉阴影。

HRESULT STDMETHODCALLTYPE get_FillStyle(LONG* pnFillStyle);

参数

pnFillStyle
用于接收控件的填充样式的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_Font

调用此方法可获取指向控件字体属性的指针。

HRESULT STDMETHODCALLTYPE get_Font(IFontDisp** ppFont);

参数

ppFont
用于接收指向控件字体属性的指针的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_ForeColor

调用此方法可获取控件的前景色。

HRESULT STDMETHODCALLTYPE get_ForeColor(OLE_COLOR* pclrForeColor);

参数

pclrForeColor
用于接收控件的前景色的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_HWND

调用此方法可获取与控件关联的窗口句柄。

HRESULT STDMETHODCALLTYPE get_HWND(LONG_PTR* phWnd);

参数

phWnd
与控件关联的窗口句柄。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_MouseIcon

调用此方法可获取将鼠标悬停在控件上方时要显示的图形（图标、位图或图元文件）的图片属性。

HRESULT STDMETHODCALLTYPE get_MouseIcon(IPictureDisp** ppPicture);

参数

ppPicture
用于接收指向图形图片属性的指针的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_MousePointer

调用此方法可获取将鼠标悬停在控件上方时显示的鼠标指针类型，例如箭头、十字或沙漏。

HRESULT STDMETHODCALLTYPE get_MousePointer(LONG* pnMousePointer);

参数

pnMousePointer
用于接收鼠标指针类型的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_Picture

调用此方法可获取指向要显示的图形（图标、位图或图元文件）的图片属性的指针。

HRESULT STDMETHODCALLTYPE get_Picture(IPictureDisp** ppPicture);

参数

ppPicture
用于接收指向图片属性的指针的变量。有关更多详细信息，请参阅 IPictureDisp。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_ReadyState

调用此方法可获取控件的就绪状态，例如正在加载或已加载。

HRESULT STDMETHODCALLTYPE get_ReadyState(LONG* pnReadyState);

参数

pnReadyState
用于接收控件的就绪状态的变量。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_TabStop

调用此方法可获取指示控件是否为制表位的标志的状态。

HRESULT STDMETHODCALLTYPE get_TabStop(VARIANT_BOOL* pbTabStop);

参数

pbTabStop
用于接收标志状态的变量。如果为 TRUE，则表示控件是制表位。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_Text

调用此方法可获取与控件一起显示的文本。

HRESULT STDMETHODCALLTYPE get_Text(BSTR* pbstrText);

参数

pbstrText
与控件一起显示的文本。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::getvalid

调用此方法可获取标志指示是否有效的标志的状态。

HRESULT STDMETHODCALLTYPE getvalid(VARIANT_BOOL* pbValid);

参数

pbValid
用于接收标志状态的变量。如果为 TRUE，则表示控件有效。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::get_Window

调用此方法可获取与控件关联的窗口句柄。与 CStockPropImpl::get_HWND 完全相同。

HRESULT STDMETHODCALLTYPE get_Window(LONG_PTR* phWnd);

参数

phWnd
与控件关联的窗口句柄。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_Appearance

调用此方法可设置控件使用的绘制样式，例如平面或 3D。

HRESULT STDMETHODCALLTYPE put_Appearance(SHORT nAppearance);

参数

nAppearance
控件要使用的新的绘制样式。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_AutoSize

调用此方法可设置指示控件是否只能是此大小的标志的值。

HRESULT STDMETHODCALLTYPE put_AutoSize(VARIANT_BOOL bAutoSize,);

参数

bAutoSize
如果控件只能是此大小，则为 TRUE。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_BackColor

调用此方法可设置控件的背景色。

HRESULT STDMETHODCALLTYPE put_BackColor(OLE_COLOR clrBackColor);

参数

clrBackColor
新的控件背景色。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_BackStyle

调用此方法可设置控件的背景样式。

HRESULT STDMETHODCALLTYPE put_BackStyle(LONG nBackStyle);

参数

nBackStyle
新的控件背景样式。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_BorderColor

调用此方法可设置控件的边框颜色。

HRESULT STDMETHODCALLTYPE put_BorderColor(OLE_COLOR clrBorderColor);

参数

clrBorderColor
新的边框颜色。 OLE_COLOR 数据类型在内部表示为 32 位长整型。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_BorderStyle

调用此方法可设置控件的边框样式。

HRESULT STDMETHODCALLTYPE put_BorderStyle(LONG nBorderStyle);

参数

nBorderStyle
新的边框样式。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_BorderVisible

调用此方法可设置指示控件的边框是否可见的标志的值。

HRESULT STDMETHODCALLTYPE put_BorderVisible(VARIANT_BOOL bBorderVisible);

参数

bBorderVisible
如果边框可见，则为 TRUE。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_BorderWidth

调用此方法可设置控件边框的宽度。

HRESULT STDMETHODCALLTYPE put_BorderWidth(LONG nBorderWidth);

参数

nBorderWidth
控件边框的新宽度。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_Caption

调用此方法可设置要与控件一起显示的文本。

HRESULT STDMETHODCALLTYPE put_Caption(BSTR bstrCaption);

参数

bstrCaption
要与控件一起显示的文本。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_DrawMode

调用此方法可设置控件的绘制模式，例如 XOR 笔或反色。

HRESULT STDMETHODCALLTYPE put_DrawMode(LONG nDrawMode);

参数

nDrawMode
控件的新绘制模式。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_DrawStyle

调用此方法可设置控件的绘制样式，例如实线、虚线或点线。

HRESULT STDMETHODCALLTYPE put_DrawStyle(LONG pnDrawStyle);

参数

nDrawStyle
控件的新绘制样式。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_DrawWidth

调用此方法可设置控件绘制方法使用的宽度（以像素为单位）。

HRESULT STDMETHODCALLTYPE put_DrawWidth(LONG nDrawWidth);

参数

nDrawWidth
控件的绘制方法要使用的新宽度。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_Enabled

调用此方法可设置指示是否启用控件的标志的值。

HRESULT STDMETHODCALLTYPE put_Enabled(VARIANT_BOOL bEnabled);

参数

bEnabled
如果控件已启用，则为 TRUE。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_FillColor

调用此方法可设置控件的填充颜色。

HRESULT STDMETHODCALLTYPE put_FillColor(OLE_COLOR clrFillColor);

参数

clrFillColor
控件的新填充颜色。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_FillStyle

调用此方法可设置控件的填充样式，例如实心、透明或交叉阴影。

HRESULT STDMETHODCALLTYPE put_FillStyle(LONG nFillStyle);

参数

nFillStyle
控件的新填充样式。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_Font

调用此方法可设置控件的字体属性。

HRESULT STDMETHODCALLTYPE put_Font(IFontDisp* pFont);

参数

pFont
指向控件的字体属性的指针。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_ForeColor

调用此方法可设置控件的前景色。

HRESULT STDMETHODCALLTYPE put_ForeColor(OLE_COLOR clrForeColor);

参数

clrForeColor
控件的新前景色。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

CStockPropImpl::put_HWND

此方法返回 E_FAIL。

HRESULT STDMETHODCALLTYPE put_HWND(LONG_PTR /* hWnd */);

参数

CStockPropImpl::putref_Font

调用此方法可设置控件的字体属性，具有引用计数。

HRESULT STDMETHODCALLTYPE putref_Font(IFontDisp* pFont);

参数

pFont
指向控件的字体属性的指针。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

注解

与 CStockPropImpl::put_Font 相同，但具有引用计数。

CStockPropImpl：:p utref_MouseIcon

调用此方法可设置将鼠标悬停在控件上方时要显示的图形（图标、位图或图元文件）的图片属性，具有引用计数。

HRESULT STDMETHODCALLTYPE putref_MouseIcon(IPictureDisp* pPicture);

参数

pPicture
指向图形图片属性的指针。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

注解

与 CStockPropImpl::put_MouseIcon 相同，但具有引用计数。

CStockPropImpl::putref_Picture

调用此方法可设置要显示的图形（图标、位图或图元文件）的图片属性，具有引用计数。

HRESULT STDMETHODCALLTYPE putref_Picture(IPictureDisp* pPicture);

参数

pPicture
指向图片属性的指针。有关更多详细信息，请参阅 IPictureDisp。

返回值

如果成功，则返回 S_OK；否则返回错误 HRESULT。

注解

与 CStockPropImpl::put_Picture 相同，但具有引用计数。

另请参阅

类概述
 IDispatchImpl 类