Worksheet

Worksheet-Class

Name

Worksheet

Remark

The Worksheet class provides methods and properties common to worksheet layers in Origin worksheet pages. An Origin worksheet may contain a number of worksheet columns thus the Worksheet class contains a collection of all the columns in the worksheet.

An Origin C Worksheet object is a wrapper object that is a reference to an internal Origin worksheet object. Origin C wrapper objects do not actually exist in Origin and merely refer to the internal Origin object. Consequently, multiple Origin C wrapper objects can refer to the same internal Origin object.

The Worksheet class is derived from the Datasheet, Layer, and OriginObject classes from which it inherits methods and properties.

Hierarchy

• OriginObject
  • Layer
    • Datasheet
      • Worksheet

Examples

EX1

// Delete all the columns in the active worksheet.
int Worksheet_Worksheet_Ex1()
{
    Worksheet wks = Project.ActiveLayer();
    if(wks)
    {
        out_int("Number of columns to be deleted = ", wks.GetNumCols());
        // The following loop will continue until it fails to delete the first
        // column in the worksheet.  Each time the first column is deleted the
        // other columns are shifted left causing the second column to become
        // the first column.
        while(wks.DeleteCol(0));
    }
    else
        out_str("The active window is not a worksheet.");
    return 0;
}

EX2

// Access a specific sheet in a specific book
void Worksheet_Worksheet_Ex2()
{
    Worksheet wks("[Book2]Sheet3");
    if(wks)
    {
        int nR1, nR2;
        wks.GetBounds(nR1, 0, nR2, -1);// need to convert to LabTalk indexing by +1
            printf("Worksheet [%s]%s has %d rows of data\n", wks.GetPage().GetName(), wks.GetName(), nR2+1);
    }
    else
        out_str("No such sheet");
}

header to Include

origin.h

Reference

Members

Property