Caption Property (FpCheckBox)

Gets or sets the default text displayed in the check box.

Syntax

Visual Basic
C#

'Declaration
 
Public Overridable Property Caption As String

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

public virtual string Caption {get; set;}

Property Value

String containing the caption text

Remarks

Use this property if you are not going to specify different text for each state of the check box. To specify different text for each state, set the TextIndeterminate, TextFalse, and TextTrue properties.

If you set text for the different states, that text overrides the setting for the Caption property when the control is in that state. For example, if you set text for the TextTrue property, but not the TextIndeterminate or TextFalse properties, when the check box is true, the text displayed is the TextTrue property text. When the check box is false or indeterminate, the text is the Caption text.

Example

private void Form1_Load(object sender, System.EventArgs e)
{
     control.CheckState = CheckState.Unchecked;
     control.PictureAlignH=FarPoint.Win.HorizontalAlignment.Center;
     control.PictureAlignV = FarPoint.Win.VerticalAlignment.Center;
     control.BackgroundImage = new FarPoint.Win.Picture(Image.FromFile("d:\\mail16a.ico", true), FarPoint.Win.RenderStyle.Normal);
}
private void control_CheckChanged(object sender, System.EventArgs e)
    {
    if (control.CheckState == CheckState.Checked)
    { 
        control.BackgroundImage = new FarPoint.Win.Picture(Image.FromFile("d:\\mail16a.ico", true), FarPoint.Win.RenderStyle.Normal);
        control.PictureAlignH = FarPoint.Win.HorizontalAlignment.Center;
        control.PictureAlignV = FarPoint.Win.VerticalAlignment.Center;
        control.TextTrue = "Mail's been checked";
    }
   else if (control.CheckState == CheckState.Unchecked) 
   {
        control.BackgroundImage = new FarPoint.Win.Picture(Image.FromFile("d:\\mail16b.ico", true), FarPoint.Win.RenderStyle.Normal);
        control.PictureAlignH = FarPoint.Win.HorizontalAlignment.Center;
        control.PictureAlignV = FarPoint.Win.VerticalAlignment.Center;
        control.TextFalse = "Mail needs to be checked";
    }
    else
    {
        control.CheckState = CheckState.Indeterminate;
        control.TextIndeterminate = "No mail today";
    }
}

Visual Basic

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
     control.Checked = False
     control.BackgroundImage = New FarPoint.Win.Picture(Image.FromFile("d:\\mail16a.ico", True), FarPoint.Win.RenderStyle.Normal)
End Sub

Private Sub control_CheckChanged(ByVal sender As Object, ByVal e As System.EventArgs) Handles control.CheckChanged
     If control.CheckState = CheckState.Checked Then
          control.BackgroundImage = New FarPoint.Win.Picture(Image.FromFile("d:\\mail16a.ico", True), FarPoint.Win.RenderStyle.Normal)
          control.PictureAlignH = FarPoint.Win.HorizontalAlignment.Center
          control.PictureAlignV = FarPoint.Win.VerticalAlignment.Center
          control.TextTrue = "Mail's been checked"
     ElseIf control.CheckState = CheckState.Unchecked Then
          control.BackgroundImage = New FarPoint.Win.Picture(Image.FromFile("d:\\mail16b.ico", True), FarPoint.Win.RenderStyle.Normal)
          control.PictureAlignH = FarPoint.Win.HorizontalAlignment.Center
          control.PictureAlignV = FarPoint.Win.VerticalAlignment.Center
          control.TextFalse = "Mail needs to be checked"
     Else
          control.CheckState = CheckState.Indeterminate
          control.TextIndeterminate = "No mail today"
     End If
 End Sub

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

FpCheckBox Class
FpCheckBox Members
TextIndeterminate Property
TextFalse Property
TextTrue Property