matlab.mixin.CustomDisplay.getDetailedHeader

Class: matlab.mixin.CustomDisplay
Namespace: matlab.mixin

Return default detailed header for object display

Syntax

header = matlab.mixin.CustomDisplay.getDetailedHeader(obj)


Description

header = matlab.mixin.CustomDisplay.getDetailedHeader(obj) returns descriptive text about obj.

Input Arguments

obj — Object to return detailed header for

object array

Object to return detailed header for. The class of obj must be derived from matlab.mixin.CustomDisplay.

Output Arguments

header — Descriptive text

character vector

Descriptive text, returned as a character vector.

For scalar objects, the text includes:

• Class name of obj, rendered as a link that opens a summary of the class members and attributes

• Link to handle documentation if obj is a handle class

• The text 'with properties:'

For object arrays, including empty arrays, the text includes:

• The dimensions of the array

• obj

• Class name of obj, rendered as a link that opens a summary of the class members and attributes

• Link to handle documentation if obj is a handle class

• The text 'array with properties:'

The linked text renders as plain text if the display does not support links.

Attributes

Static	true
Access	protected
Sealed	true
Hidden	true

To learn about attributes of methods, see Method Attributes.

Version History

Introduced in R2013b