Search Results for

    Show / Hide Table of Contents

    Interface INativeFileWriter

    Interface implemented by components that write to native file formats.

    Inherited Members
    INativeGenerationContentHandler.ParagraphUnitStart(IParagraphUnitProperties)
    INativeGenerationContentHandler.ParagraphUnitEnd()
    INativeGenerationContentHandler.SegmentStart(ISegmentPairProperties)
    INativeGenerationContentHandler.SegmentEnd()
    IAbstractNativeContentHandler.StructureTag(IStructureTagProperties)
    IAbstractNativeContentHandler.InlineStartTag(IStartTagProperties)
    IAbstractNativeContentHandler.InlineEndTag(IEndTagProperties)
    IAbstractNativeContentHandler.InlinePlaceholderTag(IPlaceholderTagProperties)
    IAbstractNativeContentHandler.Text(ITextProperties)
    IAbstractNativeContentHandler.ChangeContext(IContextProperties)
    IAbstractNativeContentHandler.CustomInfo(ICustomInfoProperties)
    IAbstractNativeContentHandler.LocationMark(LocationMarkerId)
    IAbstractNativeContentHandler.LockedContentStart(ILockedContentProperties)
    IAbstractNativeContentHandler.LockedContentEnd()
    IAbstractNativeContentHandler.RevisionStart(IRevisionProperties)
    IAbstractNativeContentHandler.RevisionEnd()
    IAbstractNativeContentHandler.CommentStart(ICommentProperties)
    IAbstractNativeContentHandler.CommentEnd()
    IAbstractNativeContentHandler.ParagraphComments(ICommentProperties)
    INativeOutputSettingsAware.SetOutputProperties(INativeOutputFileProperties)
    INativeOutputSettingsAware.GetProposedOutputFileInfo(IPersistentFileConversionProperties, IOutputFileInfo)
    System.IDisposable.Dispose()
    Namespace: Sdl.FileTypeSupport.Framework.NativeApi
    Assembly: Sdl.FileTypeSupport.Framework.Core.dll
    Syntax
    public interface INativeFileWriter : INativeGenerationContentHandler, IAbstractNativeContentHandler, INativeOutputSettingsAware, IDisposable
    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.

    Properties

    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.

    Declaration
    INativeLocationTracker LocationTracker { get; set; }
    Property Value
    Type Description
    INativeLocationTracker

    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.

    Declaration
    INativeTextLocationMessageReporter MessageReporter { get; set; }
    Property Value
    Type Description
    INativeTextLocationMessageReporter

    On this page

    • Properties
      • LocationTracker
      • MessageReporter
    Back to top Generated by DocFX