Class PdfLoadedCheckBoxField
Represents check box of an existing PDF document.
Inheritance
System.Object
PdfLoadedCheckBoxField
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.Pdf.Parsing
Assembly: Syncfusion.Pdf.Base.dll
Syntax
public class PdfLoadedCheckBoxField : PdfLoadedStateField, IPdfWrapper
Examples
//Load an existing document.
PdfLoadedDocument doc = new PdfLoadedDocument("SourceForm.pdf");
// Load an existing Check field
PdfLoadedCheckBoxField checkField = doc.Form.Fields["Java"] as PdfLoadedCheckBoxField;
checkField.Checked = true;
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)
checkField.Checked = True
doc.Save("Form.pdf")
doc.Close(True)
Properties
BackColor
Gets or sets the back color of the field
Declaration
public PdfColor BackColor { get; set; }
Property Value
Type | Description |
---|---|
PdfColor |
Checked
Gets or sets a value indicating whether this PdfLoadedCheckBoxField is checked.
Declaration
public bool Checked { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | True if the check box is checked, false otherwise. |
Examples
//Load an existing document.
PdfLoadedDocument doc = new PdfLoadedDocument("SourceForm.pdf");
// Load an existing Check field
PdfLoadedCheckBoxField checkField = doc.Form.Fields["Java"] as PdfLoadedCheckBoxField;
checkField.Checked = true;
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)
checkField.Checked = True
doc.Save("Form.pdf")
doc.Close(True)
See Also
ForeColor
Gets or sets the fore color of the field.
Declaration
public PdfColor ForeColor { get; set; }
Property Value
Type | Description |
---|---|
PdfColor |
Items
Gets the collection of check box items.[Read-Only]
Declaration
public PdfLoadedCheckBoxItemCollection Items { get; }
Property Value
Type | Description |
---|---|
PdfLoadedCheckBoxItemCollection |
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;
checkCollection[0].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
checkCollection(0).Checked = False
doc.Save("Form.pdf")
doc.Close(True)
See Also
Style
Gets or sets the checkbox style of the field.
Declaration
public PdfCheckBoxStyle Style { get; set; }
Property Value
Type | Description |
---|---|
PdfCheckBoxStyle |
Methods
Remove(PdfLoadedCheckBoxItem)
Declaration
public void Remove(PdfLoadedCheckBoxItem item)
Parameters
Type | Name | Description |
---|---|---|
PdfLoadedCheckBoxItem | item |
RemoveAt(Int32)
Declaration
public void RemoveAt(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index |