com.spire.doc.fields
Class CheckBoxFormField

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.DocumentObject
              com.spire.doc.DocumentBase
                  com.spire.doc.fields.ParagraphBase
                      com.spire.doc.fields.TextRange
                          com.spire.doc.fields.Field
                              com.spire.doc.fields.FormField
                                  com.spire.doc.fields.CheckBoxFormField

All Implemented Interfaces:

IRunAttrSource, IDocumentObject, IField, IParagraphBase, ITextRange

public class CheckBoxFormField
extends FormField

Constructor Summary

CheckBoxFormField(IDocument doc)
Initializes a new instance of the CheckBoxFormField class.

Method Summary

int	getCheckBoxSize() Gets size of checkbox.
boolean	getChecked() Gets Checked property.
boolean	getDefaultCheckBoxValue() Gets default checkbox value.
DocumentObjectType	getDocumentObjectType() Gets the type of the document object.
CheckBoxSizeType	getSizeType() Gets check box size type.
void	setCheckBoxSize(int value) Sets size of checkbox.
void	setChecked(boolean value) Sets Checked property.
void	setDefaultCheckBoxValue(boolean value) Sets default checkbox value.
void	setSizeType(CheckBoxSizeType value) Sets check box size type.

Methods inherited from class com.spire.doc.fields.FormField

getCalculateOnExit, getEnabled, getFormFieldType, getHelp, getMacroOnEnd, getMacroOnStart, getName, getStatusBarHelp, setCalculateOnExit, setEnabled, setHelp, setMacroOnEnd, setMacroOnStart, setName, setStatusBarHelp

Methods inherited from class com.spire.doc.fields.Field

downloadImage, getCode, getEnd, getFieldText, getPattern, getSeparator, getTextFormat, getType, getValue, isLocked, isLocked, setCode, setEnd, setFieldText, setPattern, setTextFormat, setType

Methods inherited from class com.spire.doc.fields.TextRange

getCharacterFormat, getText, setText

Methods inherited from class com.spire.doc.fields.ParagraphBase

applyCharacterFormat, applyStyle, getAncestor, getChildObjects, getOwnerParagraph, getStyleName, isDeleteRevision, isInsertRevision

Methods inherited from class com.spire.doc.DocumentObject

deepClone, getFirstChild, getLastChild, getNextSibling, getOwner, getPreviousSibling, isComposite, toString

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Methods inherited from interface com.spire.doc.interfaces.ITextRange

applyCharacterFormat, getCharacterFormat, getText, setText

Methods inherited from interface com.spire.doc.interfaces.IParagraphBase

applyStyle, getOwnerParagraph, getStyleName

Methods inherited from interface com.spire.doc.interfaces.IDocumentObject

deepClone, getDocument, getNextSibling, getOwner, getPreviousSibling, isComposite

Methods inherited from interface com.spire.doc.documents.IRunAttrSource

clearRunAttrs, fetchInheritedRunAttr, getDirectRunAttr, getDirectRunAttrByIndex, getDirectRunAttrsCount, setRunAttr

Constructor Detail

CheckBoxFormField

public CheckBoxFormField(IDocument doc)

Initializes a new instance of the CheckBoxFormField class.

Parameters:

doc - the document

Method Detail

getDocumentObjectType

public DocumentObjectType getDocumentObjectType()

Gets the type of the document object.

Specified by:

getDocumentObjectType in interface IDocumentObject

Overrides:

getDocumentObjectType in class Field

Returns:

the type of the document object.

getCheckBoxSize

public int getCheckBoxSize()

Gets size of checkbox.

Returns:

size of checkbox.

setCheckBoxSize

public void setCheckBoxSize(int value)

Sets size of checkbox.

Parameters:

value - size of checkbox.

getDefaultCheckBoxValue

public boolean getDefaultCheckBoxValue()

Gets default checkbox value.

Returns:

boolean

setDefaultCheckBoxValue

public void setDefaultCheckBoxValue(boolean value)

Sets default checkbox value.

Parameters:

value - boolean

getChecked

public boolean getChecked()

Gets Checked property.

Returns:

boolean

setChecked

public void setChecked(boolean value)

Sets Checked property.

Parameters:

value - boolean

getSizeType

public CheckBoxSizeType getSizeType()

Gets check box size type.

Returns:

CheckBoxSizeType

setSizeType

public void setSizeType(CheckBoxSizeType value)

Sets check box size type.

Parameters:

value - CheckBoxSizeType