Interface INativeSubContentGenerator
Manages the Writer used to create the native file as well as a set of INativeExtractionContentProcessor components that process the input before it is passed to the writer.
The input is received on the Input content handler.
Namespace: Sdl.FileTypeSupport.Framework.NativeApi
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public interface INativeSubContentGeneratorRemarks
Used with other components in a IFileExtractor to write a native file.
Properties
ContentProcessors
The content processors that act on the input content before it is passed to the writer, in the order in which they will be invoked.
Use AddProcessor(INativeGenerationContentProcessor), InsertProcessor(Int32, INativeGenerationContentProcessor), and RemoveProcessor(INativeGenerationContentProcessor) to modify the collection.
Declaration
IEnumerable<INativeGenerationContentProcessor> ContentProcessors { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<INativeGenerationContentProcessor> |
Remarks
Used with other components in a IFileExtractor to write a native file.
Input
This is the content handler that is used to drive the native file writer with its content processors.
Declaration
INativeGenerationContentHandler Input { get; }Property Value
| Type | Description |
|---|---|
| INativeGenerationContentHandler |
Remarks
Usually, it is the first content processor, or the actual file writer instance if no content processors exist.
If no content processors or file writer have been defined, this property
may be null.
Writer
The file writer that creates the final output.
Declaration
INativeFileWriter Writer { get; set; }Property Value
| Type | Description |
|---|---|
| INativeFileWriter |
Remarks
This property can be null, in which case content will still
be processed, but no output should be generated.
Methods
AddProcessor(INativeGenerationContentProcessor)
Appends a native processor that will be invoked before the writer.
Declaration
void AddProcessor(INativeGenerationContentProcessor processor)Parameters
| Type | Name | Description |
|---|---|---|
| INativeGenerationContentProcessor | processor |
Remarks
Used with other components in a IFileExtractor to write a native file.
InsertProcessor(Int32, INativeGenerationContentProcessor)
Inserts a native processor at the specified index in the list of native processors.
Declaration
void InsertProcessor(int index, INativeGenerationContentProcessor processor)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | index | |
| INativeGenerationContentProcessor | processor |
Remarks
Used with other components in a IFileExtractor to write a native file.
RemoveProcessor(INativeGenerationContentProcessor)
Removes a native processor from the list.
Declaration
bool RemoveProcessor(INativeGenerationContentProcessor processor)Parameters
| Type | Name | Description |
|---|---|---|
| INativeGenerationContentProcessor | processor |
Returns
| Type | Description |
|---|---|
| Boolean |
Remarks
Used with other components in a IFileExtractor to write a native file.