iText.Forms.Xfdf.DestObject Class Reference

Represents Dest element, a child of the link, GoTo, and GoToR elements. More...

Public Member Functions
virtual String	GetName ()
	Gets the Name attribute of Named element, a child of Dest element. More...
virtual iText.Forms.Xfdf.DestObject	SetName (String name)
	Sets the Name attribute of Named element, a child of Dest element. More...
virtual FitObject	GetXyz ()
	Gets the XYZ element, a child of the Dest element. More...
virtual iText.Forms.Xfdf.DestObject	SetXyz (FitObject xyz)
	Sets the XYZ element, a child of the Dest element. More...
virtual FitObject	GetFit ()
	Gets the Fit element, a child of the Dest element. More...
virtual iText.Forms.Xfdf.DestObject	SetFit (FitObject fit)
	Sets the Fit element, a child of the Dest element. More...
virtual FitObject	GetFitH ()
	Gets the FitH element, a child of the Dest element. More...
virtual iText.Forms.Xfdf.DestObject	SetFitH (FitObject fitH)
	Sets the FitH element, a child of the Dest element. More...
virtual FitObject	GetFitV ()
	Gets the FitV element, a child of the Dest element. More...
virtual iText.Forms.Xfdf.DestObject	SetFitV (FitObject fitV)
	Sets the FitV element, a child of the Dest element. More...
virtual FitObject	GetFitR ()
	Gets the FitR element, a child of the Dest element. More...
virtual iText.Forms.Xfdf.DestObject	SetFitR (FitObject fitR)
	Sets the FitR element, a child of the Dest element. More...
virtual FitObject	GetFitB ()
	Sets the FitB element, a child of the Dest element. More...
virtual iText.Forms.Xfdf.DestObject	SetFitB (FitObject fitB)
	Gets the FitB element, a child of the Dest element. More...
virtual FitObject	GetFitBH ()
	Sets the FitBH element, a child of the Dest element. More...
virtual iText.Forms.Xfdf.DestObject	SetFitBH (FitObject fitBH)
	Gets the FitBH element, a child of the Dest element. More...
virtual FitObject	GetFitBV ()
	Sets the FitBV element, a child of the Dest element. More...
virtual iText.Forms.Xfdf.DestObject	SetFitBV (FitObject fitBV)
	Sets the FitBV element, a child of the Dest element. More...

Detailed Description

Represents Dest element, a child of the link, GoTo, and GoToR elements.

Represents Dest element, a child of the link, GoTo, and GoToR elements. Corresponds to the Dest key in the link annotations dictionary. For more details see paragraph 6.5.10 in XFDF document specification. Content model: ( Named | XYZ | Fit | FitH | FitV | FitR | FitB | FitBH | FitBV )

Member Function Documentation

GetFit()

virtual FitObject iText.Forms.Xfdf.DestObject.GetFit ( )

inlinevirtual

Gets the Fit element, a child of the Dest element.

Gets the Fit element, a child of the Dest element. Corresponds to the Fit key in the destination syntax. Required attributes: Page. For more details see paragraph 6.5.13 in XFDF document specification.

Returns

a FitObject that represents Fit of Dest element.

GetFitB()

virtual FitObject iText.Forms.Xfdf.DestObject.GetFitB ( )

inlinevirtual

Sets the FitB element, a child of the Dest element.

Sets the FitB element, a child of the Dest element. Corresponds to the FitB key in the destination syntax. Required attributes: Page. For more details see paragraph 6.5.14 in XFDF document specification.

Returns

a FitObject that represents FitB of Dest element.

GetFitBH()

virtual FitObject iText.Forms.Xfdf.DestObject.GetFitBH ( )

inlinevirtual

Sets the FitBH element, a child of the Dest element.

Sets the FitBH element, a child of the Dest element. Corresponds to the FitBH key in the destination syntax. Required attributes: Page, Top. For more details see paragraph 6.5.15 in XFDF document specification.

Returns

a FitObject that represents FitBH of Dest element.

GetFitBV()

virtual FitObject iText.Forms.Xfdf.DestObject.GetFitBV ( )

inlinevirtual

Sets the FitBV element, a child of the Dest element.

Sets the FitBV element, a child of the Dest element. Corresponds to the FitBV key in the destination syntax. Required attributes: Page, Left. For more details see paragraph 6.5.16 in XFDF document specification.

Returns

a FitObject that represents FitBV of Dest element.

GetFitH()

virtual FitObject iText.Forms.Xfdf.DestObject.GetFitH ( )

inlinevirtual

Gets the FitH element, a child of the Dest element.

Gets the FitH element, a child of the Dest element. Corresponds to the FitH key in the destination syntax. Required attributes: Page, Top. For more details see paragraph 6.5.17 in XFDF document specification.

Returns

a FitObject that represents FitH of Dest element.

GetFitR()

virtual FitObject iText.Forms.Xfdf.DestObject.GetFitR ( )

inlinevirtual

Gets the FitR element, a child of the Dest element.

Gets the FitR element, a child of the Dest element. Corresponds to the FitR key in the destination syntax. Required attributes: Page, Left, Bottom, Right, Top. For more details see paragraph 6.5.18 in XFDF document specification.

Returns

a FitObject that represents FitR of Dest element.

GetFitV()

virtual FitObject iText.Forms.Xfdf.DestObject.GetFitV ( )

inlinevirtual

Gets the FitV element, a child of the Dest element.

Gets the FitV element, a child of the Dest element. Corresponds to the FitV key in the destination syntax. Required attributes: Page, Left. For more details see paragraph 6.5.19 in XFDF document specification.

Returns

a FitObject that represents FitV of Dest element.

GetName()

virtual String iText.Forms.Xfdf.DestObject.GetName ( )

inlinevirtual

Gets the Name attribute of Named element, a child of Dest element.

Gets the Name attribute of Named element, a child of Dest element. Allows a destination to be referred to indirectly by means of a name object or a byte string. For more details see paragraph 6.5.25 in XFDF document specification.

Returns

string value of the Name attribute.

GetXyz()

virtual FitObject iText.Forms.Xfdf.DestObject.GetXyz ( )

inlinevirtual

Gets the XYZ element, a child of the Dest element.

Gets the XYZ element, a child of the Dest element. Corresponds to the XYZ key in the destination syntax. Required attributes: Page, Left, Bottom, Right, Top. For more details see paragraph 6.5.32 in XFDF document specification.

Returns

a FitObject that represents XYZ of Dest element.

SetFit()

virtual iText.Forms.Xfdf.DestObject iText.Forms.Xfdf.DestObject.SetFit ( FitObject  fit )

inlinevirtual

Sets the Fit element, a child of the Dest element.

Sets the Fit element, a child of the Dest element. Corresponds to the Fit key in the destination syntax. Required attributes: Page.

Parameters

fit	a FitObject that represents Fit of Dest element.

Returns

this DestObject instance.

SetFitB()

virtual iText.Forms.Xfdf.DestObject iText.Forms.Xfdf.DestObject.SetFitB ( FitObject  fitB )

inlinevirtual

Gets the FitB element, a child of the Dest element.

Gets the FitB element, a child of the Dest element. Corresponds to the FitB key in the destination syntax. Required attributes: Page. For more details see paragraph 6.5.14 in XFDF document specification.

Parameters

fitB	a FitObject that represents FitB of Dest element.

Returns

this DestObject instance.

SetFitBH()

virtual iText.Forms.Xfdf.DestObject iText.Forms.Xfdf.DestObject.SetFitBH ( FitObject  fitBH )

inlinevirtual

Gets the FitBH element, a child of the Dest element.

Gets the FitBH element, a child of the Dest element. Corresponds to the FitBH key in the destination syntax. Required attributes: Page, Top.

Parameters

fitBH

a FitObject that represents FitBH of Dest element.

Returns

this DestObject instance.

SetFitBV()

virtual iText.Forms.Xfdf.DestObject iText.Forms.Xfdf.DestObject.SetFitBV ( FitObject  fitBV )

inlinevirtual

Sets the FitBV element, a child of the Dest element.

Sets the FitBV element, a child of the Dest element. Corresponds to the FitBV key in the destination syntax. Required attributes: Page, Left.

Parameters

fitBV

a FitObject that represents FitBV of Dest element.

Returns

this DestObject instance.

SetFitH()

virtual iText.Forms.Xfdf.DestObject iText.Forms.Xfdf.DestObject.SetFitH ( FitObject  fitH )

inlinevirtual

Sets the FitH element, a child of the Dest element.

Sets the FitH element, a child of the Dest element. Corresponds to the FitH key in the destination syntax. Required attributes: Page, Top.

Parameters

fitH	a FitObject that represents FitH of Dest element.

Returns

this DestObject instance.

SetFitR()

virtual iText.Forms.Xfdf.DestObject iText.Forms.Xfdf.DestObject.SetFitR ( FitObject  fitR )

inlinevirtual

Sets the FitR element, a child of the Dest element.

Sets the FitR element, a child of the Dest element. Corresponds to the FitR key in the destination syntax. Required attributes: Page, Left, Bottom, Right, Top.

Parameters

fitR	a FitObject that represents FitR of Dest element.

Returns

this DestObject instance.

SetFitV()

virtual iText.Forms.Xfdf.DestObject iText.Forms.Xfdf.DestObject.SetFitV ( FitObject  fitV )

inlinevirtual

Sets the FitV element, a child of the Dest element.

Sets the FitV element, a child of the Dest element. Corresponds to the FitV key in the destination syntax. Required attributes: Page, Left.

Parameters

fitV	a FitObject that represents FitV of Dest element.

Returns

this DestObject instance.

SetName()

virtual iText.Forms.Xfdf.DestObject iText.Forms.Xfdf.DestObject.SetName ( String  name )

inlinevirtual

Sets the Name attribute of Named element, a child of Dest element.

Sets the Name attribute of Named element, a child of Dest element. Allows a destination to be referred to indirectly by means of a name object or a byte string.

Parameters

name	string value of the Name attribute.

Returns

this DestObject instance.

SetXyz()

virtual iText.Forms.Xfdf.DestObject iText.Forms.Xfdf.DestObject.SetXyz ( FitObject  xyz )

inlinevirtual

Sets the XYZ element, a child of the Dest element.

Sets the XYZ element, a child of the Dest element. Corresponds to the XYZ key in the destination syntax. Required attributes: Page, Left, Bottom, Right, Top.

Parameters

xyz	a FitObject that represents XYZ of Dest element.

Returns

this DestObject instance.