Column::SetComments

SetComments

Description

Set the comments in a column label.

Syntax

BOOL SetComments( LPCSTR lpcszComments, BOOL bUndo = FALSE )

Parameters

lpcszComments

[input] Pointer to the comments to set.

bUndo

[input] Operation is undoable if TRUE.

Return

TRUE if OK, otherwise FALSE.

Examples

EX1

// Create a worksheet and add some Comments
void Column_SetComments_Ex1()
{
    Worksheet    wks;
    wks.Create("Origin", CREATE_VISIBLE);
    wks.Columns(0).SetComments("Product Code\nColor");
    wks.Columns(1).SetComments("HG42\nRed");
}

Remark

Sets the comments in a column label.

Comments are the only labels that can be multiline.

See Also

Column::GetComments, Column::GetExtendedLabel, Column::SetExtendedLabel

header to Include

origin.h