| IBilingualDocumentParser Interface |
Parser for intermediate bilingual document formats such as SDL XLIFF,
which are used for persistence of the entire bilingual object model.
Namespace: Sdl.FileTypeSupport.Framework.BilingualApi
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2343.0)
SyntaxThe IBilingualDocumentParser type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
| ParseNext |
This method is called repeatedly by the framework to process the next chunk of input.
The implementation should parse a suitable (preferably not too large) chunk of the input,
and return a boolean value that indicates whether there is more work to be done before this file is
completely parsed.
(Inherited from IParser.) |
Properties| Name | Description | |
|---|---|---|
 | DependencyFileLocator |
If specified, this delegate can be used to locate dependency files that are linked, but missing.
|
| DocumentProperties |
This property is set by the framework before parsing commences.
The instance provided through this property should be initialized
and used by the bilingual parser for the Initialize() call on the
bilingual content processor Output property.
(Inherited from IBilingualParser.) |
| FileRestriction |
This property is set by the framework during initialization.
The delegate will be invoked to determine which files in a multi-file
document should generate output.
|
| ItemFactory |
The framework will set this property as part of initialization.
Bilingual components should use this factory to create any items
that are inserted into the bilingual content model.
(Inherited from IBilingualFileTypeComponent.) |
| MessageReporter |
The framework will set this property as part of initialization.
Bilingual components may use this to report any issues encountered
during processing.
(Inherited from IBilingualFileTypeComponent.) |
| Output |
This property is set by the framework during initialization of the
bilingual parser. The parser should build bilingual content model objects,
and call methods on this interface as appropriate to generate the output.
(Inherited from IBilingualParser.) |
Events| Name | Description | |
|---|---|---|
 | Progress |
The parser fires this event at regular intervals
in order to report the progress so that interested parties can ascertain whether
the parsing process is indeed in progress and has not hung. That way users
get an idea about how fast the parsing job is progressing.
Framework consumers should typically not connect directly to
this event, but rather connect to the corresponding event on the
IFileConverter instance.
(Inherited from IParser.) |
RemarksThis interface should not be implemented by parsers that handle content from a single native input file, even if that content is bilingual (like TTX or ITD). Such parsers should just implement IBilingualParser.
See AlsoReference
CommunityComments