DataPlot::GetSymbol

GetSymbol

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

Description

Get index of the plot symbol in the symbol gallery.

Syntax

int GetSymbol( )

Parameters

None

Return

An Integer value which is the index of current symbol for this DataPlot.

Examples

void DataPlot_GetGetSymbol_Ex1()
{
        //make sure there exists a graph with dataplots on it before running this code.
        GraphLayer gl = Project.ActiveLayer();
        if ( gl )
        {
                DataPlot dp = gl.DataPlots(0); //get the first dataplot on graphlayer
                if ( dp )
                {
                        int nSymbol = dp.GetSymbol(); //get index value of Integer, which stands for the Symbol property of the DataPlot
                        if ( nSymbol < 0 )
                                printf("DataPlot is not a valid object");
                        else
                                printf("DataPlot has Symbol value of %d\n", nSymbol);
                }
        }
}