Skip to main content

ImageExportOptions.ExportMode Property

Specifies whether document pages are exported to a single or multiple images.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v24.1.Core.dll

NuGet Package: DevExpress.Printing.Core

#Declaration

[XtraSerializableProperty]
public ImageExportMode ExportMode { get; set; }

#Property Value

Type Description
ImageExportMode

An ImageExportMode enumeration value.

Available values:

Name Description
SingleFile

Exports the document to a single image without indicating the borders of individual pages.

The document’s page headers and footers, and the top and bottom margins are repeated only once - at the beginning and end of the resulting image.

When this export mode is used, the ImageExportOptions.PageRange property is ignored.

SingleFilePageByPage

The document is exported to a single image with borders drawn around each page.

The document’s page headers and footers, and top and bottom margins appear on every page.

The border settings are specified by the ImageExportOptions.PageBorderWidth and ImageExportOptions.PageBorderColor properties.

DifferentFiles

Exports each document page to a separate image (with the image file name indicating the page number).

The document’s page headers and footers, and the top and bottom margins are repeated only once - at the beginning and end of the resulting image.

#Property Paths

You can access this nested property as listed below:

Object Type Path to ExportMode
ExportOptions
.Image .ExportMode

#Remarks

The following image export modes are available:

Export Mode

Description

ImageExportMode.SingleFile

Exports the document to a single image without indicating the borders of individual pages.

The document’s page headers and footers, and the top and bottom margins are repeated only once - at the beginning and end of the resulting image.

When this export mode is used, the ImageExportOptions.PageRange property is ignored.

ImageExportMode.SingleFilePageByPage

The document is exported to a single image with borders drawn around each page.

The document’s page headers and footers, and top and bottom margins appear on every page.

The border settings are specified by the ImageExportOptions.PageBorderWidth and ImageExportOptions.PageBorderColor properties.

ImageExportMode.DifferentFiles

Exports each document page to a separate image (with the image file name indicating the page number).

The document’s page headers and footers, and the top and bottom margins are repeated only once - at the beginning and end of the resulting image.

The following code snippets (auto-collected from DevExpress Examples) contain references to the ExportMode property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also