IOleComponentUIManager.ShowMessage 方法
请求一模式消息的显示。
命名空间: Microsoft.VisualStudio.Shell.Interop
程序集: Microsoft.VisualStudio.Shell.Interop(在 Microsoft.VisualStudio.Shell.Interop.dll 中)
语法
声明
Function ShowMessage ( _
dwCompRole As UInteger, _
ByRef rclsidComp As Guid, _
pszTitle As String, _
pszText As String, _
pszHelpFile As String, _
dwHelpContextID As UInteger, _
msgbtn As OLEMSGBUTTON, _
msgdefbtn As OLEMSGDEFBUTTON, _
msgicon As OLEMSGICON, _
fSysAlert As Integer, _
<OutAttribute> ByRef pnResult As Integer _
) As Integer
int ShowMessage(
uint dwCompRole,
ref Guid rclsidComp,
string pszTitle,
string pszText,
string pszHelpFile,
uint dwHelpContextID,
OLEMSGBUTTON msgbtn,
OLEMSGDEFBUTTON msgdefbtn,
OLEMSGICON msgicon,
int fSysAlert,
out int pnResult
)
参数
- dwCompRole
类型:System.UInt32
[in] 请求模式信息显示 VSPackage 对象的作用。有关有效的 dwCompRole 值列表,请参见 OLEROLE。
- rclsidComp
类型:System.Guid%
[in] 类标识符 (CLSID 请求) VSPackage 的对象显示的信息。
- pszTitle
类型:System.String
[in] 对文本标头或 null 指针,如果未显示的标头。
- pszText
类型:System.String
[in] 对文本或空的主要部分的指针,如果未显示的文本。
- pszHelpFile
类型:System.String
[in] 到路径的指针帮助文件的。
- dwHelpContextID
类型:System.UInt32
[in] 指定帮助上下文标识符。
- msgbtn
类型:Microsoft.VisualStudio.Shell.Interop.OLEMSGBUTTON
[in] 指定将按钮在消息框中显示。此参数类似于 Win32 MessageBox 功能的 uType 参数因为它使用类似的语义相似的值。有关有效的 msgbtn 值列表,请参见 OLEMSGBUTTON。
说明 OLEMSGBUTTON_YESALLNOCANCEL 不支持并返回结果和 OLEMSGBUTTON_OK 相同。
- msgdefbtn
类型:Microsoft.VisualStudio.Shell.Interop.OLEMSGDEFBUTTON
[in] 为消息框指定默认按钮。有关有效的 msgdefbtn 值列表,请参见 OLEMSGDEFBUTTON。
- msgicon
类型:Microsoft.VisualStudio.Shell.Interop.OLEMSGICON
[in] 指定消息的图标和类型。有关有效的 msgicon 值列表,请参见 OLEMSGICON。
- fSysAlert
类型:System.Int32
[in] 如果 true,此标志使 MB_SYSTEMMODAL 设置了标志,当显示消息时返回。在显示的信息内,如果 false,不存在系统标志设置为。
- pnResult
类型:System.Int32%
[out] 指定信息显示的结果。如果 ShowMessage 成功, pnResult 设置为对话框返回的以下菜单项值之一:
[1|1] 值
[1|2]“描述”
[2|1] IDABORT
[2|2] 中止 单击按钮。
[3|1] IDCANCEL
[3|2] 取消 单击按钮或 ESC 键按下了。如果消息框没有一个 取消 按钮,按 ESC 键不起作用。
[4|1] IDIGNORE
[4|2] 忽略 单击按钮。
[5|1] IDNO
[5|2] 按钮未单击。
[6|1] IDOK
[6|2] 好 单击按钮。
[7|1] IDRETRY
[7|2] 重试 单击按钮。
[8|1] IDYES
[8|2] 是 单击按钮。
返回值
类型:System.Int32
如果方法成功,则返回 S_OK。如果失败,它会返回一个错误代码。
备注
COM 签名
从 oleipc.idl:
HRESULT IOleComponentUIManager::ShowMessage(
[in] DWORD dwCompRole,
[in] REFCLSID rclsidComp,
[in] LPOLESTR pszTitle,
[in] LPOLESTR pszText,
[in] LPOLESTR pszHelpFile,
[in] DWORD dwHelpContextID,
[in] OLEMSGBUTTON msgbtn,
[in] OLEMSGDEFBUTTON msgdefbtn,
[in] OLEMSGICON msgicon,
[in] BOOL fSysAlert,
[out][retval] LONG *pnResult
);
将标题消息框由两个字符串组成:信息标题和邮件正文。
SOleComponentUIManager 服务通知 VSPackage 对象移至此服务和更改的 SOleComponentManager 服务注册为一个模式状态的。
如果状态的警告实际上是, SOleComponentUIManager 服务自动禁止显示警告消息。但是,因此,如果消息为信息性或关键的,它始终显示,即使状态的警告有效。
在显示对象所需的消息之前为 web 应用程序或组件控件, SOleComponentUIManager 提供给主要组件机会通过调用其 GetCntrMessage重写消息的所有方面。主 VSPackage 对象可以重写其中、 HelpContext、文本或消息类型。
.NET Framework 安全性
- 对直接调用方的完全信任。此成员不能由部分信任的代码使用。有关更多信息,请参见通过部分受信任的代码使用库。