OriginObject::GetComments

GetComments

Description

Retrieve the comments from an object that supports Comments

Syntax

string GetComments( )

Parameters

Return

The comments

Examples

EX1

// Worksheet should be active. Example retrieves comments from Workbook and Column 2 (if any)
void OriginObject_GetComments_Ex1()
{
    Page pg = Project.Pages(); // Active workbook
    Worksheet wks = Project.ActiveLayer();
    Column col(wks, 1);
    
    string str;
    if(pg)
    {
        str = pg.GetComments();
        out_str(str);
    }
    if(col)
    {
        str = col.GetComments();
        out_str(str);
    }
}

Remark

Retrieve the comments from an object that supports Comments

Only Column and Page objects support comments

See Also

OriginObject::SetComments

header to Include

origin.h