Page

Page-obj

Page object can be used to read/control the properties of graph, workbook and matrix window. For example, we can active a worksheet or a graph layer by page.active property. Or using the page.nlayers property, we can either know how many layers in a graph window, or the number of sheets in a workbook. For more details, you can see examples below.

Properties:Page Property

Page properties can be accessed using the following syntax:

[winName!]page.property =

winName! Is optional. If winName! Is not specified, the active window is affected.

Methods:Page Method

To run the object methods, use the following script:

[winName!]page.method(argument)

Examples:

Active Page Layer

This script uses the active property to set layer 2 in the Graph1 window as the active layerlayer, active.

Graph1!page.active = 2;

Active WorksheetActive Worksheet

Page.active property can also activate a worksheet. Such as:

page.active = 2; // Active the 2nd worksheet
page.active$ = "Raw Data" // Active the worksheet named "Raw Data"

Note: When specifying a window's name in page.active property, it just sets the layer or worksheet in the window as the active worksheet, but not the active window. The below example demonstrates how this happens.

// Create a new workbook and save the name to bkn$
newbook result:=bkn$;
// Add a new worksheet to bkn$, now there are two worksheets
// and sheet2 is active worksheet
newsheet;
// Create another workbook, now the active window is the new one
newbook;
// Make sheet1 in bkn$ active
bkn$!page.active = 1;
// Since the second workbook is active window,
// data will be filled in new workbook, not bkn$
col(a) = {1:10};

Reorder Layers

This script uses the reorder() method to change layer 1 to layer 2. Layer 2 will move up a position to layer 1. Use the Edit: Add & Arrange Layers menu command to physically move the positions.

Graph1!page.reorder(1,2);

Work with Window Names

The page.title property controls how to display the window names, short name, long name, or both. And you can use page.label$ to get or set window's long name.

page.label$ = "Temperature"; // Rename the long name to "Temperature"
page.title = 3; // Show both short name and long name

Although there is a page.name$, this property is read only, so you can just get the window's name by this property. To rename a windowRename Window, use the win -r command.

string wn$ = page.name$; // Get the window name
win -r %(wn$) Source; // Rename the window name to Source

Know the Number of Layers/Worksheets

Page.nlayers returns the number of layers on a graph, or the number of worksheets in a workbook, and even the number of matrix sheets in a matrix window. This script loops over each layer in the active graph window and types the layer number to the Script window.

Loop (num,1,page.nlayers)   
//loop from 1 to the # of layers in the page
{
      type "layer number $(num)";
};

And you can use a similar way to get the number of worksheets in a book.

book1!page.nlayers=;

Adding Sheets to Workbooks or Matrices

Beginning with Origin 2018 SR0, the maximum number of sheets was increased to 1024 (OPJU project file format only).

Adding many sheets at once using repeat can be very slow.

repeat 500 { newsheet; }

To facilitate adding large numbers of sheets to a book, the LabTalk property page.nlayers was made writable, as for example:

page.nlayers = 500 // this is faster than repeat