Represents a graphical object that can be used to render retained graphics on it. In GDI+ it is represented by a Metafile, in WPF by a DrawingVisual, and in PDF by a Form XObjects. More...

Inheritance diagram for PdfSharp.Drawing.XForm:

Public Member Functions
	XForm (PdfDocument document, XRect viewBox)
	Initializes a new instance of the XForm class that represents a page of a PDF document. More...

	XForm (PdfDocument document, XSize size)
	Initializes a new instance of the XForm class that represents a page of a PDF document. More...

	XForm (PdfDocument document, XUnit width, XUnit height)
	Initializes a new instance of the XForm class that represents a page of a PDF document. More...

void	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. PDFsharp automatically calls this function when this form was used the first time in a DrawImage function. More...

Public Member Functions inherited from PdfSharp.Drawing.XImage
void	Dispose ()
	Under construction More...

Protected Member Functions
	XForm ()
	Initializes a new instance of the XForm class. More...

override void	Dispose (bool disposing)
	Disposes this instance. More...

Protected Member Functions inherited from PdfSharp.Drawing.XImage
	XImage ()
	Initializes a new instance of the XImage class. More...

Properties
override double	Width `[get]`
	Get the width of the page identified by the property PageNumber. More...

override double	Height `[get]`
	Get the width of the page identified by the property PageNumber. More...

override double	PointWidth `[get]`
	Get the width in point of this image. More...

override double	PointHeight `[get]`
	Get the height in point of this image. More...

override int	PixelWidth `[get]`
	Get the width of the page identified by the property PageNumber. More...

override int	PixelHeight `[get]`
	Get the height of the page identified by the property PageNumber. More...

override XSize	Size `[get]`
	Get the size of the page identified by the property PageNumber. More...

XRect	ViewBox `[get]`
	Gets the view box of the form. More...

override double	HorizontalResolution `[get]`
	Gets 72, the horizontal resolution by design of a form object. More...

override double	VerticalResolution `[get]`
	Gets 72 always, the vertical resolution by design of a form object. More...

XRect	BoundingBox `[get, set]`
	Gets or sets the bounding box. More...

virtual XMatrix	Transform `[get, set]`
	Gets or sets the transformation matrix. More...

override bool	IsCmyk `[get]`
	Gets a value indicating whether this image is cmyk. More...

override bool	IsJpeg `[get]`
	Gets a value indicating whether this image is JPEG. More...

override MemoryStream	Memory `[get]`
	Gets the JPEG memory stream (if IsJpeg returns true). More...

Properties inherited from PdfSharp.Drawing.XImage
virtual double	Width `[get]`
	Gets the width of the image. More...

virtual double	Height `[get]`
	Gets the height of the image. More...

virtual double	PointWidth `[get]`
	Gets the width of the image in point. More...

virtual double	PointHeight `[get]`
	Gets the height of the image in point. More...

virtual int	PixelWidth `[get]`
	Gets the width of the image in pixels. More...

virtual int	PixelHeight `[get]`
	Gets the height of the image in pixels. More...

virtual XSize	Size `[get]`
	Gets the size in point of the image. More...

virtual double	HorizontalResolution `[get]`
	Gets the horizontal resolution of the image. More...

virtual double	VerticalResolution `[get]`
	Gets the vertical resolution of the image. More...

virtual bool	Interpolate `[get, set]`
	Gets or sets a flag indicating whether image interpolation is to be performed. More...

XImageFormat	Format `[get]`
	Gets the format of the image. More...

virtual bool?	IsJpeg `[get]`
	Gets a value indicating whether this image is JPEG. More...

virtual bool?	IsCmyk `[get]`
	Gets a value indicating whether this image is cmyk. More...

virtual MemoryStream	Memory `[get]`
	Gets the JPEG memory stream (if IsJpeg returns true). More...

Additional Inherited Members
Static Public Member Functions inherited from PdfSharp.Drawing.XImage
static XImage	FromBitmapSource (BitmapSource image)
	Conversion from BitmapSource to XImage. More...

static XImage	FromFile (string path)
	Creates an image from the specified file. More...

static bool	ExistsFile (string path)
	Tests if a file exist. Supports PDF files with page number suffix. More...

Detailed Description

Represents a graphical object that can be used to render retained graphics on it. In GDI+ it is represented by a Metafile, in WPF by a DrawingVisual, and in PDF by a Form XObjects.

Constructor & Destructor Documentation

◆ XForm() [1/4]

PdfSharp.Drawing.XForm.XForm ( )

protected

Initializes a new instance of the XForm class.

◆ XForm() [2/4]

PdfSharp.Drawing.XForm.XForm	(	PdfDocument	document,
		XRect	viewBox
	)

Initializes a new instance of the XForm class that represents a page of a PDF document.

Parameters

document	The PDF document.
viewBox	The view box of the page.

◆ XForm() [3/4]

PdfSharp.Drawing.XForm.XForm	(	PdfDocument	document,
		XSize	size
	)

Initializes a new instance of the XForm class that represents a page of a PDF document.

Parameters

document	The PDF document.
size	The size of the page.

◆ XForm() [4/4]

PdfSharp.Drawing.XForm.XForm	(	PdfDocument	document,
		XUnit	width,
		XUnit	height
	)

Initializes a new instance of the XForm class that represents a page of a PDF document.

Parameters

document	The PDF document.
width	The width of the page.
height	The height of the page

Member Function Documentation

◆ Dispose()

override void PdfSharp.Drawing.XForm.Dispose ( bool disposing )

protectedvirtual

Disposes this instance.

Reimplemented from PdfSharp.Drawing.XImage.

Reimplemented in PdfSharp.Drawing.XPdfForm.

◆ DrawingFinished()

void PdfSharp.Drawing.XForm.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. PDFsharp automatically calls this function when this form was used the first time in a DrawImage function.

Property Documentation

◆ BoundingBox

XRect PdfSharp.Drawing.XForm.BoundingBox

getset

Gets or sets the bounding box.

◆ Height

override double PdfSharp.Drawing.XForm.Height

get

Get the width of the page identified by the property PageNumber.

◆ HorizontalResolution

override double PdfSharp.Drawing.XForm.HorizontalResolution

get

Gets 72, the horizontal resolution by design of a form object.

◆ IsCmyk

override bool PdfSharp.Drawing.XForm.IsCmyk

get

Gets a value indicating whether this image is cmyk.

true if this image is cmyk; otherwise, false.

◆ IsJpeg

override bool PdfSharp.Drawing.XForm.IsJpeg

get

Gets a value indicating whether this image is JPEG.

true if this image is JPEG; otherwise, false.

◆ Memory

override MemoryStream PdfSharp.Drawing.XForm.Memory

get

Gets the JPEG memory stream (if IsJpeg returns true).

The memory.

◆ PixelHeight

override int PdfSharp.Drawing.XForm.PixelHeight

get

Get the height of the page identified by the property PageNumber.

◆ PixelWidth

override int PdfSharp.Drawing.XForm.PixelWidth

get

Get the width of the page identified by the property PageNumber.

◆ PointHeight

override double PdfSharp.Drawing.XForm.PointHeight

get

Get the height in point of this image.

◆ PointWidth

override double PdfSharp.Drawing.XForm.PointWidth

get

Get the width in point of this image.

◆ Size

override XSize PdfSharp.Drawing.XForm.Size

get

Get the size of the page identified by the property PageNumber.

◆ Transform

virtual XMatrix PdfSharp.Drawing.XForm.Transform

getset

Gets or sets the transformation matrix.

◆ VerticalResolution

override double PdfSharp.Drawing.XForm.VerticalResolution

get

Gets 72 always, the vertical resolution by design of a form object.

◆ ViewBox

XRect PdfSharp.Drawing.XForm.ViewBox

get

Gets the view box of the form.

◆ Width

override double PdfSharp.Drawing.XForm.Width

get

Get the width of the page identified by the property PageNumber.

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

PdfSharp.Drawing/XForm.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XForm() [1/4]

◆ XForm() [2/4]

◆ XForm() [3/4]

◆ XForm() [4/4]

Member Function Documentation

◆ Dispose()

◆ DrawingFinished()

Property Documentation

◆ BoundingBox

◆ Height

◆ HorizontalResolution

◆ IsCmyk

◆ IsJpeg

◆ Memory

◆ PixelHeight

◆ PixelWidth

◆ PointHeight

◆ PointWidth

◆ Size

◆ Transform

◆ VerticalResolution

◆ ViewBox

◆ Width