PageLayout

ImageSaveOptions.PageLayout property

Gets or sets the layout used when rendering multiple pages into a single output.

public MultiPageLayout PageLayout { get; set; }

Remarks

Use one of the factory methods of MultiPageLayout to configure this property.

For Tiff the default value is TiffFrames. For other formats the default value is SinglePage.

This property has effect only when saving to the following formats: Jpeg, Gif, Png, Bmp, Tiff, WebP

Examples

Shows how to save the document into JPG image with multi-page layout settings.

Document doc = new Document(MyDir + "Rendering.docx");

ImageSaveOptions options = new ImageSaveOptions(SaveFormat.Jpeg);
// Set up a grid layout with:
// - 3 columns per row.
// - 10pts spacing between pages (horizontal and vertical).
options.PageLayout = MultiPageLayout.Grid(3, 10, 10);

// Alternative layouts:
// options.PageLayout = MultiPageLayout.Horizontal(10);
// options.PageLayout = MultiPageLayout.Vertical(10);

// Customize the background and border.
options.PageLayout.BackColor = Color.LightGray;
options.PageLayout.BorderColor = Color.Blue;
options.PageLayout.BorderWidth = 2;

doc.Save(ArtifactsDir + "ImageSaveOptions.GridLayout.jpg", options);

See Also

ImageSaveOptions.MetafileRenderingOptions ImageSaveOptions.PageSet