File Formats

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PdfLoadedCheckBoxField

    Show / Hide Table of Contents

    Class PdfLoadedCheckBoxField

    Represents check box of an existing PDF document.

    Inheritance
    System.Object
    PdfField
    PdfLoadedField
    PdfLoadedStyledField
    PdfLoadedStateField
    PdfLoadedCheckBoxField
    Implements
    System.ComponentModel.INotifyPropertyChanged
    Inherited Members
    PdfLoadedStateField.SetCheckedStatus(Boolean)
    PdfLoadedStateField.Remove(PdfLoadedStateItem)
    PdfLoadedStyledField.GetGraphicsProperties(PdfLoadedStyledField.GraphicsProperties, PdfLoadedFieldItem)
    PdfLoadedStyledField.DefineDefaultAppearance()
    PdfLoadedStyledField.StyleToString(PdfCheckBoxStyle)
    PdfLoadedStyledField.MouseEnter
    PdfLoadedStyledField.MouseUp
    PdfLoadedStyledField.MouseDown
    PdfLoadedStyledField.MouseLeave
    PdfLoadedStyledField.GotFocus
    PdfLoadedStyledField.LostFocus
    PdfLoadedStyledField.Bounds
    PdfLoadedStyledField.Location
    PdfLoadedStyledField.Size
    PdfLoadedStyledField.BorderStyle
    PdfLoadedStyledField.BorderColor
    PdfLoadedStyledField.BorderWidth
    PdfLoadedStyledField.Font
    PdfLoadedStyledField.DefaultIndex
    PdfLoadedStyledField.Visible
    PdfLoadedStyledField.Visibility
    PdfLoadedStyledField.RotationAngle
    PdfLoadedField.ObjectID
    PdfLoadedField.SetName(String)
    PdfLoadedField.Name
    PdfLoadedField.MappingName
    PdfLoadedField.ToolTip
    PdfLoadedField.Page
    PdfLoadedField.ReadOnly
    PdfLoadedField.Required
    PdfLoadedField.Export
    PdfLoadedField.Form
    PdfField.Initialize()
    PdfField.Flatten
    PdfField.DisableAutoFormat
    PdfField.PdfTag
    PdfField.TabIndex
    PdfField.Layer
    PdfField.PropertyChanged
    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, INotifyPropertyChanged
    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
    PdfLoadedCheckBoxField
    PdfLoadedDocument

    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
    PdfLoadedStateField
    PdfLoadedCheckBoxField

    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

    TryGetFieldItem(String, out PdfLoadedCheckBoxItem)

    Get the PdfLoadedCheckBoxItem using export value from PdfLoadedCheckBoxField

    Declaration
    public bool TryGetFieldItem(string exportValue, out PdfLoadedCheckBoxItem field)
    Parameters
    Type Name Description
    System.String exportValue
    PdfLoadedCheckBoxItem field
    Returns
    Type Description
    System.Boolean
    Examples
    //Load an existing document
    PdfLoadedDocument doc = new PdfLoadedDocument("SourceForm.pdf");
    //Load an existing Check field
    PdfLoadedCheckBoxField checkField = doc.Form.Fields["Java"] as PdfLoadedCheckBoxField;
    PdfLoadedCheckBoxItem checkBoxItem = null;
    //Get checkbox item using an export value
    checkField.TryGetFieldItem("3", out checkBoxItem);
    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)
    'Get checkbox item using an export value  
    Dim checkBoxItem As PdfLoadedCheckBoxItem = Nothing
    checkField.TryGetFieldItem("3", checkBoxItem)
    doc.Save("Form.pdf")
    doc.Close(True)       

    Implements

    System.ComponentModel.INotifyPropertyChanged

    See Also

    PdfLoadedStateField
    PdfLoadedDocument
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved