FormCheckBoxData Class

Namespace:
GemBox.Document
Assembly:
GemBox.Document.dll

Represents a form related data associated with the parent FormCheckBox field within the document.

public sealed class FormCheckBoxData : FormFieldData
Public NotInheritable Class FormCheckBoxData
    Inherits FormFieldData
Inheritance:
System.Object
FormCheckBoxData

Properties

DefaultValue

Gets or sets the default Check Box state for the parent Check Box form field. Default value is false (Check Box is unchecked).

public bool DefaultValue { get; set; }
Public Property DefaultValue As Boolean
Property Value
System.Boolean

true if default state for the parent Check Box form field is checked; otherwise, false.

Size

Gets or sets the exact size for the parent Check Box form field in points. If value is null, then parent Check Box form field shall be sized automatically using the point size which is applied via the style hierarchy.

public double? Size { get; set; }
Public Property Size As Double?
Property Value
System.Nullable<System.Double>

The exact size for the parent Check Box form field in points or null if parent Check Box is automatically sized via the style hierarchy.

Value

Gets or sets the current state for a Check Box form field or null if state is not explicitly set.

public bool? Value { get; set; }
Public Property Value As Boolean?
Property Value
System.Nullable<System.Boolean>

The current state for a Check Box form field or null if state is not explicitly set.

ValueOrDefault

Gets the Value for a Check Box form field if state is explicitly set; otherwise, the DefaultValue.

public bool ValueOrDefault { get; }
Public ReadOnly Property ValueOrDefault As Boolean
Property Value
System.Boolean

The Value for a Check Box form field if state is explicitly set; otherwise, the DefaultValue.

Inherited Properties

CalculateOnExit

Gets or sets a value indicating whether the content of all fields within the document shall be recalculated from their field codes when the content of the parent form field is modified.

(Inherited from FormFieldData)

Enabled

Gets or sets a value indicating whether the parent form field shall behave as though it is enabled or disabled when it is displayed in the document. Default value is true.

(Inherited from FormFieldData)

EntryMacro

Gets or sets the subroutine in a scripting language which should be executed when the value of the parent form field is entered.

(Inherited from FormFieldData)

ExitMacro

Gets or sets the subroutine in a scripting language which should be executed when the value of the parent form field is exited.

(Inherited from FormFieldData)

Field

Gets the parent form field.

(Inherited from FormFieldData)

HelpText

Gets or sets the optional help text which shall be associated with the parent form field.

(Inherited from FormFieldData)

IsHelpTextAutoEntry

Gets or sets a value indicating whether HelpText should be interpreted as the name of a glossary document entry whose contents contain the help text.

(Inherited from FormFieldData)

IsStatusTextAutoEntry

Gets or sets a value indicating whether StatusText should be interpreted as the name of a glossary document entry whose contents contain the status text.

(Inherited from FormFieldData)

Name

Gets or sets the name of the form field.

(Inherited from FormFieldData)

StatusText

Gets or sets the optional status text which shall be associated with the parent form field.

(Inherited from FormFieldData)

Inherited Methods

Reset()

Resets the Value of this form field instance.

(Inherited from FormFieldData)

ToString()

Returns a System.String that represents this FormFieldData instance.

(Inherited from FormFieldData)

Examples