New to Telerik UI for WinForms? Start a free 30-day trial

Defines PDF document export, page-matrix navigation, and block layout operations.

Definition

Namespace:Telerik.WinControls.Export

Assembly:Telerik.WinControls.dll

Syntax:

C#
public interface IPdfExportRenderer

Properties

Gets or sets the current column in the page matrix.

C#
int CurrentMatrixColumn { get; set; }

Gets or sets the current row in the page matrix.

C#
int CurrentMatrixRow { get; set; }

Methods

Adds the matrix's existing pages to the document in row-major order.

C#
void AddMatrixPagesLeftRight()

Attempts to add matrix pages in column-major order. The current implementation adds no valid pages and may fail when a matrix row has fewer pages than the current column.

C#
void AddMatrixPagesUpDown()

Copies the current editor's graphic and text properties to the block.

C#
void ApplyEditorGraphicAndTextPropertiesToBlock()

Notifies the renderer that the current row's page has been exported.

C#
void CallCurrentRowPageExported()

Creates a block for accumulating text, line breaks, and images before layout or drawing.

C#
void CreateBlock()

Creates a page-matrix editor for pages of the specified size.

C#
void CreateDocumentPageMatrixEditor(SizeF pageSize, ref IPdfEditor editor)
Parameters:pageSizeSizeF

The size of each page in the matrix.

editorIPdfEditor

Receives the editor associated with the created page matrix.

Draws the current block using its measured size.

C#
void DrawBlock()

Draws the current block using the specified size.

C#
void DrawBlock(SizeF size)
Parameters:sizeSizeF

The size at which to draw the block.

Writes the PDF document and its descriptive metadata to the specified stream.

C#
void ExportDocument(Stream stream, string author, string title, string description)
Parameters:streamStream

The destination stream.

authorstring

The document author metadata.

titlestring

The document title metadata.

descriptionstring

The document description metadata.

Gets the editor for the current matrix page.

C#
IPdfEditor GetCurrentPageEditor()
Returns:

IPdfEditor

The editor for the current matrix page.

Gets the number of the current PDF page.

C#
int GetCurrentPageNumber()
Returns:

int

The current page number.

Gets the editor for the first page in the row below the current matrix row.

C#
IPdfEditor GetDownPageEditor()
Returns:

IPdfEditor

The editor for the first page in the next matrix row.

Gets the editor for the page to the right of the current matrix page.

C#
IPdfEditor GetRightPageEditor()
Returns:

IPdfEditor

The editor for the page to the right of the current matrix page.

Adds an image from a stream to the current block.

C#
void InsertBlockImage(Stream stream, double width, double height)
Parameters:streamStream

The stream containing the image.

widthdouble

The image width in the block.

heightdouble

The image height in the block.

Adds a line break to the current block.

C#
void InsertBlockLineBreak()

Adds text to the current block.

C#
void InsertBlockText(string text)
Parameters:textstring

The text to add.

Determines whether the current matrix page is the last page in its row.

C#
bool IsMatrixCurrentPageLastOnRow()
Returns:

bool

true if it is the last page in the row; otherwise, false.

Measures the current block and returns its required size.

C#
SizeF MeasureBlock()
Returns:

SizeF

The measured block size.

Measures the current block within the specified size.

C#
SizeF MeasureBlock(SizeF size)
Parameters:sizeSizeF

The size available for measurement.

Returns:

SizeF

The measured block size.

Sets the left indent applied when laying out the current block.

C#
void SetBlockLeftIndent(double indent)
Parameters:indentdouble

The left indent.