| INativeOutputSettingsAwareGetProposedOutputFileInfo Method |
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.
Namespace: Sdl.FileTypeSupport.Framework.NativeApiAssembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2551.0)
Syntaxvoid GetProposedOutputFileInfo(
IPersistentFileConversionProperties fileProperties,
IOutputFileInfo proposedFileInfo
)
Sub GetProposedOutputFileInfo (
fileProperties As IPersistentFileConversionProperties,
proposedFileInfo As IOutputFileInfo
)
void GetProposedOutputFileInfo(
IPersistentFileConversionProperties^ fileProperties,
IOutputFileInfo^ proposedFileInfo
)
abstract GetProposedOutputFileInfo :
fileProperties : IPersistentFileConversionProperties *
proposedFileInfo : IOutputFileInfo -> unit
Parameters
- fileProperties
- Type: Sdl.FileTypeSupport.Framework.NativeApiIPersistentFileConversionProperties
- proposedFileInfo
- Type: Sdl.FileTypeSupport.Framework.NativeApiIOutputFileInfo
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.
See Also
Comments