Interface INativeFileWriter
Interface implemented by components that write to native file formats.
Inherited Members
Namespace: Sdl.FileTypeSupport.Framework.NativeApi
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public interface INativeFileWriter : INativeGenerationContentHandler, IAbstractNativeContentHandler, INativeOutputSettingsAware, IDisposableRemarks
The file writer retrieves information on the output file by implementing the INativeOutputSettingsAware interface. The framework calls SetOutputProperties(INativeOutputFileProperties) before the content is processed, and the INativeOutputFileProperties object that is passed to this method contains the name of the output file to create, its preferred codepage, etc.
Properties
LocationTracker
The framework will set this property as part of initialization. The writer can use this as an easy way to determine locations of specific content within the native input stream.
Declaration
INativeLocationTracker LocationTracker { get; set; }Property Value
| Type | Description |
|---|---|
| INativeLocationTracker |
Remarks
The file writer retrieves information on the output file by implementing the INativeOutputSettingsAware interface. The framework calls SetOutputProperties(INativeOutputFileProperties) before the content is processed, and the INativeOutputFileProperties object that is passed to this method contains the name of the output file to create, its preferred codepage, etc.
MessageReporter
The framework will set this property as part of initialization for the component. The component can use this instance to report potential issues and non-fatal error conditions.
Declaration
INativeTextLocationMessageReporter MessageReporter { get; set; }Property Value
| Type | Description |
|---|---|
| INativeTextLocationMessageReporter |
Remarks
The file writer retrieves information on the output file by implementing the INativeOutputSettingsAware interface. The framework calls SetOutputProperties(INativeOutputFileProperties) before the content is processed, and the INativeOutputFileProperties object that is passed to this method contains the name of the output file to create, its preferred codepage, etc.