| INativeFileWriter Interface |
Interface implemented by components that write to native file formats.
Namespace: Sdl.FileTypeSupport.Framework.NativeApi
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2551.0)
SyntaxThe INativeFileWriter type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | LocationTracker |
The framework will set this property as part of initialization.
The writer can use this as an easy way to determine locations of specific content
within the native input stream.
|
| MessageReporter |
The framework will set this property as part of initialization for the
component. The component can use this instance to report potential issues
and non-fatal error conditions.
|
Methods| Name | Description | |
|---|---|---|
 | ChangeContext |
Sets or changes translation related context information.
Context changes will most often be associated with structure tags.
Context changes inside text will cause the text to be split into
separate units during translation, which should normally be avoided
(if possible).
(Inherited from IAbstractNativeContentHandler.) |
| CommentEnd |
Used to indicate the end of commented content in the stream.
(Inherited from IAbstractNativeContentHandler.) |
| CommentStart |
Used to indicate that the following content should be treated
as commented content until a matched CommentEnd() call is made.
(Inherited from IAbstractNativeContentHandler.) |
| CustomInfo |
Temporary custom information, which can be used for communication between
native content processing components.
(Inherited from IAbstractNativeContentHandler.) |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
| GetProposedOutputFileInfo |
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.
(Inherited from INativeOutputSettingsAware.)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. |
| InlineEndTag |
Content that is interpreted as the end of a previously emitted start tag.
(Inherited from IAbstractNativeContentHandler.) |
| InlinePlaceholderTag |
Content interpreted as a placeholder that may appear inside text.
Do not use this for method for paired placeholders.
(Inherited from IAbstractNativeContentHandler.) |
| InlineStartTag |
Content that is interpreted as the first of a set of paired tags that may appear
inside text.
(Inherited from IAbstractNativeContentHandler.) |
| LocationMark |
Used with the message reporting mechanism to communicate locations
associated with messages reported using the INativeContentStreamMessageReporter.
(Inherited from IAbstractNativeContentHandler.) |
| LockedContentEnd |
Used to indicate the end of locked content in the stream.
(Inherited from IAbstractNativeContentHandler.) |
| LockedContentStart |
Used to indicate that the following content should be treated
as locked content until a matched EndLockedContent() call is made.
(Inherited from IAbstractNativeContentHandler.) |
| ParagraphComments |
Used to set Paragraph comments to the current paragraph.
(Inherited from IAbstractNativeContentHandler.) |
| ParagraphUnitEnd |
Indicates the location of a paragraph unit boundary in the bilingual
content model.
(Inherited from INativeGenerationContentHandler.) |
| ParagraphUnitStart |
Indicates the location of a paragraph unit boundary in the bilingual
content model.
(Inherited from INativeGenerationContentHandler.) |
| RevisionEnd |
Used to indicate the end of revisioned content in the stream.
(Inherited from IAbstractNativeContentHandler.) |
| RevisionStart |
Used to indicate that the following content should be treated
as revisioned content until a matched RevisionEnd() call is made.
(Inherited from IAbstractNativeContentHandler.) |
| SegmentEnd |
Indicates the location of a segment boundary in the bilingual
content model.
(Inherited from INativeGenerationContentHandler.) |
| SegmentStart |
Indicates the location of a segment boundary in the bilingual
content model.
(Inherited from INativeGenerationContentHandler.) |
| SetOutputProperties |
This method is invoked by the framework before processing content
from each native file. The properties passed to this method
indicate whether source or target language content will be included in the output.
It also communicates other important properties such as the
name of the output file to be created and what encoding should
be used.
(Inherited from INativeOutputSettingsAware.) |
| StructureTag |
Content that is interpreted as a structural tag, i.e. a tag that
does not appear inside translatable text.
(Inherited from IAbstractNativeContentHandler.) |
| Text |
Content that represents translatable text
(Inherited from IAbstractNativeContentHandler.) |
Remarks
The file writer retrieves information on the output file
by implementing the INativeOutputSettingsAware interface.
The framework calls SetOutputProperties(INativeOutputFileProperties) before
the content is processed, and the INativeOutputFileProperties object that is passed to
this method contains the name of the output file to create, its preferred codepage, etc.
See AlsoCommunityComments