SetDocumentTitle

All Editions $image\bltlrgss.gif$ Related Transactions $image\bltlrgss.gif$ Example

The SetDocumentTitle transaction assigns a label to the specified document. This transaction can be applied to a single-page document (in which case it has the same effect as SetPageTitle), or to a multipage document.

If the document is a page, the new label will be displayed in the document window title bar. If the document is a multipage, the label may be displayed in the title bar, depending on a CFG file setting. The CFG file settings can be defined by using SetUIConfiguration.

Type XTYP_EXECUTE

Syntax [SetDocumentTitle(docwinID, "documentLabel")]

Parameter	Data type	Values	Meaning
docwinID	DWORD	0 \| docwinID	active \| specific
documentLabel	string	label, maximum 80 characters

Release information

Added in Release 3.50.