2.2.4.32 OriginObject

Name

OriginObject

Remark

OriginObject is the Origin C base class for all Origin objects and provides member functions and data members common to all Origin objects.

Hierarchy

• OriginObject
  • Axis
  • AxisObject
  • DataObjectBase
  • DataRange
  • DatasetObject
  • GraphObject
  • Grid
  • GroupPlot
  • Layer
  • PageBase
  • Project
  • Scale

Examples

EX1

// This example assumes that a workbook window is active in Origin
int OriginObject_ex1()
{
    // Worksheet and WorksheetPage objects are OriginObjects and IsValid,
    // GetName, GetIndex, GetParent, GetLongName, GetComments, and GetIndex
    // are OriginObject member functions
    Worksheet wks; // Worksheet is an OriginObject and inherits its members
    wks = (Worksheet) Project.ActiveLayer();
    if( wks.IsValid() )
    {
        printf("Worksheet is Valid!\n");
        printf("The Worksheet's (Short) Name is %s.\n", wks.GetName());
        printf("The Worksheet's index is %d.\n", wks.GetIndex());
        WorksheetPage wp; // WorksheetPage is an OriginObject and inherits its members
        wks.GetParent(wp);
        if( wp.IsValid() )
        {
            printf("WorksheetPage is Valid!\n");
            printf("The WorksheetPage's (Short) Name is %s.\n", wp.GetName());
            printf("The WorksheetPage's Long Name is %s.\n", wp.GetLongName());
            printf("The WorksheetPage's Comments are %s.\n", wp.GetComments());
        }
    }
    else
        out_str("Worksheet is not Valid!");
    return 0;
}

Header to Include

origin.h

Reference

Members

Property