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

Public Member Functions

 PdfDestination (int type)
 
 PdfDestination (int type, float parameter)
 
 PdfDestination (int type, float left, float top, float zoom)
 
 PdfDestination (int type, float left, float bottom, float right, float top)
 
bool HasPage ()
 
bool AddPage (PdfIndirectReference page)
 
- Public Member Functions inherited from iTextSharp.text.pdf.PdfArray
 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 ()
 

Static Public Attributes

const int XYZ = 0
 
const int FIT = 1
 
const int FITH = 2
 
const int FITV = 3
 
const int FITR = 4
 
const int FITB = 5
 
const int FITBH = 6
 
const int FITBV = 7
 
- 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"
 

Additional Inherited Members

- Protected Member Functions inherited from iTextSharp.text.pdf.PdfObject
 PdfObject (int type)
 
 PdfObject (int type, string content)
 
 PdfObject (int type, byte[] bytes)
 
- Protected Attributes inherited from iTextSharp.text.pdf.PdfArray
ArrayList arrayList
 
- Protected Attributes inherited from iTextSharp.text.pdf.PdfObject
byte[] bytes
 
int type
 
PRIndirectReference indRef
 
- Properties inherited from iTextSharp.text.pdf.PdfArray
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]
 

Detailed Description

A PdfColor defines a Color (it's a PdfArray containing 3 values).

See also
PdfDictionary

Constructor & Destructor Documentation

◆ PdfDestination() [1/4]

iTextSharp.text.pdf.PdfDestination.PdfDestination ( int  type)

Constructs a new PdfDestination.

If type equals FITB, the bounding box of a page will fit the window of the Reader. Otherwise the type will be set to FIT so that the entire page will fit to the window.

Parameters
typeThe destination type

◆ PdfDestination() [2/4]

iTextSharp.text.pdf.PdfDestination.PdfDestination ( int  type,
float  parameter 
)

Constructs a new PdfDestination.

If type equals FITBH / FITBV, the width / height of the bounding box of a page will fit the window of the Reader. The parameter will specify the y / x coordinate of the top / left edge of the window. If the type equals FITH or FITV the width / height of the entire page will fit the window and the parameter will specify the y / x coordinate of the top / left edge. In all other cases the type will be set to FITH.

Parameters
typethe destination type
parametera parameter to combined with the destination type

◆ PdfDestination() [3/4]

iTextSharp.text.pdf.PdfDestination.PdfDestination ( int  type,
float  left,
float  top,
float  zoom 
)

Constructs a new PdfDestination.

Display the page, with the coordinates (left, top) positioned at the top-left corner of the window and the contents of the page magnified by the factor zoom. A negative value for any of the parameters left or top, or a zoom value of 0 specifies that the current value of that parameter is to be retained unchanged.

Parameters
typemust be a PdfDestination.XYZ
leftthe left value. Negative to place a null
topthe top value. Negative to place a null
zoomThe zoom factor. A value of 0 keeps the current value

◆ PdfDestination() [4/4]

iTextSharp.text.pdf.PdfDestination.PdfDestination ( int  type,
float  left,
float  bottom,
float  right,
float  top 
)

Constructs a new PdfDestination.

Display the page, with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and top entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension.

Parameters
typemust be PdfDestination.FITR
lefta parameter
bottoma parameter
righta parameter
topa parameter
Since
iText0.38

Member Function Documentation

◆ AddPage()

bool iTextSharp.text.pdf.PdfDestination.AddPage ( PdfIndirectReference  page)

Adds the indirect reference of the destination page.

Parameters
pagean indirect reference
Returns
true if the page reference was added

◆ HasPage()

bool iTextSharp.text.pdf.PdfDestination.HasPage ( )

Checks if an indirect reference to a page has been added.

Returns
true or false

Member Data Documentation

◆ FIT

const int iTextSharp.text.pdf.PdfDestination.FIT = 1
static

This is a possible destination type

◆ FITB

const int iTextSharp.text.pdf.PdfDestination.FITB = 5
static

This is a possible destination type

◆ FITBH

const int iTextSharp.text.pdf.PdfDestination.FITBH = 6
static

This is a possible destination type

◆ FITBV

const int iTextSharp.text.pdf.PdfDestination.FITBV = 7
static

This is a possible destination type

◆ FITH

const int iTextSharp.text.pdf.PdfDestination.FITH = 2
static

This is a possible destination type

◆ FITR

const int iTextSharp.text.pdf.PdfDestination.FITR = 4
static

This is a possible destination type

◆ FITV

const int iTextSharp.text.pdf.PdfDestination.FITV = 3
static

This is a possible destination type

◆ XYZ

const int iTextSharp.text.pdf.PdfDestination.XYZ = 0
static

This is a possible destination type


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