ChmLoadOptions.OriginalFileName

ChmLoadOptions OriginalFileName property. The name of the CHM file. Default value is null.

ChmLoadOptions.OriginalFileName property

The name of the CHM file. Default value is null.

public string OriginalFileName { get; set; }

Remarks

CHM documents may contain links that reference the same document by file name. Wordize supports such links and normally uses original document file name to check whether the file referenced by a link is the file that is being loaded. If a document is loaded from a stream, its original file name should be specified explicitly via this property, since it cannot be determined automatically.

If a CHM document is loaded from a file and a non-null value for this property is specified, the value will take priority over the actual name of the file name.

Examples

Shows how to resolve URLs like ms-its:myfile.chm::/index.htm.

// The 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.
// It is required to define the original filename in ChmLoadOptions to avoid this behavior.
ChmLoadOptions loadOptions = new ChmLoadOptions() { OriginalFileName = "amhelp.chm" };
MemoryStream chmStream = new MemoryStream(File.ReadAllBytes(MyDir + "Document with ms-its links.chm"));

Converter.Create()
    .From(chmStream, loadOptions)
    .To(ArtifactsDir + "TestChmLoadOptions.OriginalFileName.html")
    .Execute();

ChmLoadOptions.OriginalFileName