| ISubContentExtractor Interface |
Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi
The ISubContentExtractor type exposes the following members.
| Name | Description | |
|---|---|---|
| AddBilingualProcessor |
Appends a bilingual content processor to the container.
(Inherited from IBilingualProcessorContainer.) | |
| GetBilingualProcessors |
The content processors, in the order in which they will be invoked
(Inherited from IBilingualProcessorContainer.) | |
| GetParser |
Gets the native or bilingual parser
| |
| InsertBilingualProcessor |
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.) | |
| Parse |
Reads the entire content of the input file.
| |
| ParseNext |
Reads the next piece of content from the input file.
| |
| RemoveBilingualProcessor | (Inherited from IBilingualProcessorContainer.) |
| Name | Description | |
|---|---|---|
| AllComponents |
Called by the framework during component initialization to detect and initialize
parser components that implement special interfaces such as ISharedObjectsAware.
| |
| BilingualParser |
Parser for reading a bilingual input file, or null to read native input files.
| |
| DocumentInfo |
Common document properties communicated to all bilingual file type components
| |
| FileConversionProperties |
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.
| |
| FileRestriction |
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.) | |
| FileTypeDefinition |
The framework sets this property for components that are
instantiated from a file type definition.
(Inherited from IFileTypeDefinitionAware.) | |
| ItemFactory |
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.
| |
| NativeSubContentExtractor |
Used for reading a native input file.
| |
| Output |
This object (if not null) receives calls that represent the
output from the file reading process.
| |
| ParagraphUnitRestriction |
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.) | |
| SettingsBundle |
Settings used by processing components in the extractor
| |
| ToBilingualConverter |
The component used to convert native input to bilingual content
|
| Name | Description | |
|---|---|---|
| Message |
Raised when a message is reported from a file type component.
| |
| ProcessSubContent |
Fired when sub-content needs to be processed
| |
| Progress |
Fired when progress is reported from the parser.
|