Main Content

matlab.system.display.Header 类

包: matlab.system.display
超类:

System object 属性的标题

语法

matlab.system.display.Header(N1,V1,...Nn,Vn)
matlab.system.display.Header(Obj,...)

说明

matlab.system.display.Header(N1,V1,...Nn,Vn) 使用名称-值 (N,V) 对组中定义的标题属性指定 System object™ 的标题。可以在 getHeaderImpl 方法内使用 matlab.system.display.Header。可用标题属性包括

  • Title - 标题名称。默认值为空字符向量。

  • Text - 标题说明。默认值为空字符向量。

  • ShowSourceLink - 显示对象源代码的链接。

matlab.system.display.Header(Obj,...) 为指定的 System object (Obj) 创建标题,并设置以下属性值:

  • Title - 设置为 Obj 类名。

  • Text - 设置为 Obj 的帮助摘要。

  • ShowSourceLink - 如果 Obj 为 MATLAB 代码,则设置为 true。在这种情况下,会显示源代码链接。如果 Obj 是 P 编码,并且源代码不可用,请将此属性设置为 false

您可以在此方法中使用 mfilename('class'),以获取 System object 的名称。如果设置任何名称-值对组,则这些属性值将覆盖默认设置。

示例

全部折叠

在您的类定义文件中定义标题。

 methods (Static, Access = protected)
    function header = getHeaderImpl
       header = matlab.system.display.Header(mfilename('class'), ...
           'Title','AlternativeTitle',...
           'Text','An alternative class description');
    end
 end

生成的输出如下所示。在这种情况下,会出现源代码,因为 ShowSourceLink 属性已设置为 true