Click or drag to resize
IBilingualDocumentGenerator Interface
A set of bilingual content processors together with a bilingual writer that can be used to process the entire content (all files) of a bilingual document.

Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2551.0)
Syntax
public interface IBilingualDocumentGenerator : IBilingualProcessorContainer, 
	IAbstractGenerator, IFileTypeDefinitionAware

The IBilingualDocumentGenerator type exposes the following members.

Properties
  NameDescription
Public propertyAllComponents
Called by the framework during component initialization to detect and initialize parser components that implement special interfaces such as ISharedObjectsAware.
Public propertyFileRestriction
This delegate will be invoked for each file to be processed. If the delegate returns true, the file will be processed as normal, but if it returns false, the file will be skipped.
(Inherited from IBilingualProcessorContainer.)
Public propertyFileTweakers
The file tweakers used by the generator, in the order in which they will be invoked. File tweakers should be added using AddFileTweaker(IFilePostTweaker).
Public propertyFileTypeDefinition
The framework sets this property for components that are instantiated from a file type definition.
(Inherited from IFileTypeDefinitionAware.)
Public propertyInput
All content to be processed by the generator is passed through this interface.
Public propertyParagraphUnitRestriction
If set, this delegate will be invoked for each paragraph unit to be processed. If the delegate returns true, the paragraph unit will be processed as normal. If it returns false, the paragraph unit will be skipped.
(Inherited from IBilingualProcessorContainer.)
Public propertyWriter
The bilingual writer that creates the final output.
Top
Methods
  NameDescription
Public methodAddBilingualProcessor
Appends a bilingual content processor to the container.
(Inherited from IBilingualProcessorContainer.)
Public methodAddFileTweaker
Appends a file tweaker that will be used to modify the output file after generating.
Public methodGetBilingualProcessors
The content processors, in the order in which they will be invoked
(Inherited from IBilingualProcessorContainer.)
Public methodInsertBilingualProcessor
Inserts a bilingual processor at a specified position in the container. Any item that is currently occupying that position will - after this operation - appear after the inserted processor.
(Inherited from IBilingualProcessorContainer.)
Public methodRemoveBilingualProcessor
(Inherited from IBilingualProcessorContainer.)
Public methodRemoveFileTweaker
Removes the tweaker from the generator.
Top
Remarks

The content is passed to the generator in the form of calls on the Input property implementation. Each call will be further processed in turn by each bilingual content processor, and last by the bilingual writer.

See Also
Community
Edit

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