Class PdfCollectionField

Namespace

iText.Kernel.Pdf.Collection

Assembly

itext.kernel.dll

public class PdfCollectionField : PdfObjectWrapper<PdfDictionary>

Inheritance

object

PdfObjectWrapper<PdfDictionary>

PdfCollectionField

Inherited Members

PdfObjectWrapper<PdfDictionary>.GetPdfObject()

PdfObjectWrapper<PdfDictionary>.MakeIndirect(PdfDocument, PdfIndirectReference)

PdfObjectWrapper<PdfDictionary>.MakeIndirect(PdfDocument)

PdfObjectWrapper<PdfDictionary>.SetModified()

PdfObjectWrapper<PdfDictionary>.Flush()

PdfObjectWrapper<PdfDictionary>.IsFlushed()

PdfObjectWrapper<PdfDictionary>.SetPdfObject(PdfDictionary)

PdfObjectWrapper<PdfDictionary>.SetForbidRelease()

PdfObjectWrapper<PdfDictionary>.UnsetForbidRelease()

PdfObjectWrapper<PdfDictionary>.EnsureUnderlyingObjectHasIndirectReference()

PdfObjectWrapper<PdfDictionary>.MarkObjectAsIndirect(PdfObject)

PdfObjectWrapper<PdfDictionary>.EnsureObjectIsAddedToDocument(PdfObject)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PdfCollectionField(string, int)

Creates a PdfCollectionField.

public PdfCollectionField(string name, int subType)

Parameters

name string

the field name

subType int

the field subtype

PdfCollectionField(PdfDictionary)

protected PdfCollectionField(PdfDictionary pdfObject)

Parameters

pdfObject PdfDictionary

Fields

CREATIONDATE

A possible type of collection field.

public const int CREATIONDATE = 6

Field Value

int

DATE

A possible type of collection field.

public const int DATE = 1

Field Value

int

DESC

A possible type of collection field.

public const int DESC = 4

Field Value

int

FILENAME

A possible type of collection field.

public const int FILENAME = 3

Field Value

int

MODDATE

A possible type of collection field.

public const int MODDATE = 5

Field Value

int

NUMBER

A possible type of collection field.

public const int NUMBER = 2

Field Value

int

SIZE

A possible type of collection field.

public const int SIZE = 7

Field Value

int

TEXT

A possible type of collection field.

public const int TEXT = 0

Field Value

int

subType

protected int subType

Field Value

int

Methods

GetEditable()

Retrieves the state of the editable of the field.

public virtual PdfBoolean GetEditable()

Returns

PdfBoolean

true if filed is editable and false otherwise. Returned value is presented as pdf boolean.

GetOrder()

Retrieves the order of the field name.

public virtual PdfNumber GetOrder()

Returns

PdfNumber

the PDF number showing the order of the field name

GetValue(string)

Converts string to appropriate pdf value.

public virtual PdfObject GetValue(string value)

Parameters

value string

is a plain string representation of the value

Returns

PdfObject

resulting PDF object

GetVisibility()

Retrieves the initial visibility of the field.

public virtual PdfBoolean GetVisibility()

Returns

PdfBoolean

the initial visibility of the field as PDF boolean value

IsWrappedObjectMustBeIndirect()

protected override bool IsWrappedObjectMustBeIndirect()

Returns

bool

SetEditable(bool)

Indication if the field value should be editable in the viewer.

public virtual PdfCollectionField SetEditable(bool editable)

Parameters

editable bool

is a state of editable

Returns

PdfCollectionField

this instance to support fluent interface

SetOrder(int)

The relative order of the field name.

public virtual PdfCollectionField SetOrder(int order)

Parameters

order int

a number indicating the order of the field

Returns

PdfCollectionField

this instance to support fluent interface

Remarks

The relative order of the field name. Fields are sorted in ascending order.

SetVisibility(bool)

Sets the initial visibility of the field.

public virtual PdfCollectionField SetVisibility(bool visible)

Parameters

visible bool

is a state of visibility

Returns

PdfCollectionField

this instance to support fluent interface