2.2.4.20 GraphPage


Name

GraphPage

Remark

The GraphPage class provides methods and properties common to all internal Origin graph pages (windows).

An Origin C GraphPage object is a wrapper object that is a reference to an internal Origin graph page 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 GraphPage class is derived from the Page, PageBase, and OriginObject classes from which it inherits methods and properties.

The Origin C Project class (Project.h) contains a collection of all GraphPage objects named GraphPages in the open project file. Once accessed, a GraphPage object can be used to locate and access layers within the Origin graph page (i.e. use the Layers collection of the Page class or use the GraphLayers collection of the GraphPage class) which can in turn be used to access such things as DataPlots or GraphicObjects in the layer.

Hierarchy

Examples

EX1

void GraphPage_ex1()
{
    GraphPage gp;
    gp.Create("origin");
    if( gp.IsValid() )
    {
        GraphPage gp2(gp.GetName());
        if( gp2.IsValid() )
            printf("gp and gp2 are both attached to '%s'\n", gp2.GetName());
    }
}

Header to Include

origin.h

Reference

Members

Name Brief Example
AppendLayers Append layers from the specified template to the page. Examples
GetCommonUPL Get common user defined parameter labels among all layers in graphpage. Examples
GetLegendsUpdateMode Get legend update mode. Examples
GraphPage Construct a GraphPage object using the name of an existing page. Examples
IsCloneableEnabled Get state of graphpage cloneable . Examples
IsUseSpeedModeForExport Get speed mode state for export. Examples
LoadTemplate Load a template into the page removing any existing layers. Examples
RemoveTemplatePict Remove template preview image from GraphPage. Examples
Resize Change page width and height. Examples
SetLegendsUpdateMode set legend update mode. Examples
SetUseSpeedModeForExport set speed mode for export. Examples

Property

Name Brief Example
AxisLayerIcons Property to show or hide layer icons on axes Examples
Layers A Collection of all GraphLayers in a GraphPage. Examples