Search Results for

    Show / Hide Table of Contents

    Class CheckboxFormField

    Inheritance
    System.Object
    CheckboxFormField
    Implements
    ICheckableFormField
    IFormField
    IFormFieldObject
    IFormFieldAnnotationObject
    IPdfDocumentObject
    IronSoftware.IDocumentObject
    Namespace: IronSoftware.Forms
    Assembly: IronPdf.dll
    Syntax
    public class CheckboxFormField : Object, ICheckableFormField, IFormField, IFormFieldObject, IFormFieldAnnotationObject, IPdfDocumentObject, IDocumentObject

    Constructors

    CheckboxFormField(String, String, UInt32, Double, Double, Double, Double)

    Create a new checkbox form field using the specified parameters

    Declaration
    public CheckboxFormField(string name, string value, uint page_index, double x, double y, double width, double height)
    Parameters
    Type Name Description
    System.String name

    Form name

    System.String value

    Form value

    System.UInt32 page_index

    Form page index

    System.Double x

    Form x-coordinate

    System.Double y

    Form y-coordinate

    System.Double width

    Form width

    System.Double height

    Form height

    Fields

    OffValue

    Value which can be assigned to a checkbox to disable it

    Declaration
    public static string OffValue
    Field Value
    Type Description
    System.String

    Properties

    Annotations

    Form field annotations

    Declaration
    public List<IFormFieldAnnotation> Annotations { get; protected set; }
    Property Value
    Type Description
    System.Collections.Generic.List<IFormFieldAnnotation>

    Choices

    Selection choices

    Declaration
    public List<string> Choices { get; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.String>

    Client

    Pdf client

    Declaration
    public IPdfClient Client { get; set; }
    Property Value
    Type Description
    IronSoftware.Pdfium.IPdfClient

    DefaultAppearance

    Default appearance string

    Declaration
    public string DefaultAppearance { get; set; }
    Property Value
    Type Description
    System.String

    DocumentId

    Declaration
    public IDocumentId DocumentId { get; set; }
    Property Value
    Type Description
    IronSoftware.IDocumentId

    FormFlags

    Form field flags

    Declaration
    public PdfFormFieldFlags FormFlags { get; set; }
    Property Value
    Type Description
    PdfFormFieldFlags

    FormType

    Form type

    Declaration
    public string FormType { get; }
    Property Value
    Type Description
    System.String

    FullName

    Fully qualified name

    Declaration
    public string FullName { get; protected set; }
    Property Value
    Type Description
    System.String

    Height

    Annotation height

    Declaration
    public double Height { get; set; }
    Property Value
    Type Description
    System.Double

    MaxLength

    Maximum number of characters which can be specified in the value

    Declaration
    public int MaxLength { get; set; }
    Property Value
    Type Description
    System.Int32

    Name

    Partial name

    Declaration
    public string Name { get; set; }
    Property Value
    Type Description
    System.String

    ObjNum

    Declaration
    public uint ObjNum { get; set; }
    Property Value
    Type Description
    System.UInt32

    ObjType

    Object type

    Declaration
    public string ObjType { get; }
    Property Value
    Type Description
    System.String

    PageIndex

    Declaration
    public uint PageIndex { get; set; }
    Property Value
    Type Description
    System.UInt32

    ReadOnly

    True if read-only

    Declaration
    public bool ReadOnly { get; set; }
    Property Value
    Type Description
    System.Boolean

    RichText

    Form value using rich text

    Declaration
    public string RichText { get; set; }
    Property Value
    Type Description
    System.String

    SelectedIndex

    Currently selected index

    Declaration
    public int SelectedIndex { get; set; }
    Property Value
    Type Description
    System.Int32

    Type

    Pdf form field type

    Declaration
    public PdfFormFieldType Type { get; }
    Property Value
    Type Description
    PdfFormFieldType

    Value

    Form value

    Declaration
    public string Value { get; set; }
    Property Value
    Type Description
    System.String

    Width

    Annotation width

    Declaration
    public double Width { get; set; }
    Property Value
    Type Description
    System.Double

    X

    Annotation X position

    Declaration
    public double X { get; set; }
    Property Value
    Type Description
    System.Double

    Y

    Annotation y position

    Declaration
    public double Y { get; set; }
    Property Value
    Type Description
    System.Double

    Methods

    Clear()

    Clear any and all selected values

    Declaration
    public void Clear()

    Select(Int32)

    Select the value at the specified index

    If no index is provided, selects the first value. If there are more than one options, throws an exception

    Declaration
    public string Select(int Index = -1)
    Parameters
    Type Name Description
    System.Int32 Index
    Returns
    Type Description
    System.String

    Value at the selected index

    Exceptions
    Type Condition
    System.Exception

    No index was provided and there is more than one selectable option

    SetDefaultFont(String, Int32, Color)

    Set the default font to be used by this form field and any associated annotations

    Declaration
    public void SetDefaultFont(string FontName, int FontSize, Color FontColor)
    Parameters
    Type Name Description
    System.String FontName

    Font name with weight. Example "AdobeThai-Bold"

    System.Int32 FontSize

    Font size (whole integer such as 12 or 24)

    System.Drawing.Color FontColor

    Font color (only R, G, and B are used)

    Remarks

    This option may be overwritten by fonts applied to specific form field annotations

    Implements

    ICheckableFormField
    IFormField
    IFormFieldObject
    IFormFieldAnnotationObject
    IPdfDocumentObject
    IronSoftware.IDocumentObject
    ☀
    ☾
    Downloads
    • Download with Nuget
    • Start for Free
    In This Article
    Back to top
    Install with Nuget
    Want to deploy IronPDF to a live project for FREE?
    What’s included?
    30 days of fully-functional product
    Test and share in a live environment
    No watermarks in production
    Get your free 30-day Trial Key instantly.
    No credit card or account creation required
    Your Trial License Key has been emailed to you.
    Download IronPDF free to apply
    your Trial Licenses Key
    Install with NuGet View Licenses
    Licenses from $499. Have a question? Get in touch.