HiraokaHyperTools.iTextSharp-LGPL  0.2.5
iTextSharp.text.pdf.PdfArray Class Reference
Inheritance diagram for iTextSharp.text.pdf.PdfArray:
iTextSharp.text.pdf.PdfObject iTextSharp.text.pdf.PdfBorderArray iTextSharp.text.pdf.PdfDashPattern iTextSharp.text.pdf.PdfDestination iTextSharp.text.pdf.PdfRectangle

Public Member Functions

 PdfArray ()
 
 PdfArray (PdfObject obj)
 
 PdfArray (float[] values)
 
 PdfArray (int[] values)
 
 PdfArray (ArrayList l)
 
 PdfArray (PdfArray array)
 
override void ToPdf (PdfWriter writer, Stream os)
 
PdfObject Remove (int idx)
 
bool IsEmpty ()
 
virtual bool Add (PdfObject obj)
 
virtual bool Add (float[] values)
 
virtual bool Add (int[] values)
 
virtual void Add (int index, PdfObject element)
 
virtual void AddFirst (PdfObject obj)
 
bool Contains (PdfObject obj)
 
ListIterator GetListIterator ()
 
override string ToString ()
 
PdfObject GetDirectObject (int idx)
 
PdfDictionary GetAsDict (int idx)
 
PdfArray GetAsArray (int idx)
 
PdfStream GetAsStream (int idx)
 
PdfString GetAsString (int idx)
 
PdfNumber GetAsNumber (int idx)
 
PdfName GetAsName (int idx)
 
PdfBoolean GetAsBoolean (int idx)
 
PdfIndirectReference GetAsIndirectObject (int idx)
 
IEnumerator GetEnumerator ()
 
- Public Member Functions inherited from iTextSharp.text.pdf.PdfObject
virtual byte[] GetBytes ()
 
bool CanBeInObjStm ()
 
override string ToString ()
 
bool IsNull ()
 
bool IsBoolean ()
 
bool IsNumber ()
 
bool IsString ()
 
bool IsName ()
 
bool IsArray ()
 
bool IsDictionary ()
 
bool IsStream ()
 
bool IsIndirect ()
 

Protected Attributes

ArrayList arrayList
 
- Protected Attributes inherited from iTextSharp.text.pdf.PdfObject
byte[] bytes
 
int type
 
PRIndirectReference indRef
 

Properties

PdfObject this[int idx] [get, set]
 
ArrayList ArrayList [get]
 
int Size [get]
 
- Properties inherited from iTextSharp.text.pdf.PdfObject
int Length [get]
 
string Content [set]
 
int Type [get]
 
PRIndirectReference IndRef [get, set]
 

Additional Inherited Members

- Static Public Attributes inherited from iTextSharp.text.pdf.PdfObject
const int BOOLEAN = 1
 
const int NUMBER = 2
 
const int STRING = 3
 
const int NAME = 4
 
const int ARRAY = 5
 
const int DICTIONARY = 6
 
const int STREAM = 7
 
const int NULL = 8
 
const int INDIRECT = 10
 
const string NOTHING = ""
 
const string TEXT_PDFDOCENCODING = "PDF"
 
const string TEXT_UNICODE = "UnicodeBig"
 
- Protected Member Functions inherited from iTextSharp.text.pdf.PdfObject
 PdfObject (int type)
 
 PdfObject (int type, string content)
 
 PdfObject (int type, byte[] bytes)
 

Detailed Description

PdfArray is the PDF Array object.

An array is a sequence of PDF objects. An array may contain a mixture of object types. An array is written as a left square bracket ([), followed by a sequence of objects, followed by a right square bracket (]).
This object is described in the 'Portable Document Format Reference Manual version 1.3' section 4.6 (page 40).

See also
PdfObject

Constructor & Destructor Documentation

◆ PdfArray() [1/6]

iTextSharp.text.pdf.PdfArray.PdfArray ( )

Constructs an empty PdfArray-object.

◆ PdfArray() [2/6]

iTextSharp.text.pdf.PdfArray.PdfArray ( PdfObject  obj)

Constructs an PdfArray-object, containing 1 PdfObject.

Parameters
objecta PdfObject that has to be added to the array

◆ PdfArray() [3/6]

iTextSharp.text.pdf.PdfArray.PdfArray ( float[]  values)

◆ PdfArray() [4/6]

iTextSharp.text.pdf.PdfArray.PdfArray ( int[]  values)

◆ PdfArray() [5/6]

iTextSharp.text.pdf.PdfArray.PdfArray ( ArrayList  l)

Constructs a PdfArray with the elements of an ArrayList. Throws a ClassCastException if the ArrayList contains something that isn't a PdfObject.

Parameters
lan ArrayList with PdfObjects
Since
2.1.3

◆ PdfArray() [6/6]

iTextSharp.text.pdf.PdfArray.PdfArray ( PdfArray  array)

Constructs an PdfArray-object, containing all the PdfObjects in a given PdfArray.

Parameters
arraya PdfArray that has to be added to the array

Member Function Documentation

◆ Add() [1/4]

virtual bool iTextSharp.text.pdf.PdfArray.Add ( float[]  values)
virtual

◆ Add() [2/4]

virtual void iTextSharp.text.pdf.PdfArray.Add ( int  index,
PdfObject  element 
)
virtual

Inserts the specified element at the specified position.

Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters
indexThe index at which the specified element is to be inserted
elementThe element to be inserted
Exceptions
IndexOutOfBoundsExceptionif the specified index is larger than the last position currently set, plus 1.
Since
2.1.5

◆ Add() [3/4]

virtual bool iTextSharp.text.pdf.PdfArray.Add ( int[]  values)
virtual

◆ Add() [4/4]

virtual bool iTextSharp.text.pdf.PdfArray.Add ( PdfObject  obj)
virtual

Adds a PdfObject to the PdfArray.

Parameters
objectPdfObject to add
Returns
true

Reimplemented in iTextSharp.text.pdf.PdfRectangle.

◆ AddFirst()

virtual void iTextSharp.text.pdf.PdfArray.AddFirst ( PdfObject  obj)
virtual

Inserts a PdfObject at the beginning of the PdfArray.

The PdfObject will be the first element, any other elements will be shifted to the right (adds one to their indices).

Parameters
objectThe PdfObject to add

Reimplemented in iTextSharp.text.pdf.PdfRectangle.

◆ Contains()

bool iTextSharp.text.pdf.PdfArray.Contains ( PdfObject  obj)

Checks if the PdfArray allready contains a certain PdfObject.

Parameters
objectPdfObject to check
Returns
true

◆ GetAsArray()

PdfArray iTextSharp.text.pdf.PdfArray.GetAsArray ( int  idx)

◆ GetAsBoolean()

PdfBoolean iTextSharp.text.pdf.PdfArray.GetAsBoolean ( int  idx)

◆ GetAsDict()

PdfDictionary iTextSharp.text.pdf.PdfArray.GetAsDict ( int  idx)

◆ GetAsIndirectObject()

PdfIndirectReference iTextSharp.text.pdf.PdfArray.GetAsIndirectObject ( int  idx)

◆ GetAsName()

PdfName iTextSharp.text.pdf.PdfArray.GetAsName ( int  idx)

◆ GetAsNumber()

PdfNumber iTextSharp.text.pdf.PdfArray.GetAsNumber ( int  idx)

◆ GetAsStream()

PdfStream iTextSharp.text.pdf.PdfArray.GetAsStream ( int  idx)

◆ GetAsString()

PdfString iTextSharp.text.pdf.PdfArray.GetAsString ( int  idx)

◆ GetDirectObject()

PdfObject iTextSharp.text.pdf.PdfArray.GetDirectObject ( int  idx)

◆ GetEnumerator()

IEnumerator iTextSharp.text.pdf.PdfArray.GetEnumerator ( )

◆ GetListIterator()

ListIterator iTextSharp.text.pdf.PdfArray.GetListIterator ( )

◆ IsEmpty()

bool iTextSharp.text.pdf.PdfArray.IsEmpty ( )

Returns true if the array is empty.

Returns
true if the array is empty
Since
2.1.5

◆ Remove()

PdfObject iTextSharp.text.pdf.PdfArray.Remove ( int  idx)

Remove the element at the specified position from the array.

Shifts any subsequent elements to the left (subtracts one from their indices).

Parameters
idxThe index of the element to be removed.
Exceptions
IndexOutOfBoundsExceptionthe specified position doesn't exist
Since
2.1.5

◆ ToPdf()

override void iTextSharp.text.pdf.PdfArray.ToPdf ( PdfWriter  writer,
Stream  os 
)
virtual

Returns the PDF representation of this PdfArray.

Returns
an array of bytes

Reimplemented from iTextSharp.text.pdf.PdfObject.

Reimplemented in iTextSharp.text.pdf.PdfDashPattern.

◆ ToString()

override string iTextSharp.text.pdf.PdfArray.ToString ( )

Member Data Documentation

◆ arrayList

ArrayList iTextSharp.text.pdf.PdfArray.arrayList
protected

this is the actual array of PdfObjects

Property Documentation

◆ ArrayList

ArrayList iTextSharp.text.pdf.PdfArray.ArrayList
get

Returns an ArrayList containing PdfObjects.

Returns
an ArrayList

◆ Size

int iTextSharp.text.pdf.PdfArray.Size
get

Returns the number of entries in the array.

Returns
the size of the ArrayList

◆ this[int idx]

PdfObject iTextSharp.text.pdf.PdfArray.this[int idx]
getset

Overwrites a specified location of the array.

Parameters
idxThe index of the element to be overwritten
objnew value for the specified index
Exceptions
IndexOutOfBoundsExceptionif the specified position doesn't exist
Returns
the previous value
Since
2.1.5

The documentation for this class was generated from the following file: