Click or drag to resize
IBilingualDocumentFileWriter Interface
Bilingual writer that can write an entire bilingual document (potentially consisting of content from multiple native files) to a single output file.

Namespace: Sdl.FileTypeSupport.Framework.BilingualApi
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2551.0)
Syntax
public interface IBilingualDocumentFileWriter : IBilingualDocumentWriter, 
	IBilingualWriter, IBilingualContentHandler, IDisposable, IBilingualDocumentOutputPropertiesAware

The IBilingualDocumentFileWriter type exposes the following members.

Methods
  NameDescription
Public methodComplete
Called by the framework when all content has been processed. At this point it is safe to assume that the document properties will not change any further.
(Inherited from IBilingualContentHandler.)
Public methodFileComplete
Called by the framework after all trans units in a file have been processed by all components. At this point it is safe to assume that the file properties will not change any further.
(Inherited from IBilingualContentHandler.)
Public methodGetProposedFileInfo
Called by the framework to collect input for the name of the intermediate bilingual document file to be generated.
(Inherited from IBilingualDocumentOutputPropertiesAware.)
Public methodInitialize
The framework will call this method to provide the implementation with a reference to the document properties for the document being processed. This method will always be called, and always before any other calls are made on this interface. This or other content processor implementations may modify the document properties as part of the document processing. If you need to access the final version of the document properties, you should do so through the Complete method implementation.
(Inherited from IBilingualContentHandler.)
Public methodProcessParagraphUnit
The framework will call this method for each ParagraphUnit in the file.
(Inherited from IBilingualContentHandler.)
Public methodSetFileProperties
The framework will call this method to provide the implementation with a reference to the properties for each file in the document before the ParagraphUnits of the file are processed. This or other content processor implementations may modify the properties as part of the file processing. If you need to access the final version of the file properties, you should do so through the FileComplete method implementation.
(Inherited from IBilingualContentHandler.)
Public methodSetOutputProperties
Called by the framework to communicate the output properties before processing starts.
(Inherited from IBilingualDocumentOutputPropertiesAware.)
Top
Remarks

This interface is implemented by writers for intermediate bilingual file formats such as SDL XLIFF.

Writers that implement this interface will be treated differently from regular bilingual writers by the framework. Normal bilingual writers are designed to write output that originates from a single input file (even if that file is in bilingual format such as TTX or ITD), while bilingual document writers are designed to write output that can originate form multiple input files.

See Also
Community
Edit

Be the first to Edit the community content of this topic.
Comments