GrapeCity.Documents.Word.Layout.Page

Class Page

Namespace

GrapeCity.Documents.Word.Layout

Assembly

GcDocs.Word.Layout.dll

Represents a page in GcWordLayout.

public class Page

Inheritance

object

Page

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Height

Gets the height of the page, in points.

public float Height { get; }

Property Value

float

Width

Gets the width of the page, in points.

public float Width { get; }

Property Value

float

WordLayout

Gets the owner GcWordLayout.

public GcWordLayout WordLayout { get; }

Property Value

GcWordLayout

Methods

SaveAsJpeg(Stream, ImageOutputSettings)

Saves the page as an image to a stream in JPEG format.

public void SaveAsJpeg(Stream stream, ImageOutputSettings options = null)

Parameters

stream System.IO.Stream

The output stream.

options ImageOutputSettings

Options that allow customizing the output image.

SaveAsJpeg(string, ImageOutputSettings)

Saves the page as an image to a file in JPEG format.

public void SaveAsJpeg(string filePath, ImageOutputSettings options = null)

Parameters

filePath string

The output file path.

options ImageOutputSettings

Options that allow customizing the output image.

SaveAsPng(Stream, ImageOutputSettings)

Saves the page as an image to a stream in PNG format.

public void SaveAsPng(Stream stream, ImageOutputSettings options = null)

Parameters

stream System.IO.Stream

The output stream.

options ImageOutputSettings

Options that allow customizing the output image.

SaveAsPng(string, ImageOutputSettings)

Saves the page as an image to a file in PNG format.

public void SaveAsPng(string filePath, ImageOutputSettings options = null)

Parameters

filePath string

The output file path.

options ImageOutputSettings

Options that allow customizing the output image.

SaveAsSvg(Stream, ImageOutputSettings, XmlWriterSettings)

Saves the page to a stream in SVG format.

public void SaveAsSvg(Stream stream, ImageOutputSettings options = null, XmlWriterSettings xmlSettings = null)

Parameters

stream System.IO.Stream

The output stream.

options ImageOutputSettings

Options that allow customizing the output image.

xmlSettings System.Xml.XmlWriterSettings

The output XML formatting settings.

SaveAsSvg(string, ImageOutputSettings, XmlWriterSettings)

Saves the current page to a file in SVG format.

public void SaveAsSvg(string filePath, ImageOutputSettings options = null, XmlWriterSettings xmlSettings = null)

Parameters

filePath string

The output file path.

options ImageOutputSettings

Options that allow customizing the output image.

xmlSettings System.Xml.XmlWriterSettings

The output XML formatting settings.

SaveAsTiff(Stream, ImageOutputSettings, TiffFrameSettings)

Saves the page as an image to a stream in TIFF format.

public void SaveAsTiff(Stream stream, ImageOutputSettings options = null, TiffFrameSettings frameSettings = null)

Parameters

stream System.IO.Stream

The output stream.

options ImageOutputSettings

Options that allow customizing the output image.

frameSettings GrapeCity.Documents.Imaging.TiffFrameSettings

Frame settings that are used for encoding the TIFF frame.

SaveAsTiff(string, ImageOutputSettings, TiffFrameSettings)

Saves the page as an image to a file in TIFF format.

public void SaveAsTiff(string filePath, ImageOutputSettings options = null, TiffFrameSettings frameSettings = null)

Parameters

filePath string

The output file path.

options ImageOutputSettings

Options that allow customizing the output image.

frameSettings GrapeCity.Documents.Imaging.TiffFrameSettings

Frame settings that are used for encoding the TIFF frame.

ToSvgz(ImageOutputSettings)

Saves the current page to a byte array in SVGZ format.

public byte[] ToSvgz(ImageOutputSettings options = null)

Parameters

options ImageOutputSettings

Options that allow customizing the output image.

Returns

byte[]