caption Method

In This Topic

Gets or sets the caption of the cell type.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GC.Spread.Sheets.CellTypes.CheckBox();
var returnValue; // Type: any
returnValue = instance.caption(value);

function caption( 
   value : string
) : any;

Parameters

value: The caption of the cell type.

Return Value

If no value is set, returns the caption; otherwise, returns the check box cell type.

Example

This example creates a check box cell.

Javascript

var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.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

CheckBox class

Product Support Forum | Print this page