PdfLoadOptions class
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.
Inheritance: PdfLoadOptions → LoadOptions
Constructors
| Name | Description |
|---|---|
| PdfLoadOptions() | The default constructor. |
Properties
| Name | Description |
|---|---|
| base_uri | Gets or sets the string that will be used to resolve relative URIs found in the document into absolute URIs when required. Can be None or empty string. Default is None.(Inherited from LoadOptions) |
| convert_metafiles_to_png | Gets or sets whether to convert metafile(Wmf or Emf) images to Png image format. (Inherited from LoadOptions) |
| convert_shape_to_office_math | Gets or sets whether to convert shapes with EquationXML to Office Math objects. (Inherited from LoadOptions) |
| encoding | 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 None. Default is None.(Inherited from LoadOptions) |
| font_settings | Allows to specify document font settings. (Inherited from LoadOptions) |
| ignore_ole_data | Specifies whether to ignore the OLE data. (Inherited from LoadOptions) |
| language_preferences | Gets language preferences that will be used when document is loading. (Inherited from LoadOptions) |
| load_format | Specifies the format of the document to be loaded. Default is LoadFormat.AUTO. (Inherited from LoadOptions) |
| msw_version | Allows to specify that the document loading process should match a specific MS Word version. Default value is MsWordVersion.WORD2019 (Inherited from LoadOptions) |
| page_count | Gets or sets the number of pages to read. Default is MaxValue which means all pages of the document will be read. |
| page_index | Gets or sets the 0-based index of the first page to read. Default is 0. |
| password | Gets or sets the password for opening an encrypted document. Can be None or empty string. Default is None.(Inherited from LoadOptions) |
| preserve_include_picture_field | Gets or sets whether to preserve the INCLUDEPICTURE field when reading Microsoft Word formats. The default value is False.(Inherited from LoadOptions) |
| progress_callback | Called during loading a document and accepts data about loading progress. (Inherited from LoadOptions) |
| resource_loading_callback | Allows to control how external resources (images, style sheets) are loaded when a document is imported from HTML, MHTML. (Inherited from LoadOptions) |
| skip_pdf_images | Gets or sets the flag indicating whether images must be skipped while loading PDF document. Default is False. |
| temp_folder | Allows to use temporary files when reading document. By default this property is None and no temporary files are used.(Inherited from LoadOptions) |
| update_dirty_fields | Specifies whether to update the fields with the dirty attribute.(Inherited from LoadOptions) |
| use_system_lcid | Gets or sets whether to use LCID value obtained from Windows registry to determine page setup default margins. (Inherited from LoadOptions) |
| warning_callback | Called during a load operation, when an issue is detected that might result in data or formatting fidelity loss. (Inherited from LoadOptions) |
Examples
Shows how to skip images during loading PDF files.
options = aw.loading.PdfLoadOptions()
options.skip_pdf_images = is_skip_pdf_images
options.page_index = 0
options.page_count = 1
doc = aw.Document(file_name=MY_DIR + 'Images.pdf', load_options=options)
shape_collection = doc.get_child_nodes(aw.NodeType.SHAPE, True)
if is_skip_pdf_images:
self.assertEqual(shape_collection.count, 0)
else:
self.assertNotEqual(shape_collection.count, 0)
See Also
- module aspose.words.loading
- class LoadOptions