Main Content

helpdlg

创建帮助对话框

说明

注意

在 App 设计工具和使用 uifigure 函数创建的 App 中,推荐使用 uialert 而不是 helpdlg,因为它提供额外的自定义选项。

helpdlg 创建一个非模态帮助对话框,其默认标题为帮助对话框,默认消息为这是默认帮助

如果您要在多个 App 窗口、MATLAB® 桌面或 Simulink® 上显示帮助对话框,并且在响应对话框之前仍能与它们进行交互,请使用此函数。

示例

helpdlg(msg) 指定自定义消息文本。如果具有匹配对话框标题的对话框已存在,MATLAB 会将它置于最前端。

示例

helpdlg(msg,title) 为对话框指定自定义标题。

f = helpdlg(___) 返回图窗对象。您可将此语法与上述语法中的任何输入参数一起使用。

示例

全部折叠

helpdlg("Consider using a cell array.")

Help dialog box with the title "Help Dialog", a blue icon that contains the letter "i", the message "Consider using a cell array", and an OK button

使用字符串数组指定帮助对话框文本。在每个数组元素之后进行换行。

helpdlg(["Valid data types are:","int8", ...
    "int16","int32","int64"])

Help dialog box. The message lists valid data types with each data type on its own line.

创建具有自定义标题和消息的对话框。

helpdlg("Choose 10 points from the figure",...
    "Point Selection")

Help dialog box with the title "Point Selection" and the message "Choose 10 points from the figure"

如果该对话框不可见,它可能隐藏在其他窗口后面。再次发出命令可将其置于最前端。

helpdlg("Choose 10 points from the figure", ...
    "Point Selection")

现在,通过使用相同的标题和不同的消息再次调用 helpdlg 来更改消息。

helpdlg("Choose 5 points from the figure", ...
    "Point Selection")

创建对话框后,每次调用 helpdlg 并指定相同的 title 时,MATLAB 都会将该对话框置于最前端。如果对话框 title 未更改,而您在两次调用 helpdlg 之间关闭对话框,则 MATLAB 只会创建一个新对话框。

输入参数

全部折叠

帮助消息,指定为字符向量、字符串标量、字符向量元胞数组或字符串数组。

  • 如果将帮助消息指定为字符向量或字符串标量,则长消息会换行以适应对话框大小。

  • 如果将帮助消息指定为字符向量元胞数或组字符串数组,每个数组元素间都会换行。长元素会换行适应对话框大小。

示例: "This value is required."

示例: {'Valid data types are:','int8','int16','int32','int64'}

对话框标题,指定为字符向量或字符串数组。

示例: "Value Specification"

详细信息

全部折叠

模态对话框

模态对话框阻止用户在响应该对话框之前与其他 MATLAB 窗口进行交互。

非模态对话框

非模态对话框允许用户在响应该对话框之前与其他 MATLAB 窗口进行交互。非模态对话框也称为普通对话框。

提示

  • 即使模态帮助对话框处于活动状态,MATLAB 程序也会继续执行。要阻止该程序执行直到用户关闭对话框为止,请使用 uiwait 函数。

  • 要为单窗口 App 设计工具或基于 uifigure 的 App 创建模态警报对话框,请改用 uialert 函数。

版本历史记录

在 R2006a 之前推出

另请参阅

| | |