RunBase.caption Method [AX 2012]

Returns the description from the current class by calling the static description method on the class if there is one.

Syntax

public ClassDescription caption()

Run On

Called

Return Value

Type: ClassDescription Extended Data Type
The description from the current class.

Remarks

This method can be overridden to give a more precise description, for example, when you need some internal variables to build the description text.

The static RunBase::description method is generally used to obtain the description of a class because you do not have to instantiate the class to call it. The method speeds up displaying the description in a grid, for example.

Examples

public ClassDescription caption() 
{ 
    return strfmt("A text using a %1 internal variable", myVar); 
}

See Also

RunBase Class

RunBase::description Method