Interface IBilingualDocumentGenerator

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.

Inherited Members

IBilingualProcessorContainer.AddBilingualProcessor(IBilingualContentProcessor)

IBilingualProcessorContainer.InsertBilingualProcessor(Int32, IBilingualContentProcessor)

IBilingualProcessorContainer.RemoveBilingualProcessor(IBilingualContentProcessor)

IBilingualProcessorContainer.GetBilingualProcessors()

IBilingualProcessorContainer.FileRestriction

IBilingualProcessorContainer.ParagraphUnitRestriction

IFileTypeDefinitionAware.FileTypeDefinition

Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public interface IBilingualDocumentGenerator : IBilingualProcessorContainer, IAbstractGenerator, IFileTypeDefinitionAware

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.

Properties

AllComponents

Called by the framework during component initialization to detect and initialize parser components that implement special interfaces such as ISharedObjectsAware.

Declaration

IEnumerable<object> AllComponents { get; }

Property Value

Type	Description
IEnumerable<Object>	All (bilingual) file type components

FileTweakers

The file tweakers used by the generator, in the order in which they will be invoked.

File tweakers should be added using AddFileTweaker(IFilePostTweaker).

Declaration

IEnumerable<IFilePostTweaker> FileTweakers { get; }

Property Value

Type	Description
IEnumerable<IFilePostTweaker>

Input

All content to be processed by the generator is passed through this interface.

Declaration

IBilingualContentHandler Input { get; }

Property Value

Type	Description
IBilingualContentHandler

Writer

The bilingual writer that creates the final output.

Declaration

IBilingualDocumentWriter Writer { get; set; }

Property Value

Type	Description
IBilingualDocumentWriter

Remarks

This property can be null.

Methods

AddFileTweaker(IFilePostTweaker)

Appends a file tweaker that will be used to modify the output file after generating.

Declaration

void AddFileTweaker(IFilePostTweaker tweaker)

Parameters

Type	Name	Description
IFilePostTweaker	tweaker

RemoveFileTweaker(IFilePostTweaker)

Removes the tweaker from the generator.

Declaration

void RemoveFileTweaker(IFilePostTweaker tweakerToRemove)

Parameters

Type	Name	Description
IFilePostTweaker	tweakerToRemove	The file tweaker to remove