Interface INativeOutputSettingsAware
This interface needs to be implemented by any components that should be
'aware' of which settings are used when writing native files.
The SetOutputProperties(INativeOutputFileProperties) method will be invoked before the content of each native file is processed.
Namespace: Sdl.FileTypeSupport.Framework.NativeApi
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public interface INativeOutputSettingsAwareMethods
GetProposedOutputFileInfo(IPersistentFileConversionProperties, IOutputFileInfo)
Allows a file type component to suggest a file name for the output file to be created. This is called by the framework during generation to provide a suggested default file name (and extension) to the host application's implementation of the output properties provider.
The provided information allows an application to show a properly initialized Save As dialog with a proposed file name and a corresponding file type filter.
Declaration
void GetProposedOutputFileInfo(IPersistentFileConversionProperties fileProperties, IOutputFileInfo proposedFileInfo)Parameters
| Type | Name | Description |
|---|---|---|
| IPersistentFileConversionProperties | fileProperties | |
| IOutputFileInfo | proposedFileInfo | Current proposal for the file name etc. if suggested by a preceding file processor component. The implementation may change the properties of this object to indicate the proposed information. |
Remarks
The framework will call this method for each file type component in the order in which the components are used during generation. Proposals that occur later are always given precedence.
The implementation does not need to supply a full path for the file when suggesting a filename.
The actual output file info that will be used is provided by the framework through the SetOutputProperties(INativeOutputFileProperties) call.
SetOutputProperties(INativeOutputFileProperties)
This method is invoked by the framework before processing content from each native file. The properties passed to this method indicate whether source or target language content will be included in the output. It also communicates other important properties such as the name of the output file to be created and what encoding should be used.
Declaration
void SetOutputProperties(INativeOutputFileProperties properties)Parameters
| Type | Name | Description |
|---|---|---|
| INativeOutputFileProperties | properties |