ExtractionOptions (attached to a FileConvertJob) specifies how embedded images and attachments should be handled.
dtSearch.Engine.ExtractionOptions
C#
public class ExtractionOptions;
Remarks
During conversion, embedded images and attachments can be extracted to a folder, with links to the extracted images and attachments inserted in the output. Example:
dtSearch.Engine.FileConverter conv = new FileConverter();
conv.OutputToString = true;
conv.InputFile = "c:\\docs\\sample.doc";
conv.OutputFormat = OutputFormats.itHTML;
dtSearch.Engine.ExtractionOptions extractionOptions = new dtSearch.Engine.ExtractionOptions();
// This prevents attachments from being created with executable extensions
extractionOptions.AllowedExtensions = "jpg jpeg pdf doc xls ppt zip";
// Attachments with disallowed extensions will have ".data" appended to the output filename
extractionOptions.DefaultExtension = "data";
extractionOptions.OutputLocation = "c:\\output";
extractionOptions.Flags = dtSearch.Engine.ExtractionOptionsFlags.dtsExoExtractAttachments |
dtSearch.Engine.ExtractionOptionsFlags.dtsExoExtractImages |
dtSearch.Engine.ExtractionOptionsFlags.dtsExoLimitExtensions;
extractionOptions.FilenamePrefix = "tmp_";
extractionOptions.OutputReference = extractionOptions.OutputLocation;
extractionOptions.UnnamedAttachmentLinkText = "[Attachment]";
conv.ExtractionOptions = extractionOptions;
conv.Execute();
When highlighting hits, flags should be consistent with the behavior of the indexer or hit highlighting will be inconsistent. To be consistent with indexing behavior:
- dtsExoExtractAttachments should not be used when highlighting hits because in some cases text is added to the conversion output to provide a location for the link to the extracted attachment.
- dtsExoDoNotConvertAttachments should not be used when highlighting hits because the indexer does convert attachments to text.
- dtsExoExtractImages can be used when highlighting hits.
Topics
|
Topic |
Description |
|---|---|
|
The following tables list the members exposed by ExtractionOptions. | |
|
The properties of the ExtractionOptions class are listed here. |
ExtractionOptions Properties
|
ExtractionOptions Properties |
Description |
|---|---|
|
If the dtsExoLimitExtensions flag is set, image and attachment filename extensions will be limited to the values listed in AllowedExtensions. | |
|
Extension to add to images and attachments when the dtsExoLimitExtensions flags is set and an image or attachment has an extension that is not listed in AllowedExtensions. | |
|
Filename prefix for extracted files stored in outputLocation | |
|
ExtractionOptionsFlags value. | |
|
Name of text file to create with the names of all images and attachments extracted to the OutputLocation. | |
|
Output folder for images and attachments extracted from the input file | |
|
URL of the OutputLocation for links in the conversion output. | |
|
Text to use for link to an attachment that has no name |
See Also