Class PdfExportOptions

Namespace

Rustaveli.Pdf

Assembly

Rustaveli.Pdf.dll

How a document is exported as PDF.

public sealed class PdfExportOptions

Inheritance

object

PdfExportOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Accessibility

The accessibility standard the document claims to meet, None unless set. PDF/UA tags the document, and needs its Title and Language.

public PdfUAConformance Accessibility { get; set; }

Property Value

PdfUAConformance

Compress

Whether streams are compressed. On by default; off makes content streams readable in a text editor.

public bool Compress { get; set; }

Property Value

bool

Conformance

The PDF/A part and level the document is written to, None unless set. Under PDF/A every glyph must be found, as if RequireEveryGlyph were on, and CMYK images without a colour profile need an ImageProcessor to become RGB.

public PdfAConformance Conformance { get; set; }

Property Value

PdfAConformance

ImageProcessor

What re-encodes images when a quality or maximum resolution asks for it.

public IImageProcessor? ImageProcessor { get; set; }

Property Value

IImageProcessor

ImageQuality

The quality, from 1 to 100, images are compressed at when they set none of their own, or null, the default, to embed them as they are. Needs an ImageProcessor.

public int? ImageQuality { get; set; }

Property Value

int?

ImageResolution

The resolution images generated at their final size are generated at, in pixels per inch: 288 unless set, sharp in print.

public float ImageResolution { get; set; }

Property Value

float

KeepFontHinting

Whether embedded TrueType fonts keep their hinting — the instructions that fit glyphs to a screen's pixel grid at small sizes. Off by default: viewers mostly smooth type on their own, print is unaffected, and hinting is often most of a small document's font data. On, fonts are embedded with it, for the crispest small text on screens that honour it. The few fonts whose glyphs are unreadable without their hinting keep it either way.

public bool KeepFontHinting { get; set; }

Property Value

bool

MaximumImageResolution

The most pixels per inch images are embedded at where they are shown, when they set none of their own, or null, the default, to keep all their pixels. Needs an ImageProcessor.

public float? MaximumImageResolution { get; set; }

Property Value

float?

Protection

The password protection the PDF is written with, or null, the default, for none. PDF/A forbids encryption, so the two cannot be asked for together.

public Protection? Protection { get; set; }

Property Value

Protection

RequireEveryGlyph

Whether every character must be found in some typeface. Off by default, when a character no typeface has is drawn as a missing-glyph box; on, the export fails with MissingGlyphException naming them all.

public bool RequireEveryGlyph { get; set; }

Property Value

bool

Tagged

Whether the PDF records the document's structure — its headings, paragraphs, lists, tables and figures, in reading order — for screen readers, reflow and search. Off by default; PDF/UA and the accessible levels of PDF/A turn it on.

public bool Tagged { get; set; }

Property Value

bool

Remarks

Text is tagged a paragraph where nothing else tags it, lists and links are tagged without asking, and Tagged(IFrame, ContentTag) tags the rest. Running heads and feet, and images and drawings outside a figure, are decoration outside the structure.

Typefaces

The typefaces text is set in. Shared when not set.

public TypefaceLibrary? Typefaces { get; set; }

Property Value

TypefaceLibrary