Class PdfRendererOptions

This class can be used to control various properties of PDF files created by Apoc XSL-FO.

Inheritance
System.Object
PdfRendererOptions
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Apoc.Render.Pdf
Assembly: TelerikData.dll

Syntax

public sealed class PdfRendererOptions : IRendererOptions
Remarks

Can be used to control certain values in the generated PDF's information dictionary. These values are typically displayed in a document summary dialog of PDF viewer applications. This class also allows security settings to be specified that will cause generated PDF files to be encrypted and optionally password protected.

Constructors

PdfRendererOptions()

Declaration
public PdfRendererOptions()

Properties

Author

Specifies the Author of the PDF document.

Declaration
public string Author { get; set; }
Property Value
System.String

The default value is null.
Remarks

This value will be embedded in the PDF information dictionary.

Creator

Returns the Creator of the PDF document.

Declaration
public string Creator { get; set; }
Property Value
System.String

This method will always return "XSL-FO http://www.w3.org/1999/XSL/Format";.

EnableAdd

Enables or disables adding or modifying text annotations and interactive form fields.

Declaration
public bool EnableAdd { get; set; }
Property Value
System.Boolean

The default value is true.

EnableCopy

Enables or disables copying of text and graphics.

Declaration
public bool EnableCopy { get; set; }
Property Value
System.Boolean

The default value is true.

EnableModify

Enables or disables modifying document contents (other than text annotations and interactive form fields).

Declaration
public bool EnableModify { get; set; }
Property Value
System.Boolean

The default value is true.

EnablePrinting

Enables or disables printing.

Declaration
public bool EnablePrinting { get; set; }
Property Value
System.Boolean

The default value is true.

FontType

Specifies how Apoc should treat fonts.

Declaration
public FontType FontType { get; set; }
Property Value
FontType

The default value is FontType.Link

Kerning

Gets or sets a value that indicates whether to enable kerning.

Declaration
public bool Kerning { get; set; }
Property Value
System.Boolean

The default value is false

OwnerPassword

Specifies the owner password that will protect full access to any generated PDF documents.

Declaration
public string OwnerPassword { get; set; }
Property Value
System.String

The default value is null.
Remarks

If either the owner or the user password is specified, then the document will be encrypted.

Producer

Returns the Producer of the PDF document.

Declaration
public string Producer { get; set; }
Property Value
System.String

This method will return the assembly name and version of Apoc.

Subject

Specifies the Subject of the PDF document.

Declaration
public string Subject { get; set; }
Property Value
System.String

The default value is null.
Remarks

This value will be embedded in the PDF information dictionary.

Title

Specifies the Title of the PDF document.

Declaration
public string Title { get; set; }
Property Value
System.String

The default value is null.
Remarks

This value will be embedded in the PDF information dictionary.

UserPassword

Specifies the user password that will protect access to any generated PDF documents.

Declaration
public string UserPassword { get; set; }
Property Value
System.String

The default value is null.
Remarks

If either the owner or the user password is specified, then the document will be encrypted.

Methods

AddKeyword(String)

Adds a keyword to the PDF document.

Declaration
public void AddKeyword(string keyword)
Parameters
System.String keyword

The keyword to be added.
Remarks

Keywords are embedded in the PDF information dictionary.

AddPrivateFont(FileInfo)

Adds fileInfo to the private font collection.

Declaration
public void AddPrivateFont(FileInfo fileInfo)
Parameters
System.IO.FileInfo fileInfo

Absolute path to a TrueType font or collection.
Exceptions
System.ArgumentNullException

If fileInfo is null.
System.IO.FileNotFoundException

If fileInfo does not exist.
System.ArgumentException

If fileInfo has already been added.
System.ArgumentException

If fileInfo cannot be added to the system font collection.

Extension Methods