CheckBoxForm

Inheritance: java.lang.Object

All Implemented Interfaces: com.groupdocs.editor.words.fieldmanagement.IFormField

public final class CheckBoxForm implements IFormField

Represents a form field that displays a checkbox.

Constructors

Constructor	Description
CheckBoxForm(String stylesheet, String name)	Initializes a new instance of the CheckBoxForm class with the specified stylesheet and name.

Methods

Method	Description
getStylesheet()	Gets the stylesheet applied to the form field.
getReadonly()	Gets or sets a value indicating whether the form field is read-only.
setReadonly(boolean value)	Gets or sets a value indicating whether the form field is read-only.
getName()	Gets the name of the form field.
getType()	Gets the type of the form field, which is always FormFieldType.CheckBox for this class.
getLocaleId()	Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.
setLocaleId(int value)	Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.
getStatusText()	Gets or sets the status text associated with the form field, the source of the text that’s displayed in the status bar when a form field has the focus.
setStatusText(HelpText value)	Gets or sets the status text associated with the form field, the source of the text that’s displayed in the status bar when a form field has the focus.
getHelpText()	Gets or sets the help text associated with the form field, the source of the text that’s displayed in a message box when a form field has the focus and the user presses F1.
setHelpText(HelpText value)	Gets or sets the help text associated with the form field, the source of the text that’s displayed in a message box when a form field has the focus and the user presses F1.
getValue()	Gets or sets the value of the form field, which represents the state of the checkbox.
setValue(boolean value)	Gets or sets the value of the form field, which represents the state of the checkbox.

CheckBoxForm(String stylesheet, String name)

public CheckBoxForm(String stylesheet, String name)

Initializes a new instance of the CheckBoxForm class with the specified stylesheet and name.

Parameters:

Parameter	Type	Description
stylesheet	java.lang.String	The stylesheet to apply to the form field.
name	java.lang.String	The name of the form field.

getStylesheet()

public final String getStylesheet()

Gets the stylesheet applied to the form field.

Returns: java.lang.String

getReadonly()

public final boolean getReadonly()

Gets or sets a value indicating whether the form field is read-only.

Returns: boolean

setReadonly(boolean value)

public final void setReadonly(boolean value)

Gets or sets a value indicating whether the form field is read-only.

Parameters:

Parameter	Type	Description
value	boolean

getName()

public final String getName()

Gets the name of the form field.

Returns: java.lang.String

getType()

public final int getType()

Gets the type of the form field, which is always FormFieldType.CheckBox for this class.

Returns: int

getLocaleId()

public final int getLocaleId()

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

The following example demonstrates how to set the LocaleId property:
 
 Set the LocaleId to represent the English (United States) culture
 checkBoxField.LocaleId = new CultureInfo("en-US").LCID;

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

Returns: int

setLocaleId(int value)

public final void setLocaleId(int value)

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

The following example demonstrates how to set the LocaleId property:
 
 Set the LocaleId to represent the English (United States) culture
 checkBoxField.LocaleId = new CultureInfo("en-US").LCID;

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

Parameters:

Parameter	Type	Description
value	int

getStatusText()

public final HelpText getStatusText()

Gets or sets the status text associated with the form field, the source of the text that’s displayed in the status bar when a form field has the focus.

If set to false , the status text will not be applied.

Returns: HelpText

setStatusText(HelpText value)

public final void setStatusText(HelpText value)

Gets or sets the status text associated with the form field, the source of the text that’s displayed in the status bar when a form field has the focus.

If set to false , the status text will not be applied.

Parameters:

Parameter	Type	Description
value	HelpText

getHelpText()

public final HelpText getHelpText()

Gets or sets the help text associated with the form field, the source of the text that’s displayed in a message box when a form field has the focus and the user presses F1.

If set to false , the help text will not be applied.

Returns: HelpText

setHelpText(HelpText value)

public final void setHelpText(HelpText value)

Gets or sets the help text associated with the form field, the source of the text that’s displayed in a message box when a form field has the focus and the user presses F1.

If set to false , the help text will not be applied.

Parameters:

Parameter	Type	Description
value	HelpText

getValue()

public final boolean getValue()

Gets or sets the value of the form field, which represents the state of the checkbox.

Returns: boolean

setValue(boolean value)

public final void setValue(boolean value)

Gets or sets the value of the form field, which represents the state of the checkbox.

Parameters:

Parameter	Type	Description
value	boolean

CurrentDateFormField