Class PrintOut

Base class for print drivers define the funtions to be implemented by any print driver (Report processing driver)

Inheritance

object

PrintOut

PrintOutExcel

PrintOutNet

PrintOutPDFBase

PrintOutText

PrintOutWPF

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Reportman.Drawing

Assembly: Reportman.Drawing.dll

Syntax

public abstract class PrintOut

Constructors

PrintOut()

Constructor, set default values only

Declaration

protected PrintOut()

Fields

Copies

Number of copies, by default 1

Declaration

public int Copies

Field Value

Type	Description
int

CurrentMetafile

Declaration

public MetaFile CurrentMetafile

Field Value

Type	Description
MetaFile

DefaultPrinterName

Declaration

public static string DefaultPrinterName

Field Value

Type	Description
string

DrawFound

Internally determines if the searched texts must be drawn as a selection. Used in preview.

Declaration

protected bool DrawFound

Field Value

Type	Description
bool

EmptyReportThrowException

Throw exception when there is no data available to print

Declaration

public bool EmptyReportThrowException

Field Value

Type	Description
bool

FOrientation

Default orientation, by default Portrait

Declaration

protected OrientationType FOrientation

Field Value

Type	Description
OrientationType

ForcePrinterName

Declaration

public string ForcePrinterName

Field Value

Type	Description
string

FromPage

Starting page, by default 1

Declaration

public int FromPage

Field Value

Type	Description
int

NoData

Event to control

Declaration

public NoDataToPrintEvent NoData

Field Value

Type	Description
NoDataToPrintEvent

PRINTOUT_MAX_PAGES

Maximum number of pages allowed (this is to avoid stack overflow recursions)

Declaration

protected int PRINTOUT_MAX_PAGES

Field Value

Type	Description
int

PageSizeArray

Array of predefined page sizes

Declaration

public static int[,] PageSizeArray

Field Value

Type	Description
int[,]

Previewing

Declaration

public bool Previewing

Field Value

Type	Description
bool

ToPage

End page, by default, the maximum

Declaration

public int ToPage

Field Value

Type	Description
int

Methods

Dispose()

Free memory consumed by graphics resources

Declaration

public virtual void Dispose()

DrawChart(Series, MetaFile, int, int, object)

Declaration

public virtual void DrawChart(Series nseries, MetaFile ametafile, int posx, int posy, object achart)

Parameters

Type	Name	Description
Series	nseries
MetaFile	ametafile
int	posx
int	posy
object	achart

DrawPage(MetaFile, MetaPage)

The driver should draw the page

Declaration

public abstract void DrawPage(MetaFile meta, MetaPage page)

Parameters

Type	Name	Description
MetaFile	meta
MetaPage	page

EndDocument(MetaFile)

The driver should do cleanup here, a print driver should finish print document.

Declaration

public virtual void EndDocument(MetaFile meta)

Parameters

Type	Name	Description
MetaFile	meta

EndPage(MetaFile)

The driver should end current page

Declaration

public virtual void EndPage(MetaFile meta)

Parameters

Type	Name	Description
MetaFile	meta

GetPageSize(out int)

The driver must return the default page size

Declaration

public abstract Point GetPageSize(out int indexqt)

Parameters

Type	Name	Description
int	indexqt

Returns

Type	Description
Point

GraphicExtent(MemoryStream, Point, int)

The driver must return the image extent in twips

Declaration

public abstract Point GraphicExtent(MemoryStream astream, Point extent, int dpi)

Parameters

Type	Name	Description
MemoryStream	astream
Point	extent
int	dpi

Returns

Type	Description
Point

NewDocument(MetaFile)

The driver should do initialization here, a print driver should start a print document, while a preview driver should initialize a bitmap

Declaration

public virtual void NewDocument(MetaFile meta)

Parameters

Type	Name	Description
MetaFile	meta

NewPage(MetaFile, MetaPage)

The driver should start a new page

Declaration

public virtual void NewPage(MetaFile meta, MetaPage page)

Parameters

Type	Name	Description
MetaFile	meta
MetaPage	page

PageSizeName(int)

Returns page size name for provided index

Declaration

public static string PageSizeName(int index)

Parameters

Type	Name	Description
int	index	Index inside page size array

Returns

Type	Description
string	String result, containing page size name

PreparePrint(MetaFile)

Print initialization, it calls Metafile.BeginPrint, and NewDocument for this driver

Declaration

public virtual bool PreparePrint(MetaFile meta)

Parameters

Type	Name	Description
MetaFile	meta

Returns

Type	Description
bool

Print(MetaFile)

Print method, it the PreparePrint, the driver should override this to perform additional actions

Declaration

public virtual bool Print(MetaFile meta)

Parameters

Type	Name	Description
MetaFile	meta

Returns

Type	Description
bool

ProcessNoDataToPrint()

This procedure is called when the user does not handle the no data to print event. Depending on the ouput driver the output will be a message to the user.

Declaration

protected virtual void ProcessNoDataToPrint()

SelectPrinter(PrinterSelectType)

The driver must select a printer

Declaration

public virtual void SelectPrinter(PrinterSelectType PrinterSelect)

Parameters

Type	Name	Description
PrinterSelectType	PrinterSelect

SetOrientation(OrientationType)

Sets page orientation

Declaration

public virtual void SetOrientation(OrientationType PageOrientation)

Parameters

Type	Name	Description
OrientationType	PageOrientation

SetPageSize(PageSizeDetail)

The driver must set a new page size

Declaration

public abstract Point SetPageSize(PageSizeDetail psize)

Parameters

Type	Name	Description
PageSizeDetail	psize

Returns

Type	Description
Point

TextExtent(TextObjectStruct, Point)

The driver must return the text extent in twips

Declaration

public abstract Point TextExtent(TextObjectStruct aobj, Point extent)

Parameters

Type	Name	Description
TextObjectStruct	aobj
Point	extent

Returns

Type	Description
Point