Caption Property (CheckBoxCellType)

Gets or sets the text in the check box regardless of the state, overrides TextTrue, TextFalse, and TextIndeterminate.

Syntax

Visual Basic
C#

'Declaration
 
Public Property Caption As String

'Usage
 
Dim instance As CheckBoxCellType
Dim value As String
 
instance.Caption = value
 
value = instance.Caption

public string Caption {get; set;}

Property Value

String containing the caption text

Remarks

If you do not set the TextTrue, TextFalse, or TextIndeterminate properties, this property determines the default text that appears with the check box, regardless of its state.

Example

This example sets the properties of a two-state check box in a cell.

FarPoint.Win.Spread.CellType.CheckBoxCellType ckbxcell = new FarPoint.Win.Spread.CellType.CheckBoxCellType();
ckbxcell.Picture(FarPoint.Win.CheckBoxPictureIndex.True) = Image.FromFile("..\\images\\checked.gif");
ckbxcell.Picture(FarPoint.Win.CheckBoxPictureIndex.False) = Image.FromFile("..\\images\\unchecked.gif");
ckbxcell.TextAlign = FarPoint.Win.ButtonTextAlign.TextRightPictLeft;
ckbxcell.Caption = "Item Selected?";
fpSpread1.Sheets[0].Cells[2,2].CellType = ckbxcell;

Visual Basic

Dim ckbxcell As New FarPoint.Win.Spread.CellType.CheckBoxCellType()
ckbxcell.Picture(FarPoint.Win.CheckBoxPictureIndex.True) = Image.FromFile("..\images\checked.gif")
ckbxcell.Picture(FarPoint.Win.CheckBoxPictureIndex.False) = Image.FromFile("..\images\unchecked.gif")
ckbxcell.TextAlign = FarPoint.Win.ButtonTextAlign.TextRightPictLeft
ckbxcell.Caption = "Item Selected?"
FpSpread1.ActiveSheet.Cells(2,2).CellType = ckbxcell

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

Reference

CheckBoxCellType Class
CheckBoxCellType Members