Spread Windows Forms 6.0 Product Documentation
Caption Property
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread.CellType Namespace > CheckBoxCellType Class : Caption Property


Glossary Item Box

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

Syntax

Visual Basic (Declaration) 
Public Property Caption As String
Visual Basic (Usage)Copy Code
Dim instance As CheckBoxCellType
Dim value As String
 
instance.Caption = value
 
value = instance.Caption
C# 
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.
C#Copy Code
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 BasicCopy Code
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 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

© 2002-2012 ComponentOne, a division of GrapeCity. All Rights Reserved.