GrapeCity.Documents.Word.Layout.PdfOutputSettings

Class PdfOutputSettings

Namespace

GrapeCity.Documents.Word.Layout

Assembly

GcDocs.Word.Layout.dll

Options used for saving a GcWordLayout in PDF format.

public class PdfOutputSettings

Inheritance

object

PdfOutputSettings

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

PdfOutputSettings()

public PdfOutputSettings()

Properties

BackColor

Gets or sets the background color. The default is white.

public Color BackColor { get; set; }

Property Value

System.Drawing.Color

CompressionLevel

Gets or sets the compression level.

Default value is System.IO.Compression.CompressionLevel.Optimal

.

public CompressionLevel CompressionLevel { get; set; }

Property Value

System.IO.Compression.CompressionLevel

ConformanceLevel

Gets or sets the PDF/A conformance level.

The default is None (the document does not conform to PDF/A).

See GrapeCity.Documents.Pdf.GcPdfDocument.ConformanceLevel for details.

.

public PdfAConformanceLevel ConformanceLevel { get; set; }

Property Value

GrapeCity.Documents.Pdf.PdfAConformanceLevel

DocumentInfo

Gets or sets a GrapeCity.Documents.Pdf.DocumentInfo object containing information about the document (author, title, etc). See GrapeCity.Documents.Pdf.GcPdfDocument.DocumentInfo for details.

public DocumentInfo DocumentInfo { get; set; }

Property Value

GrapeCity.Documents.Pdf.DocumentInfo

ImageOptions

Gets or sets an GrapeCity.Documents.Pdf.ImageOptions object that contains options controlling how images are processed in the generated PDF. See GrapeCity.Documents.Pdf.GcPdfDocument.ImageOptions for details.

public ImageOptions ImageOptions { get; set; }

Property Value

GrapeCity.Documents.Pdf.ImageOptions

Linearized

Gets or sets a value indicating whether the generated PDF should be saved as linearized. See GrapeCity.Documents.Pdf.GcPdfDocument.Linearized for details.

public bool Linearized { get; set; }

Property Value

bool

Metadata

Gets or sets a metadata object associated with the generated PDF. See GrapeCity.Documents.Pdf.GcPdfDocument.Metadata for details.

public Metadata Metadata { get; set; }

Property Value

GrapeCity.Documents.Pdf.Metadata

PdfVersion

Gets or sets the PDF Version of the generated document. See GrapeCity.Documents.Pdf.GcPdfDocument.PdfVersion for details.

By default the version is determined automatically based on which features are used in this document. Setting this property to a non-null string in the format "1.X" (where X is a digit from 0 to 9) overrides the automatic value with the specified one.

public string PdfVersion { get; set; }

Property Value

string

SecurityHandler

Gets or sets an instance of a class derived from GrapeCity.Documents.Pdf.Security.SecurityHandlerBase used to encrypt the PDF.

Use the CreateSecurityHandler(string) method to initialize this property or create and assign the handler directly.

For example, the following code may be used to password protect the PDF:

wordLayout.SaveAsPdf("output.pdf", null, new PdfOutputSettings
{
    SecurityHandler = new StandardSecurityHandlerRev6
    {
        UserPassword = "231",
        OwnerPassword = "#%f8JK",
        PrintingPermissions = PrintingPermissions.Disabled,
        EditingPermissions = EditingPermissions.Disabled,
        CopyContent = false
    }
});

public SecurityHandlerBase SecurityHandler { get; set; }

Property Value

GrapeCity.Documents.Pdf.Security.SecurityHandlerBase

Methods

CreateSecurityHandler(string)

Creates an instance of GrapeCity.Documents.Pdf.Security.StandardSecurityHandlerRev6 and assigns it to SecurityHandler.

public StandardSecurityHandlerRev6 CreateSecurityHandler(string password = null)

Parameters

password string

If a non-null password is specified, it is assigned to owner and user passwords on the handler.

Returns

GrapeCity.Documents.Pdf.Security.StandardSecurityHandlerRev6

A new instance of GrapeCity.Documents.Pdf.Security.StandardSecurityHandlerRev6.