 | PdfOptions Class |
Defines various PDF options.
Inheritance HierarchyNamespace: Opait.Pdf.Api
Assembly: Opait.Pdf.Api (in Opait.Pdf.Api.dll) Version: 1.3.3.0
SyntaxC#
public class PdfOptions
The PdfOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PdfOptions |
Initializes a new instance of the PdfOptions class with default settings.
|
| PdfOptions(XElement) |
Initializes a new instance of the PdfOptions class from a previously
serialized XML element.
|
Properties| Name | Description | |
|---|---|---|
 | BinarizationMethod |
Gets or sets the boinarization method when grayscale images
are converted to black-and-white.
|
| CompressContent |
Gets or sets a flag to compress PDF page content stream.
Page content streams are normally compressed using flate algorithm.
You may want to disable the compression for debugging purposes.
|
| DefaultPageSize |
Defines the default page size when new pages are created.
|
| EmbedFont |
Gets or sets a flag to indicate whether to embed the font
descriptor in the generated PDF file.
|
| Encrypt |
Gets or sets a flag to indicate Whether PDF file is encrypted.
|
| EncryptMetaData |
Gets or sets a flag to indicate whether metadata is also encrypted.
|
| FastWebAccess |
If enabled, PDF files will be linearized to make them load faster
on the WEB. This was more important in the past when Internet
bandwidth was limited. Cannot be used with PDF/A files.
|
| FileName |
Gets or sets the path to the target file.
|
| FileVersion |
Gets or sets the default PDF file version for new documents.
|
| Flatten |
Gets or sets a value to indicate whether forms should be
flatten when the document is saved or printed.
|
| FontFamily |
Gets or sets the font family to use if text is visible.
|
| FullPageOcr |
If set, then PDF pages will be fully rasterized and any existing text
object will be lost. If not set, then only qualified image objects
will be processed through OCR and the data will be merged with the
page. The existing attributes will remain. Default is false.
|
| JpegQuality |
Gets or sets the default quality when saving in JPEG format.
|
| MinimizeSize |
Whether to minimize sizes of PDF files. Interpretation is application dependent.
|
| OwnerPassword |
Gest or sets the password used to alter the PDF security.
|
| PageRange |
Gets or sets the ranges of page numbers to save, or null
to save all pages in the source document.
|
| PageTreeNodeSize |
The maximum number of entries in the page tree nodes.
|
| PixelFormat |
Gets or sets the pixel color depth when rasterizing PDF pages.
|
| PreventCopy |
Gets or sets a flag to prevent copying of protected PDF file.
|
| PreventModify |
Gets or sets a flag to prevent modifying of protected PDF file.
|
| PreventPrint |
Gets or sets a flag to prevent printing of protected PDF file.
|
| RedactPassword |
Gest or sets the password used to encrypt embedded redaction data.
|
| Resolution |
Gets or sets the desired resolution of the raster images.
If set to zero, a default resolution is used based on the
color depth.
|
| SaveAsPdfA |
Gets or sets a flag to save PDF documents in PDF/A-1b specification. Certain
restrictions will apply to such files. For example, PDF/A files may
not be encrypted or linearized.
|
| SaveFormat |
Gets or sets the format for saving PDF files.
|
| SaveStandardWidths |
Saving font descriptors and character widths are optional
for the standard built-in fonts. This option controls whether
font descriptors and character widths will be saved when
using built-in fonts.
|
| Threshold |
Gets or sets a color value in the range [0,255] below which
a pixel is assumed black when converting to monochrome using
the threshold method.
|
| UserPassword |
Gets or sets the password used to open the PDF file.
|
Methods| Name | Description | |
|---|---|---|
| FromXml |
Initializes a new instance of the PdfOptions class from a previously
serialized XML element.
|
| Reset |
Resets all options to their default values.
|
| ToXml |
Saves the current instance of PdfOptions as an XML element.
|
Fields| Name | Description | |
|---|---|---|
  | DefaultColorDpi |
Default resolution for full-color images.
|
| DefaultFileVersion |
Default PDF file version when new documents are generated.
|
| DefaultGrayscaleDpi |
Default resolution for grayscale images.
|
| DefaultJpegQuality |
Default JPEG compression quality.
|
| DefaultMonochromeDpi |
Default resolution for monochrome images.
|
| DefaultPageTreeNodes |
Default PDF page tree node size.
|
| DefaultThreshold |
Default fixed binarization threshold.
|
| MaximumThreshold |
Maximum allowed fixed binarization threshold.
|
| MinimumThreshold |
Minimum allowed fixed binarization threshold.
|
See Also