Worksheet::SetEmbeddingParams

SetEmbeddingParams

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

Description

Sets embedding parameters if there is an embedding at the cell identified by nRow, nCol and dwEmbedParams

Syntax

BOOL SetEmbeddingParams( int nRow, int nCol, DWORD dwEmbedParams, BOOL bSet = TRUE, BOOL bColLabels = FALSE )

Parameters

nRow: [input] row index or Label type of the cell that has the embedding.
nCol: [input] column index of the cell that has the embedding.
dwEmbedParams: [input] can be one or more of the following:(EMBEDGRAPH_IN_LABELS must be set for embeddings in Label); EMBEDGRAPH_KEEP_ASPECT_RATIO = 0x00000010, // Keep Aspect Ratio; EMBEDGRAPH_IN_LABELS = 0x00000020, // Embeds the graph in Label; EMBEDGRAPH_HIDE_AXES = 0x00000100, // hides Axes; EMBEDGRAPH_HIDE_LEGENDS = 0x00000200, // hides legends; EMBEDGRAPH_HIDE_SPECTRUMS = 0x00000400, // hides spectrums; EMBEDGRAPH_HIDE_TEXT_OBJS = 0x00000800, // hides texts; EMBEDGRAPH_SPARKLINE_LARGE = 0x00004000, // the copy in clipboard is larger than default; EMBEDGRAPH_SPARKLINE_CLIPBOARD = 0x00008000, // put a copy onto clipboard; EMBEDGRAPH_CACHE_IN_PAGE = 0x00100000, // cache image in page
bSet: [input] determines whether to set or clear the setting bits. When TRUE (default) sets the parameter bits passed in dwEmbedParams; otherwise will clear those bits
bColLabels: [input] when true, search for embeddings will only be performed in Labels the area

Return

return TRUE if successful

Examples

EX1

//Sets embedding parameters if there is an embedding at the cell identified by nRow, nCol and dwEmbedParams. 
void Worksheet_SetEmbeddingParams_Ex1()
{
    Worksheet wks = Project.ActiveLayer();
    if(!wks)
        return;
    
    DWORD dwEmbedParams = EMBEDGRAPH_KEEP_ASPECT_RATIO;
    
    if(!wks.SetEmbeddingParams(0, 0, dwEmbedParams))
        printf("Failed to set embedded params");
}