GemBox.Pdf
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    PdfCheckBoxField Class

    Namespace:
    GemBox.Pdf.Forms
    Assembly:
    GemBox.Pdf.dll

    Represents a check box that toggles between two states, on and off (see 12.7.4.2.3, "Check Boxes").

    • C#
    • VB.NET
    public sealed class PdfCheckBoxField : PdfToggleButtonField
    Public NotInheritable Class PdfCheckBoxField
        Inherits PdfToggleButtonField
    Inheritance:
    System.Object
    PdfObject
    PdfAnnotation
    PdfField
    PdfToggleButtonField
    PdfCheckBoxField

    Properties

    ExportValue

    Gets or sets the export value.

    • C#
    • VB.NET
    public string ExportValue { get; set; }
    Public Property ExportValue As String
    Property Value
    System.String

    The export value.

    Exceptions
    System.ArgumentException

    Value is null or System.String.Empty.

    See Also
    PDF Specification ISO 32000-1:2008, section '12.7.4.2.3 Check Boxes'

    FieldType

    Gets the CheckBox value.

    • C#
    • VB.NET
    public override PdfFieldType FieldType { get; }
    Public Overrides ReadOnly Property FieldType As PdfFieldType
    Property Value
    PdfFieldType

    The CheckBox value.

    Overrides
    PdfField.FieldType

    Inherited Properties

    Actions

    (Optional; PDF 1.1) An action that shall be performed when the field's annotation is activated (see 12.6, "Actions").

    (Inherited from PdfField)

    AnnotationType

    Gets the Widget value.

    (Inherited from PdfField)

    Appearance

    Gets the appearance settings for this PdfToggleButtonField.

    (Inherited from PdfToggleButtonField)

    AssociatedFiles

    (Optional; PDF 2.0) An array of one or more PdfFileSpecifications which denote the associated files for this PdfAnnotation.

    (Inherited from PdfAnnotation)

    Bounds

    (Required) The annotation bounds, defining the location and the size of the annotation on the page in default user space units.

    (Inherited from PdfAnnotation)

    Checked

    Gets or sets a value indicating whether this PdfToggleButtonField is checked.

    (Inherited from PdfToggleButtonField)

    DefaultValue

    (Optional; inheritable) The default value to which the field reverts when a reset-form action is executed. The format of this value is the same as that of Value.

    (Inherited from PdfField)

    Hidden

    (PDF 1.2) If set, do not display the annotation on the screen or allow it to interact with the user.

    The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction.

    (Inherited from PdfField)

    Locked

    (PDF 1.4) If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation's contents, such as the value of a form field.

    (Inherited from PdfAnnotation)

    Metadata

    (Optional; PDF 1.4) A metadata stream containing metadata for the component.

    (Inherited from PdfObject)

    Name

    Gets the (fully qualified) field name.

    (Inherited from PdfField)

    Page

    Gets the page with which this annotation is associated.

    (Inherited from PdfAnnotation)

    Print

    (PDF 1.2) If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen.

    note

    This can be useful for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page.

    (Inherited from PdfField)

    ReadOnly

    If set, the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database.

    (Inherited from PdfField)

    Required

    If set, the field shall have a value at the time it is exported by a submit-form action (see 12.7.5.2, "Submit-Form Action").

    (Inherited from PdfToggleButtonField)

    Tooltip

    (Optional; PDF 1.3) An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface (such as in error or status messages referring to the field). This text is also useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes (see 14.9.3, "Alternate Descriptions").

    (Inherited from PdfField)

    Value

    Gets or sets the PdfToggleButtonField value as an instance of the System.String type.

    (Inherited from PdfToggleButtonField)

    Inherited Methods

    SetBounds(System.Double, System.Double)

    Sets the size of the Bounds.

    (Inherited from PdfAnnotation)

    SetBounds(System.Double, System.Double, System.Double, System.Double)

    Sets the Bounds.

    (Inherited from PdfAnnotation)

    ToString()

    Returns a System.String that represents this PdfField instance.

    (Inherited from PdfField)

    Extension Methods

    PdfObjectExtensions.GetDictionary(PdfObject)
    PdfObjectExtensions.GetOrAddDictionary(PdfObject)
    PdfObjectExtensions.GetArray(PdfObject)

    Examples

    Fill in Form example
    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.