Please enable JavaScript to view this site.

Navigation: Advanced topics > Programming topics > Labels/Titles API > Methods

Labels/Titles API: setTableCaption

Scroll Prev Next More

 

Sets the table caption.

Syntax

Labels::setTableCaption($table, $caption, $language);

Arguments

$table

the table name.

$caption

a new table caption. Captions can be set in the Label Editor.

$language

the language of the caption. If the $language parameter is not specified, the current language is used.

Return value

No return value.

Example

Captions can be set in the Label Editor. This example shows how to change the "carscars" table caption to "New Cars".

 

Note: You can use this code in the AfterAppInit, AfterTableInit, BeforeProcess events.

 

Labels::setTableCaption("carscars", "New Cars");

See also:

Labels/Titles API: getTableCaption()

Miscellaneous settings: Table labels

About Labels/Titles API

 

Created with Help+Manual 7 and styled with Premium Pack Version 3 © by EC Software