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

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

Name	Brief	Example
	Adds an internal menu to the main menu created from resource.
	Apply format stored in theme file to object.
	Attach an X-Function to the graphic object.
	Use for autosizing origin objects.
	If object is not active then activise it.
	Connect one object to another object.
	Copy object format into Clipboard. Format from clipboard maybe saved to theme file.
	Execute object LabTalk Methods
	Destroy (delete) the OriginObject.
	Remove origin object which has been attached before.
	Find UIDs where this object is an output.
	Find UIDs where this object is an input.
	Get a binary storage as a tree.
	Retrieve the comments from an object that supports Comments.
	Retrieve the UIDs of all the objects that are connected to this object.
	Get the event handler class name if present
	Get object format into Tree.
	Worked on grid frame window like Worksheet, MatrixLayer to set the grid related format.
	Get the operation that is using this object as its output.
	Get the index of an object in an Origin C Collection.
	Get data access bits.
	Get the long name of an object.
	Get named binary storage into vector of bytes.
	Given a selection type, this command depending upon the supplied screen co-ordinates, will supply a the resource ID and popup position of the most suitable popup menu.
	The short name of the Origin object, which can be a Column, a Layer, or a Page
	Get the parent object of this Origin object.
	Get object property via LabTalk property name
	Get the range string to represent this object.
	Get current worksheet, matrix or graph layer selection as a DataRange object.
	To find the operation object that generate this report.
	Access storage areas.
	Get names of storage class objects.
	Gets internal Unique IDentification number of Origin object.
	Invalidate an OriginObject.
	Checks the validity of this Origin object.
	Load a Layer from a OGW/OGM file in an existing WorksheetPage object only.
	Locks a particular object from read/write data access (Implemented only for WorksheetLayer, WorksheetPage, and Project Objects)
	Default constructor for OriginObject.
	Processes internal menu/button commands.
	Add/Update a binary storage using a Tree.
	Saves (Serializes) an OriginObject into an Orgin recognized file type.
	Sets the comments with a text string to an object that supports Comments.
	Install an Event Handler to the object.
	Set the index of an object in a collection.
	Sets the long name of an object
	Set/Create named binary storage
	Rename a Page.
	Set object property via LabTalk property name
	Unlocks a locked object for read/write data access. Unlock will remove protection completely, regardless of the type of locking. (Implemented only for WorksheetLayer, WorksheetPage, and Project Objects)
	Update IDs in trNode acording to theme rules

Property

Name	Brief	Example
	Read/Write the Show/Hide property of any Origin object