ChmLoadOptions class
ChmLoadOptions class
Allows to specify additional options when loading CHM document into a Document object. To learn more, visit the Specify Load Options documentation article.
Inheritance: ChmLoadOptions → LoadOptions
Constructors
| Name | Description |
|---|---|
| ChmLoadOptions() | Initializes a new instance of this class with default values. |
Properties
| Name | Description |
|---|---|
| baseUri | 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.(Inherited from LoadOptions) |
| convertMetafilesToPng | Gets or sets whether to convert metafile(Wmf or Emf) images to Png image format. (Inherited from LoadOptions) |
| convertShapeToOfficeMath | 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 null. Default is null.(Inherited from LoadOptions) |
| fontSettings | Allows to specify document font settings. (Inherited from LoadOptions) |
| ignoreOleData | Specifies whether to ignore the OLE data. (Inherited from LoadOptions) |
| languagePreferences | Gets language preferences that will be used when document is loading. (Inherited from LoadOptions) |
| loadFormat | Specifies the format of the document to be loaded. Default is LoadFormat.Auto. (Inherited from LoadOptions) |
| mswVersion | Allows to specify that the document loading process should match a specific MS Word version. Default value is MsWordVersion.Word2019 (Inherited from LoadOptions) |
| originalFileName | The name of the CHM file. Default value is null. |
| password | Gets or sets the password for opening an encrypted document. Can be null or empty string. Default is null.(Inherited from LoadOptions) |
| preserveIncludePictureField | Gets or sets whether to preserve the INCLUDEPICTURE field when reading Microsoft Word formats. The default value is false.(Inherited from LoadOptions) |
| resourceLoadingCallback | Allows to control how external resources (images, style sheets) are loaded when a document is imported from HTML, MHTML. (Inherited from LoadOptions) |
| tempFolder | Allows to use temporary files when reading document. By default this property is null and no temporary files are used.(Inherited from LoadOptions) |
| updateDirtyFields | Specifies whether to update the fields with the dirty attribute.(Inherited from LoadOptions) |
| useSystemLcid | Gets or sets whether to use LCID value obtained from Windows registry to determine page setup default margins. (Inherited from LoadOptions) |
Examples
Shows how to resolve URLs like “ms-its:myfile.chm::/index.htm”.
// Our document contains URLs like "ms-its:amhelp.chm::....htm", but it has a different name,
// so file links don't work after saving it to HTML.
// We need to define the original filename in 'ChmLoadOptions' to avoid this behavior.
let loadOptions = new aw.Loading.ChmLoadOptions();
loadOptions.originalFileName = "amhelp.chm";
let doc = new aw.Document(base.myDir + "Document with ms-its links.chm", loadOptions);
doc.save(base.artifactsDir + "ExChmLoadOptions.originalFileName.html");
See Also
- module Aspose.Words.Loading
- class LoadOptions