2.2.4.32.41 OriginObject::SetComments

SetComments

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

Description

Sets the comments with a text string to an object that supports Comments

Syntax

BOOL SetComments( LPCSTR lpcszComments )

Parameters

lpcszComments: [input]pointer to the comments to set

Return

TRUE if OK, FALSE if object does not support comments.

Examples

EX1

// Worksheet with at least one column should be active
void OriginObject_SetComments_Ex1()
{
    string str;
    str = "Workbook Comment\r\nThis is a test of some comments\r\nWhich can have multiple lines";
    Page pg = Project.Pages();
    if(pg)
        pg.SetComments(str);
    Worksheet wks = Project.ActiveLayer();
    Column col(wks, 0);
    str = "Column Comment\r\nThis is a test of some comments\r\nWhich can have multiple lines";
    if(col)
        col.SetComments(str);
    pg.Refresh();
}