XPdfForm Class

Terminal Works - PDF Printing.Net Library

Represents a so called 'PDF form external object', which is typically an imported page of an external PDF document. XPdfForm objects are used like images to draw an existing PDF page of an external document in the current document. XPdfForm objects can only be placed in PDF documents. If you try to draw them using a XGraphics based on an GDI+ context no action is taken if no placeholder image is specified. Otherwise the place holder is drawn.

Inheritance Hierarchy

SystemObject
  PdfEdit.DrawingXImage
    PdfEdit.DrawingXForm
      PdfEdit.DrawingXPdfForm

Namespace: PdfEdit.Drawing
Assembly: PdfPrintingNet (in PdfPrintingNet.dll) Version: 5.1.1.0 (5.1.1.0)

Syntax

C++

Copy

public class XPdfForm : XForm

Public Class XPdfForm
	Inherits XForm

public ref class XPdfForm : public XForm

The XPdfForm type exposes the following members.

Methods

	Name	Description
	Dispose	Under construction (Inherited from XImage.)
	Dispose(Boolean)	Frees the memory occupied by the underlying imported PDF document, even if other XPdfForm objects refer to this document. A reuse of this object doesn't fail, because the underlying PDF document is re-imported if necessary. (Overrides XFormDispose(Boolean).)
	DrawingFinished	This function should be called when drawing the content of this form is finished. The XGraphics object used for drawing the content is disposed by this function and cannot be used for any further drawing operations. PDFEdit automatically calls this function when this form was used the first time in a DrawImage function. (Inherited from XForm.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	ExtractPageNumber	Extracts the page number if the path has the form 'MyFile.pdf#123' and returns the actual path without the number sign and the following digits.
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	FromFile	Creates an XPdfForm from a file.
	FromStream	Creates an XPdfForm from a stream.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Properties

	Name	Description
	BoundingBox	Gets or sets the bounding box. (Inherited from XForm.)
	Format	Gets the format of the image. (Inherited from XImage.)
	Height	Obsolete. Gets the height in point of the page identified by the property PageNumber. (Overrides XFormHeight.)
	HorizontalResolution	Gets 72, the horizontal resolution by design of a form object. (Inherited from XForm.)
	Interpolate	Gets or sets a flag indicating whether image interpolation is to be performed. (Inherited from XImage.)
	Page	Gets the underlying PdfPage (if one exists).
	PageCount	Gets the number of pages in the PDF form.
	PageIndex	Gets or sets the page index in the external PDF document this object refers to. The page index is zero-based, i.e. it is in the range from 0 to PageCount - 1. The default value is 0.
	PageNumber	Gets or sets the page number in the external PDF document this object refers to. The page number is one-based, i.e. it is in the range from 1 to PageCount. The default value is 1.
	PixelHeight	Gets the height in point of the page identified by the property PageNumber. (Overrides XFormPixelHeight.)
	PixelWidth	Gets the width in point of the page identified by the property PageNumber. (Overrides XFormPixelWidth.)
	PlaceHolder	Gets or sets an image that is used for drawing if the current XGraphics object cannot handle PDF forms. A place holder is useful for showing a preview of a page on the display, because PDFEdit cannot render native PDF objects.
	PointHeight	Gets the height in point of the page identified by the property PageNumber. (Overrides XFormPointHeight.)
	PointWidth	Gets the width in point of the page identified by the property PageNumber. (Overrides XFormPointWidth.)
	Size	Get the size of the page identified by the property PageNumber. (Overrides XFormSize.)
	Transform	Gets or sets the transformation matrix. (Overrides XFormTransform.)
	VerticalResolution	Gets 72 always, the vertical resolution by design of a form object. (Inherited from XForm.)
	ViewBox	Gets the view box of the form. (Inherited from XForm.)
	Width	Obsolete. Gets the width in point of the page identified by the property PageNumber. (Overrides XFormWidth.)

Top

Reference

PdfEdit.Drawing Namespace