Worksheet::GetEmbeddedGraphs

GetEmbeddedGraphs

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

Description

Provides access to all embedded graphs

Syntax

int GetEmbeddedGraphs( StringArray & names, DWORD dwExcludeBits = 0 )

Parameters

names: [output] receives the names of the embedded graphs
dwExcludeBits: [input] Used to filter pages. Embedded pages that have these bits are excluded from the collection.; Could be one or more of the following bits; EMBEDGRAPH_KEEP_ASPECT_RATIO, EMBEDGRAPH_IN_LABELS, EMBEDGRAPH_DISPLAY_MASK, EMBEDGRAPH_HIDE_AXES, EMBEDGRAPH_HIDE_LEGENDS, EMBEDGRAPH_HIDE_SPECTRUMS,; EMBEDGRAPH_HIDE_TEXT_OBJS, EMBEDGRAPH_SPARKLINE_LARGE, EMBEDGRAPH_SPARKLINE_CLIPBOARD, EMBEDGRAPH_SPARKLINE_MASK, EMBEDGRAPH_CACHE_IN_PAGE

Return

returns the number of graphs embedded

Examples

EX1

//receives the names of the embedded graphs. 
void Worksheet_GetEmbeddedGraphs_Ex1()
{
    Worksheet wks = Project.ActiveLayer();
    if(!wks)
        return;
    
    StringArray vsNames;
    
    int nn = wks.GetEmbeddedGraphs(vsNames);
    if(nn == 0)
        printf("no embedded graphs");
    else
        printf("%d embedded graphs", nn);
}