SetSheetID

Description

Sets the unique identifier for an open sheet.

Applies to

Window objects

Syntax

controlname.SetSheetID ( sheetname )

Argument

Description

controlname

The open sheet to be identified.

sheetname

A unique string identifier for the sheet, which is used when layout is persisted.


Return value

Integer.

Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, SetSheetID returns null.

Usage

If no sheet identifier was set when it was opened by one of the OpenSheet functions, you can set an ID using the SetSheetID function. You can also change a sheet's ID.

Examples

window win[]
OpenSheetDocked(win[1], this, WindowDockLeft!, "")
win[1].SetSheetID("sheet1")

See also

SetTextColor

SetTextStyle