Class MultiPageLayout
Namespace: Aspose.Words.Saving
Assembly: Aspose.Words.dll (25.7.0)
Defines a layout for rendering multiple pages into a single output.
public sealed class MultiPageLayout
Inheritance
Inherited Members
object.GetType() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()
Remarks
Use one of the static factory methods to create a layout configuration.
Properties
BackColor
Gets or sets the background color of the output. The default is System.Drawing.Color.Empty.
public Color BackColor { get; set; }
Property Value
BorderColor
Gets or sets the color of the pages border. The default is System.Drawing.Color.Empty.
public Color BorderColor { get; set; }
Property Value
BorderWidth
Gets or sets the width of the pages border. The default is 0.
public float BorderWidth { get; set; }
Property Value
Methods
Grid(int, float, float)
Creates a layout in which pages are rendered left-to-right, top-to-bottom, in a grid with the specified number of columns.
public static MultiPageLayout Grid(int columns, float horizontalGap, float verticalGap)
Parameters
columns
int
The number of columns in the layout. Must be greater than zero.
horizontalGap
float
The horizontal gap between columns in points.
verticalGap
float
The vertical gap between rows in points.
Returns
Exceptions
Thrown if columns
is less than or equal to zero.
Horizontal(float)
Creates a layout in which all specified pages are rendered horizontally side by side, left to right, in a single output.
public static MultiPageLayout Horizontal(float horizontalGap)
Parameters
horizontalGap
float
The horizontal gap between pages in points.
Returns
SinglePage()
Creates a layout that renders only the first of specified pages.
public static MultiPageLayout SinglePage()
Returns
TiffFrames()
Creates a layout where each page is rendered as a separate frame in a multi-frame TIFF image. Applicable only to TIFF image formats.
public static MultiPageLayout TiffFrames()
Returns
Vertical(float)
Creates a layout where all specified pages are rendered vertically one below the other in a single output.
public static MultiPageLayout Vertical(float verticalGap)
Parameters
verticalGap
float
The vertical gap between pages in points.