Class PdfLoadedCheckBoxItem

Represents loaded check box item.

Inheritance
System.Object
PdfLoadedFieldItem
PdfLoadedStateItem
PdfLoadedCheckBoxItem
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.Pdf.Parsing
Assembly: Syncfusion.Pdf.Base.dll
Syntax
public class PdfLoadedCheckBoxItem : PdfLoadedStateItem
Examples
//Load an existing document.
PdfLoadedDocument doc = new PdfLoadedDocument("SourceForm.pdf");
// Load an existing Check field
PdfLoadedCheckBoxField checkField = doc.Form.Fields["Java"] as PdfLoadedCheckBoxField;
// Loads the check box items collection.
PdfLoadedCheckBoxItemCollection checkCollection = checkField.Items;
// Read the first item of the collection
PdfLoadedCheckBoxItem checkItem = checkCollection[0];
checkItem.Checked = false;            
doc.Save("Form.pdf");
doc.Close(true);
'Load an existing document.
Dim doc As PdfLoadedDocument = New PdfLoadedDocument("SourceForm.pdf")
' Load an existing Check field
Dim checkField As PdfLoadedCheckBoxField = TryCast(doc.Form.Fields("Java"), PdfLoadedCheckBoxField)
' Loads the check box items collection.
Dim checkCollection As PdfLoadedCheckBoxItemCollection = checkField.Items
' Read the first item of the collection
Dim checkItem As PdfLoadedCheckBoxItem = checkCollection(0)
checkItem.Checked = False
doc.Save("Form.pdf")
doc.Close(True)

Properties

ExportValue

Gets the export value of the checkbox field.

Declaration
public string ExportValue { get; }
Property Value
Type
System.String
Examples
//Load the PDF document.
FileStream docStream = new FileStream("Input.pdf", FileMode.Open, FileAccess.Read);
PdfLoadedDocument loadedDocument = new PdfLoadedDocument(docStream);
//Get the loaded form.
PdfLoadedForm loadedForm = loadedDocument.Form;
//Read the check box from field collection.
PdfLoadedCheckBoxField checkBoxField = loadedDocument.Form.Fields[0] as PdfLoadedCheckBoxField;
//Get the first item of the check box field.
PdfLoadedCheckBoxFieldItem checkBoxItem = checkBoxField.Items[0];
//Get the export value of the check box item.
string  export = checkBoxItem.ExportValue;
//Close the document
loadedDocument.Close(true);

Style

Gets or sets the style.

Declaration
public PdfCheckBoxStyle Style { get; set; }
Property Value
Type Description
PdfCheckBoxStyle

The PdfCheckBoxStyle object specifies the style of the check box field.

See Also