Click or drag to resize
IFileExtractor Interface
Represents a native parser with native components (or a bilingual parser) and bilingual content processors used when reading native or bilingual file.

Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2551.0)
Syntax
public interface IFileExtractor : IBilingualProcessorContainer, 
	IFileTypeDefinitionAware

The IFileExtractor type exposes the following members.

Properties
  NameDescription
Public propertyAllComponents
Called by the framework during component initialization to detect and initialize parser components that implement special interfaces such as ISharedObjectsAware.
Public propertyBilingualParser
Parser for reading a bilingual input file, or null to read native input files.
Public propertyDocumentInfo
Common document properties communicated to all bilingual file type components
Public propertyFileConversionProperties
This object will be passed to each of the file type components during initialization. Ensure that this property is configured properly before calling Parse. File type components may change these properties, e.g. to store dynamic settings. To ensure that such settings are preserved for future conversion operations, these properties should be retrieved after successful parsing, and stored for re-use e.g. by persisting them to the bilingual file format.
Public propertyFileRestriction
This delegate will be invoked for each file to be processed. If the delegate returns true, the file will be processed as normal, but if it returns false, the file will be skipped.
(Inherited from IBilingualProcessorContainer.)
Public propertyFileTweakers
The file tweakers that are currently used by the extractor, in the order in which they will be invoked.
Public propertyFileTypeDefinition
The framework sets this property for components that are instantiated from a file type definition.
(Inherited from IFileTypeDefinitionAware.)
Public propertyItemFactory
The framework will set this property as part of the initialization. Bilingual components should use this factory to create any items that are inserted in the bilingual content model.
Public propertyNativeExtractor
Used for reading a native input file.
Public propertyOutput
This object (if not null) receives calls that represent the output from the file reading process.
Public propertyParagraphUnitRestriction
If set, this delegate will be invoked for each paragraph unit to be processed. If the delegate returns true, the paragraph unit will be processed as normal. If it returns false, the paragraph unit will be skipped.
(Inherited from IBilingualProcessorContainer.)
Public propertySettingsBundle
Settings used by processing components in the extractor
Public propertyToBilingualConverter
The component used to convert native input to bilingual content
Top
Methods
  NameDescription
Public methodAddBilingualProcessor
Appends a bilingual content processor to the container.
(Inherited from IBilingualProcessorContainer.)
Public methodAddFileTweaker
Append a file tweaker to modify the input file before parsing.
Public methodGetBilingualProcessors
The content processors, in the order in which they will be invoked
(Inherited from IBilingualProcessorContainer.)
Public methodInsertBilingualProcessor
Inserts a bilingual processor at a specified position in the container. Any item that is currently occupying that position will - after this operation - appear after the inserted processor.
(Inherited from IBilingualProcessorContainer.)
Public methodParse
Reads the entire content of the input file.
Public methodParseNext
Reads the next piece of content from the input file.
Public methodRemoveBilingualProcessor
(Inherited from IBilingualProcessorContainer.)
Public methodRemoveFileTweaker
Remove the specified file tweaker from the extractor.
Top
Events
  NameDescription
Public eventMessage
Raised when a message is reported from a file type component.
Public eventProgress
Fired when progress is reported from the parser.
Top
Remarks
The output from the reading operation consists of calls that are generated on the IBilingualContentHandler instance specified by setting the Output property.
See Also
Community
Edit

Be the first to Edit the community content of this topic.
Comments