ILargeEncodedTextExtractor Interface

"Large" encoded text file content extractor.

Definition

Namespace: OpenDiscoverSDK.Interfaces.Extractors
Assembly: OpenDiscoverSDK.Interfaces (in OpenDiscoverSDK.Interfaces.dll) Version: 2026.2.6.0 (2026.02.06)
C#
public interface ILargeEncodedTextExtractor : IContentExtractor, 
	IDisposable
Implements
IContentExtractor, IDisposable

Remarks

"Large" is a subjective term defined by the LargeDocumentCritera property value.

This content extractor interface will not set the ExtractedText property due to the "large" size of the encoded text file.

The only content that this extractor extracts is MD5BinaryHash, SHA1BinaryHash, and SHA256BinaryHash hashes of the document. If ExtractContent(Stream)Stream argument 'textFileOutputStream' is not null, then this content extractor interface will also write the encoded text contents of this file to the supplied stream as either UTF-16 or UTF-8 encoding (which unicode encoding depends on UseLargeDocumentUTF16Encoding).

Writing the original encoded file to a new Stream (SHOULD be FileStream due to "large" size of file) is only really useful if file is not already in a easily indexable unicode encoding.

Properties

ContentExtractorType The derived, actual content extractor interface type.
(Inherited from IContentExtractor)
Length Gets the document's length in bytes.
(Inherited from IContentExtractor)
SupportsChildrenExtraction If true, this content extractor supports attachment, embedded item, or container item extraction.
(Inherited from IContentExtractor)
SupportsDecryption If true, this content extractor supports decrypting password protected documents.
(Inherited from IContentExtractor)
SupportsMetadataExtraction If true, this content extractor supports metadata extraction.
(Inherited from IContentExtractor)
SupportsTextExtraction If true, this content extractor supports text extraction.
(Inherited from IContentExtractor)

Methods

DisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable)
ExtractContent Extracts content from a "large" encoded text file and optionally writes encoded text contents of this file to the supplied stream as either UTF-16 or UTF-8 encoding (which unicode encoding depends on UseLargeDocumentUTF16Encoding).
OverrideContentExtractionSettings Allows for overriding the ContentExtractionSettings object used by a IContentExtractor instance that was returned by a call to OpenDiscoverSDK.ContentExtractorFactory.GetContentExtractor. See remarks for limitations.
(Inherited from IContentExtractor)

Events

ContentExtractionHeartbeat Notification event that lets implementers of IContentExtractor know that content extraction is still under process. See remarks.
(Inherited from IContentExtractor)

See Also