C# Class PdfRpt.FluentInterface.DocumentPreferencesBuilder

PagePreferences Builder Class.

Show file Open project: VahidN/PdfReport Class Usage Examples

Public Methods

Method	Description
AddFileAttachment ( PdfRpt.Core.Contracts.FileAttachment fileAttachment ) : void	Adds an optional file attachment at the document level.
BackgroundImage ( string backgroundImageFilePath, System position = null ) : void	Background image's file path and position.
Compression ( PdfRpt.Core.Contracts.CompressionSettings settings ) : void	Compression settings.
ConformanceLevel ( PdfXConformance level ) : void	Sets subsets of the PDF specification (ISO 15930-1 to ISO 15930-8) that promise predictable and consistent output for press printing.
CustomPageSize ( iTextSharp pageSize ) : void	Sets the page size to PageSize.A4 for instance.
DiagonalWatermark ( DiagonalWatermark watermark ) : void	A watermark text to display.
DocumentMargins ( PdfRpt.Core.Contracts.DocumentMargins margins ) : void	Sets the new document's margins. Its predefined values are Bottom = 60, Left = 36, Right = 36, Top = 36.
DocumentMetadata ( PdfRpt.Core.Contracts.DocumentMetadata metadata ) : void	Sets document's metadata.
DocumentPreferencesBuilder ( PdfReport pdfReport ) : System.Collections.Generic	ctor.
Orientation ( PageOrientation value ) : void	Sets the PageOrientation.
PageSize ( PdfPageSize size ) : void	Sets the page size to PageSize.A4 for instance.
PagesBackgroundColor ( System backgroundColor ) : void	Setting Page Background Color.
PrintingPreferences ( PdfRpt.Core.Contracts.PrintingPreferences preferences ) : void	Indicates default values of print dialog box.
RunDirection ( PdfRunDirection direction ) : void	Sets the run direction to rtl or ltr.
ViewerPreferences ( PdfViewerPreferences preferences ) : void	Specifies the Adobe Reader's settings when a document is opened.

Method Details

AddFileAttachment() public method

Adds an optional file attachment at the document level.

public AddFileAttachment ( PdfRpt.Core.Contracts.FileAttachment fileAttachment ) : void
fileAttachment	PdfRpt.Core.Contracts.FileAttachment	a file attachment
return	void

BackgroundImage() public method

Background image's file path and position.

public BackgroundImage ( string backgroundImageFilePath, System position = null ) : void
backgroundImageFilePath	string	Background image's file path.
position	System	Background image's position. If it's set to null, the image will be painted at the center of the page.
return	void

Compression() public method

Compression settings.

public Compression ( PdfRpt.Core.Contracts.CompressionSettings settings ) : void
settings	PdfRpt.Core.Contracts.CompressionSettings	Compression settings
return	void

ConformanceLevel() public method

Sets subsets of the PDF specification (ISO 15930-1 to ISO 15930-8) that promise predictable and consistent output for press printing.

public ConformanceLevel ( PdfXConformance level ) : void
level	PdfXConformance	conformance level
return	void

CustomPageSize() public method

Sets the page size to PageSize.A4 for instance.

public CustomPageSize ( iTextSharp pageSize ) : void
pageSize	iTextSharp	selected page size
return	void

DiagonalWatermark() public method

A watermark text to display.

public DiagonalWatermark ( DiagonalWatermark watermark ) : void
watermark	PdfRpt.Core.Contracts.DiagonalWatermark	watermark settings
return	void

DocumentMargins() public method

Sets the new document's margins. Its predefined values are Bottom = 60, Left = 36, Right = 36, Top = 36.

public DocumentMargins ( PdfRpt.Core.Contracts.DocumentMargins margins ) : void
margins	PdfRpt.Core.Contracts.DocumentMargins	The new document's margins
return	void

DocumentMetadata() public method

Sets document's metadata.

public DocumentMetadata ( PdfRpt.Core.Contracts.DocumentMetadata metadata ) : void
metadata	PdfRpt.Core.Contracts.DocumentMetadata	document's metadata
return	void

DocumentPreferencesBuilder() public method

ctor.

public DocumentPreferencesBuilder ( PdfReport pdfReport ) : System.Collections.Generic
pdfReport	PdfReport
return	System.Collections.Generic

Orientation() public method

Sets the PageOrientation.

public Orientation ( PageOrientation value ) : void
value	PageOrientation	Page Orientation
return	void

PageSize() public method

Sets the page size to PageSize.A4 for instance.

public PageSize ( PdfPageSize size ) : void
size	PdfPageSize	selected page size
return	void

PagesBackgroundColor() public method

Setting Page Background Color.

public PagesBackgroundColor ( System backgroundColor ) : void
backgroundColor	System	Pages Background Color
return	void

PrintingPreferences() public method

Indicates default values of print dialog box.

public PrintingPreferences ( PdfRpt.Core.Contracts.PrintingPreferences preferences ) : void
preferences	PdfRpt.Core.Contracts.PrintingPreferences	printing preferences
return	void

RunDirection() public method

Sets the run direction to rtl or ltr.

public RunDirection ( PdfRunDirection direction ) : void
direction	PdfRunDirection	run direction, rtl or ltr
return	void

ViewerPreferences() public method

Specifies the Adobe Reader's settings when a document is opened.

public ViewerPreferences ( PdfViewerPreferences preferences ) : void
preferences	PdfRpt.Core.Contracts.PdfViewerPreferences	viewer preferences
return	void