IVsObjectList.FillDescription 方法

请求列表项提供用于对象浏览器的标题文本。

命名空间:  Microsoft.VisualStudio.Shell.Interop
程序集:  Microsoft.VisualStudio.Shell.Interop(在 Microsoft.VisualStudio.Shell.Interop.dll 中)

语法

声明
Function FillDescription ( _
    index As UInteger, _
    grfOptions As UInteger, _
    pobDesc As IVsObjectBrowserDescription2 _
) As Integer
int FillDescription(
    uint index,
    uint grfOptions,
    IVsObjectBrowserDescription2 pobDesc
)

参数

  • index
    类型:System.UInt32
    [in] 指定列表项的索引相关。

返回值

类型:System.Int32
如果方法成功,则返回 S_OK。如果失败,它会返回一个错误代码。

备注

COM 签名

从 vsshell.idl:

HRESULT IVsObjectList::FillDescription(
   [in] ULONG Index,
   [in] VSOBJDESCOPTIONS grfOptions,
   [in] IVsObjectBrowserDescription2 *pobDesc
);

当对象在 对象浏览器时,对象的声明显示在下部的窗格 (图例窗格) 窗口。 标题文本通过一系列生成对 AddDescriptionText3。 环境将调用 index 项目的 FillDescription 相关。 在 IVsObjectBrowserDescription3 接口的调用通过。 这类似于 IStream 接口您重复调用 AddDescriptionText3 将声明为一系列组件。 元素标识与 VSOBDESCRIPTIONSECTION 枚举。

该环境可以通过 grfOptions,指定,则应返回索引项的完全限定名。

在代码中浏览工具还使用的,提供工具提示文本替换检测项目中的图标此方法。 在此方案中该环境最初将调用索引项目的 GetTipText 。 如果返回 E_NOTIMPL 或未通过调用,然后该环境调用 FillDescription 和 grfOptions 设置为 ODO_TOOLTIPDESC | ODO_USEFULLNAME.

.NET Framework 安全性

请参见

参考

IVsObjectList 接口

Microsoft.VisualStudio.Shell.Interop 命名空间