OriginObject::GetRangeString

GetRangeString

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 Header to Include

Description

Get the range string to represent this object

Syntax

BOOL GetRangeString( string & strRange, DWORD dwCntrl = NTYPE_AUTO )

Parameters

strRange: [output] to return range string
dwCntrl: [input] NTYPE_AUTO, NTYPE_SHORT for the object level control, but can also add NTYPE_BOOKSHEET_XY_RANGE to get XY for DataPlot

Return

true for success

Examples

EX1

void OriginObject_GetRangeString_Ex1(BOOL bShowPlotWithBookSheetInfo = false)
{
    GraphPage gp = Project.Pages();
    int ii = 0;
    DWORD dwCntrl;

    if(bShowPlotWithBookSheetInfo)
        dwCntrl = NTYPE_BOOKSHEET_XY_RANGE | NTYPE_ADD_ROW_RANGE;
    else
        dwCntrl = NTYPE_FOR_RANGE | NTYPE_ADD_ROW_RANGE;

    foreach(GraphLayer gl in gp.Layers)
    {
        foreach(DataPlot dp in gl.DataPlots)
        {
            string strPlotRange;
            BOOL bRet = dp.GetRangeString(strPlotRange, dwCntrl);
            out_str(strPlotRange);
        }
    }
}