PdfLoadOptions

PdfLoadOptions class

Allows to specify additional options when loading Pdf document into a Document object.

To learn more, visit the Specify Load Options documentation article.

public class PdfLoadOptions : LoadOptions

Constructors

Name	Description
PdfLoadOptions()	The default constructor.

Properties

Name	Description
BaseUri { get; set; }	Gets or sets the string that will be used to resolve relative URIs found in the document into absolute URIs when required. Can be `null` or empty string. Default is `null`.
ConvertMetafilesToPng { get; set; }	Gets or sets whether to convert metafile(Wmf or Emf) images to Png image format.
ConvertShapeToOfficeMath { get; set; }	Gets or sets whether to convert shapes with EquationXML to Office Math objects.
Encoding { get; set; }	Gets or sets the encoding that will be used to load an HTML, TXT, or CHM document if the encoding is not specified inside the document. Can be `null`. Default is `null`.
FontSettings { get; set; }	Allows to specify document font settings.
IgnoreOleData { get; set; }	Specifies whether to ignore the OLE data.
LanguagePreferences { get; }	Gets language preferences that will be used when document is loading.
LoadFormat { get; set; }	Specifies the format of the document to be loaded. Default is Auto.
MswVersion { get; set; }	Allows to specify that the document loading process should match a specific MS Word version. Default value is Word2019
PageCount { get; set; }	Gets or sets the number of pages to read. Default is MaxValue which means all pages of the document will be read.
PageIndex { get; set; }	Gets or sets the 0-based index of the first page to read. Default is 0.
Password { get; set; }	Gets or sets the password for opening an encrypted document. Can be `null` or empty string. Default is `null`.
PreserveIncludePictureField { get; set; }	Gets or sets whether to preserve the INCLUDEPICTURE field when reading Microsoft Word formats. The default value is `false`.
ProgressCallback { get; set; }	Called during loading a document and accepts data about loading progress.
ResourceLoadingCallback { get; set; }	Allows to control how external resources (images, style sheets) are loaded when a document is imported from HTML, MHTML.
SkipPdfImages { get; set; }	Gets or sets the flag indicating whether images must be skipped while loading PDF document. Default is `false`.
TempFolder { get; set; }	Allows to use temporary files when reading document. By default this property is `null` and no temporary files are used.
UpdateDirtyFields { get; set; }	Specifies whether to update the fields with the `dirty` attribute.
UseSystemLcid { get; set; }	Gets or sets whether to use LCID value obtained from Windows registry to determine page setup default margins.
WarningCallback { get; set; }	Called during a load operation, when an issue is detected that might result in data or formatting fidelity loss.

Methods

Name	Description
override Equals(object)	Determines whether the specified object is equal in value to the current object.

Examples

Shows how to skip images during loading PDF files.

PdfLoadOptions options = new PdfLoadOptions();
options.SkipPdfImages = isSkipPdfImages;
options.PageIndex = 0;
options.PageCount = 1;

Document doc = new Document(MyDir + "Images.pdf", options);
NodeCollection shapeCollection = doc.GetChildNodes(NodeType.Shape, true);

if (isSkipPdfImages)
    Assert.AreEqual(shapeCollection.Count, 0);
else
    Assert.AreNotEqual(shapeCollection.Count, 0);