Class AcroCheckboxField

Namespace

UglyToad.PdfPig.AcroForms.Fields

Assembly

UglyToad.PdfPig.dll

A checkbox which may be toggled on or off.

public class AcroCheckboxField : AcroFieldBase

Inheritance

object

AcroFieldBase

AcroCheckboxField

Inherited Members

AcroFieldBase.ToString()

AcroFieldBase.Dictionary

AcroFieldBase.RawFieldType

AcroFieldBase.FieldType

AcroFieldBase.FieldFlags

AcroFieldBase.Information

AcroFieldBase.PageNumber

AcroFieldBase.Bounds

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

AcroFormExtensions.GetFields(AcroFieldBase)

AcroFormExtensions.GetFieldValue(AcroFieldBase)

Constructors

AcroCheckboxField(DictionaryToken, string, AcroButtonFieldFlags, AcroFieldCommonInformation, NameToken, bool, int?, PdfRectangle?)

Create a new AcroCheckboxField.

public AcroCheckboxField(DictionaryToken dictionary, string fieldType, AcroButtonFieldFlags fieldFlags, AcroFieldCommonInformation information, NameToken currentValue, bool isChecked, int? pageNumber, PdfRectangle? bounds)

Parameters

dictionary DictionaryToken

fieldType string

fieldFlags AcroButtonFieldFlags

information AcroFieldCommonInformation

currentValue NameToken

isChecked bool

pageNumber int?

bounds PdfRectangle?

Properties

CurrentValue

The current value of this checkbox.

public NameToken CurrentValue { get; }

Property Value

NameToken

Flags

The AcroButtonFieldFlags which define the behaviour of this button type.

public AcroButtonFieldFlags Flags { get; }

Property Value

AcroButtonFieldFlags

IsChecked

Whether this checkbox is currently checked/on.

public bool IsChecked { get; }

Property Value

bool