caption Method

Gets or sets the caption of the cell type.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GcSpread.Sheets.CheckBoxCellType();
var returnValue; // Type: string
returnValue = instance.caption(value);

function caption( 
   value : string
) : string;

Parameters

value: The caption of the cell type.

Return Value

The caption.

Example

This example creates a check box cell.

Javascript

var cellType1 = new GcSpread.Sheets.CheckBoxCellType();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GcSpread.Sheets.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
activeSheet.getCell(1, 1).cellType(cellType1);

Remarks

The default value is an empty string. If you do not set the textTrue, textFalse, or textIndeterminate method, this method determines the default text that appears with the check box, regardless of its state.

Reference

CheckBoxCellType class