Class AbstractNativeFileWriter

Abstract base class that can be used to build native file writers.

Deriving your file writer from this class takes care of some of the basics of implementing file writer interfaces.

This class possesses a default implementation of the INativeGenerationContentHandler interface, which does nothing. Simply override the methods that are useful for your implementation to process the relevant content in your derived class.

This class also implements the INativeOutputSettingsAware, and provides access to the output properties through the OutputProperties property.

Inheritance
object
AbstractNativeFileWriter
AbstractNativePreviewFileWriter
Inherited Members
Namespace: SdlSdl.FileTypeSupportFrameworkNativeApi
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public abstract class AbstractNativeFileWriter : INativeFileWriter, INativeGenerationContentHandler, IAbstractNativeContentHandler, INativeOutputSettingsAware, IDisposable

Constructors

AbstractNativeFileWriter()

Default constructor

Declaration
protected AbstractNativeFileWriter()

Properties

LocationTracker

Default implementation, stores this information in a field

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

MessageReporter

Accessor to the message reporter set by the framework

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

OutputProperties

The output properties that were passed to SetOutputProperties(INativeOutputFileProperties) by the framework.

Declaration
public virtual INativeOutputFileProperties OutputProperties { get; protected set; }
Property Value
Type Description
INativeOutputFileProperties

Methods

ChangeContext(IContextProperties)

Default implementation, does nothing

Declaration
public virtual void ChangeContext(IContextProperties contexts)
Parameters
Type Name Description
IContextProperties contexts

CommentEnd()

Default implementation, does nothing.

Declaration
public virtual void CommentEnd()

CommentStart(ICommentProperties)

Default implementation, does nothing.

Declaration
public virtual void CommentStart(ICommentProperties commentInfo)
Parameters
Type Name Description
ICommentProperties commentInfo

CustomInfo(ICustomInfoProperties)

Default implementation, does nothing

Declaration
public virtual void CustomInfo(ICustomInfoProperties info)
Parameters
Type Name Description
ICustomInfoProperties info

Dispose()

Implements IDisposable. Just calls Dispose saying that this is an explicit disposal and tells the GC not to call the Finalizer.

Declaration
public void Dispose()

Dispose(bool)

Last change for the Parser to dispose manage and unmanged objects. It can be overriden by subclases.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

indicates if the dispose is explicit or implicit (from GC)

~AbstractNativeFileWriter()

The distructor just calls Dispose with false parameter specifying this is a cakl from GC.

Declaration
protected ~AbstractNativeFileWriter()

GetProposedOutputFileInfo(IPersistentFileConversionProperties, IOutputFileInfo)

Default implementation, does nothing

Declaration
public virtual void GetProposedOutputFileInfo(IPersistentFileConversionProperties fileProperties, IOutputFileInfo proposedFileInfo)
Parameters
Type Name Description
IPersistentFileConversionProperties fileProperties
IOutputFileInfo proposedFileInfo

InlineEndTag(IEndTagProperties)

Default implementation, does nothing

Declaration
public virtual void InlineEndTag(IEndTagProperties tagInfo)
Parameters
Type Name Description
IEndTagProperties tagInfo

InlinePlaceholderTag(IPlaceholderTagProperties)

Default implementation, does nothing

Declaration
public virtual void InlinePlaceholderTag(IPlaceholderTagProperties tagInfo)
Parameters
Type Name Description
IPlaceholderTagProperties tagInfo

InlineStartTag(IStartTagProperties)

Default implementation, does nothing

Declaration
public virtual void InlineStartTag(IStartTagProperties tagInfo)
Parameters
Type Name Description
IStartTagProperties tagInfo

LocationMark(LocationMarkerId)

Default implementation, does nothing

Declaration
public virtual void LocationMark(LocationMarkerId markerId)
Parameters
Type Name Description
LocationMarkerId markerId

LockedContentEnd()

Default implementation, does nothing

Declaration
public virtual void LockedContentEnd()

LockedContentStart(ILockedContentProperties)

Default implementation, does nothing

Declaration
public virtual void LockedContentStart(ILockedContentProperties lockedContentInfo)
Parameters
Type Name Description
ILockedContentProperties lockedContentInfo

ParagraphComments(ICommentProperties)

Default implementation, does nothing.

Declaration
public virtual void ParagraphComments(ICommentProperties commentInfo)
Parameters
Type Name Description
ICommentProperties commentInfo

ParagraphUnitEnd()

Default implementation, does nothing

Declaration
public virtual void ParagraphUnitEnd()

ParagraphUnitStart(IParagraphUnitProperties)

Default implementation, does nothing

Declaration
public virtual void ParagraphUnitStart(IParagraphUnitProperties properties)
Parameters
Type Name Description
IParagraphUnitProperties properties

RevisionEnd()

Default implementation, does nothing.

Declaration
public virtual void RevisionEnd()

RevisionStart(IRevisionProperties)

Default implementation, does nothing.

Declaration
public virtual void RevisionStart(IRevisionProperties revisionInfo)
Parameters
Type Name Description
IRevisionProperties revisionInfo

SegmentEnd()

Default implementation, does nothing

Declaration
public virtual void SegmentEnd()

SegmentStart(ISegmentPairProperties)

Default implementation, does nothing

Declaration
public virtual void SegmentStart(ISegmentPairProperties properties)
Parameters
Type Name Description
ISegmentPairProperties properties

SetOutputProperties(INativeOutputFileProperties)

Default implementation, stores the output properties

Declaration
public virtual void SetOutputProperties(INativeOutputFileProperties properties)
Parameters
Type Name Description
INativeOutputFileProperties properties

StructureTag(IStructureTagProperties)

Default implementation, does nothing

Declaration
public virtual void StructureTag(IStructureTagProperties tagInfo)
Parameters
Type Name Description
IStructureTagProperties tagInfo

Text(ITextProperties)

Default implementation, does nothing

Declaration
public virtual void Text(ITextProperties textInfo)
Parameters
Type Name Description
ITextProperties textInfo

Implements