ExportToXps(Stream,Size,Rect,PageRange,CompressionOption,EventHandler<ProgressEventArgs>,Boolean,Boolean) Method

Exports the grid as an XPS document to the specified stream using the provided page size, page range, imageable area, compression option, and providing the callback to invoke during the process, as well as indicating whether the progress window is displayed.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function ExportToXps( _

   ByVal stream As Stream, _

   ByVal pageSize As Size, _

   ByVal imageableArea As Rect, _

   ByVal pageRange As PageRange, _

   ByVal compressionOption As CompressionOption, _

   ByVal progressCallback As EventHandler(Of ProgressEventArgs), _

   ByVal showProgressWindow As Boolean, _

   ByVal printPreview As Boolean _

) As Boolean

'Usage
 
Dim instance As DataGridControl

Dim stream As Stream

Dim pageSize As Size

Dim imageableArea As Rect

Dim pageRange As PageRange

Dim compressionOption As CompressionOption

Dim progressCallback As EventHandler(Of ProgressEventArgs)

Dim showProgressWindow As Boolean

Dim printPreview As Boolean

Dim value As Boolean

 

value = instance.ExportToXps(stream, pageSize, imageableArea, pageRange, compressionOption, progressCallback, showProgressWindow, printPreview)

public bool ExportToXps( 

   Stream stream,

   Size pageSize,

   Rect imageableArea,

   PageRange pageRange,

   CompressionOption compressionOption,

   EventHandler<ProgressEventArgs> progressCallback,

   bool showProgressWindow,

   bool printPreview

)

Parameters

stream: The Stream to which the grid will be exported as an XPS document.
pageSize: A Size structure that indicates the size of the pages, including the printer margins.
imageableArea: A Rect structure that represents the area of the page that can be printed.
pageRange: A PageRange structure that represents the range of pages to process.
compressionOption: A CompressionOption value that indicates the compression level to use.
progressCallback: The callback to invoke during the process.
showProgressWindow: true if the progress window is displayed; false otherwise.
printPreview: true if the print preview window is displayed; false otherwise.

Exceptions

Exception	Description
System.Security.SecurityException	Can be thrown in XBAP if FullTrust permissions are not used.

Remarks

Although the description displayed in the progress window can be modified directly in the callback, it is recommended that ProgressWindowDescription property of the print view be changed instead to prevent the default "Processing..." text from initially being displayed.

Requirements

Target Platforms: Windows 11, Windows, 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DataGridControl Class
DataGridControl Members
Overload List