GrapeCity.Documents.Word.Layout.GcWordLayout

Class GcWordLayout

Namespace

GrapeCity.Documents.Word.Layout

Assembly

GcDocs.Word.Layout.dll

Represents a paginated document to be converted to printable formats, such as PDF.

public class GcWordLayout : IDisposable

Inheritance

object

GcWordLayout

Implements

System.IDisposable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

GcWordLayout(GcWordDocument, WordLayoutSettings)

Creates a new instance of GcWordLayout from an instance of GcWordDocument.

public GcWordLayout(GcWordDocument wordDocument, WordLayoutSettings layoutSettings = null)

Parameters

wordDocument GcWordDocument

The source instance of GcWordDocument.

layoutSettings WordLayoutSettings

Settings used for layout of GcWordDocument.

Properties

Author

Gets or sets the name of the person that created the document (for export to PDF).

public string Author { get; set; }

Property Value

string

CreatedTime

Gets or sets date of the document creation in UTC (for export to PDF).

public DateTime? CreatedTime { get; set; }

Property Value

System.DateTime?

Keywords

Gets or sets keywords (separated by comma) associated with the document (for export to PDF).

public string Keywords { get; set; }

Property Value

string

LastSavedTime

Gets or sets the time of the last save in UTC (for export to PDF).

public DateTime? LastSavedTime { get; set; }

Property Value

System.DateTime?

Pages

Gets the list of pages.

public List<Page> Pages { get; }

Property Value

System.Collections.Generic.List<T><Page>

Subject

Gets or sets the subject of the document (for export to PDF).

public string Subject { get; set; }

Property Value

string

Title

Gets or sets the title of the document (for export to PDF).

public string Title { get; set; }

Property Value

string

WordDocument

Gets the source GcWordDocument.

public GcWordDocument WordDocument { get; }

Property Value

GcWordDocument

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

~GcWordLayout()

Performs cleanup operations on unmanaged resources.

protected ~GcWordLayout()

SaveAsPdf(Stream, OutputRange, PdfOutputSettings)

Saves the document into a stream in PDF format.

public void SaveAsPdf(Stream stream, OutputRange pageRange = null, PdfOutputSettings pdfSettings = null)

Parameters

stream System.IO.Stream

The output stream.

pageRange GrapeCity.Documents.Common.OutputRange

The range of pages that should be saved.

pdfSettings PdfOutputSettings

The set of parameters for the output PDF.

SaveAsPdf(string, OutputRange, PdfOutputSettings)

Saves the document into a file in PDF format.

public void SaveAsPdf(string filePath, OutputRange pageRange = null, PdfOutputSettings pdfSettings = null)

Parameters

filePath string

Full path to the output file.

pageRange GrapeCity.Documents.Common.OutputRange

The range of pages that should be saved.

pdfSettings PdfOutputSettings

The set of parameters for the output PDF.

SaveAsTiff(Stream, OutputRange, ImageOutputSettings, TiffFrameSettings)

Saves the document pages as images to a stream in TIFF format, one page per frame.

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

Parameters

stream System.IO.Stream

The output stream.

pageRange GrapeCity.Documents.Common.OutputRange

The range of pages that should be saved.

options ImageOutputSettings

Options that allow customizing the output images.

frameSettings GrapeCity.Documents.Imaging.TiffFrameSettings

Frame settings that are used for encoding the TIFF frames.

SaveAsTiff(string, OutputRange, ImageOutputSettings, TiffFrameSettings)

Saves the document pages as images to a stream in TIFF format, one page per frame.

public void SaveAsTiff(string fileName, OutputRange pageRange = null, ImageOutputSettings options = null, TiffFrameSettings frameSettings = null)

Parameters

fileName string

The output file path.

pageRange GrapeCity.Documents.Common.OutputRange

The range of pages that should be saved.

options ImageOutputSettings

Options that allow customizing the output images.

frameSettings GrapeCity.Documents.Imaging.TiffFrameSettings

Frame settings that are used for encoding the TIFF frames.