Class AbstractNativeExtractionGenerationContentProcessor

Base class for components that are intended to be used as native content processors, either for extraction or generation. Implements both interfaces, and stores the output variable as an IAbstractNativeContentHandler. The strongly typed handlers can be set and accessed through the ExtractionOutput and GenerationOutput properties, which both reference the same field as the Output property.

Inheritance
Object
AbstractNativeFileTypeComponent
AbstractNativeExtractionGenerationContentProcessor
LineNumberTracker
Implements
Inherited Members
Object.ToString()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: Sdl.FileTypeSupport.Framework.NativeApi
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public abstract class AbstractNativeExtractionGenerationContentProcessor : AbstractNativeFileTypeComponent, INativeFileTypeComponent, INativeContentStreamMessageReporter, IBasicMessageReporter, INativeExtractionContentProcessor, INativeExtractionContentHandler, INativeGenerationContentProcessor, INativeGenerationContentHandler, IAbstractNativeContentHandler

Constructors

AbstractNativeExtractionGenerationContentProcessor()

Protected constructor used by derived classes

Declaration
protected AbstractNativeExtractionGenerationContentProcessor()

Properties

ExtractionOutput

Strongly typed output content handler that can be used when the buffer is used for extraction.

Declaration
public virtual INativeExtractionContentHandler ExtractionOutput { get; set; }
Property Value
Type Description
INativeExtractionContentHandler
Remarks

Accesses the very same object instance as the Output and the GenerationOutput properties.

GenerationOutput

Strongly typed output content handler that can be used when the buffer is used for generation.

Declaration
public virtual INativeGenerationContentHandler GenerationOutput { get; set; }
Property Value
Type Description
INativeGenerationContentHandler
Remarks

Accesses the very same object instance as the Output and the GenerationOutput properties.

Output

Agnostic access to the output handler; accesses the very same object instance as the ExtractionOutput and the GenerationOutput properties.

Declaration
public virtual IAbstractNativeContentHandler Output { get; set; }
Property Value
Type Description
IAbstractNativeContentHandler

Methods

ChangeContext(IContextProperties)

Calls ChangeContext(IContextProperties) on the Output (if set).

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

CommentEnd()

Calls CommentEnd() on the Output.

Declaration
public virtual void CommentEnd()

CommentStart(ICommentProperties)

Calls CommentStart(ICommentProperties) on the Output.

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

The comment properties.

CustomInfo(ICustomInfoProperties)

Calls CustomInfo(ICustomInfoProperties) on the Output (if set).

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

InlineEndTag(IEndTagProperties)

Calls InlineEndTag(IEndTagProperties) on the Output (if set).

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

InlinePlaceholderTag(IPlaceholderTagProperties)

Calls InlinePlaceholderTag(IPlaceholderTagProperties) on the Output (if set).

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

InlineStartTag(IStartTagProperties)

Calls InlineStartTag(IStartTagProperties) on the Output (if set).

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

LocationMark(LocationMarkerId)

Calls LocationMark(LocationMarkerId) on the Output (if set).

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

LockedContentEnd()

Calls LockedContentEnd() on the Output.

Declaration
public virtual void LockedContentEnd()

LockedContentStart(ILockedContentProperties)

Calls LockedContentStart(ILockedContentProperties) on the Output.

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

ParagraphComments(ICommentProperties)

Calls ParagraphComments(ICommentProperties) on the Output.

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

The commnet properties.

ParagraphUnitEnd()

Calls ParagraphUnitEnd() on the GenerationOutput (if set).

Declaration
public virtual void ParagraphUnitEnd()

ParagraphUnitStart(IParagraphUnitProperties)

Calls ParagraphUnitStart(IParagraphUnitProperties) on the GenerationOutput (if set).

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

RevisionEnd()

Calls RevisionEnd() on the Output.

Declaration
public virtual void RevisionEnd()

RevisionStart(IRevisionProperties)

Calls RevisionStart(IRevisionProperties) on the Output.

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

The revision properties.

SegmentEnd()

Calls SegmentEnd() on the GenerationOutput (if set).

Declaration
public virtual void SegmentEnd()

SegmentStart(ISegmentPairProperties)

Calls SegmentStart(ISegmentPairProperties) on the GenerationOutput (if set).

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

StructureTag(IStructureTagProperties)

Calls StructureTag(IStructureTagProperties) on the Output (if set).

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

Text(ITextProperties)

Calls Text(ITextProperties) on the Output (if set).

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

Explicit Interface Implementations

INativeExtractionContentProcessor.Output

Redirected to ExtractionOutput

Declaration
INativeExtractionContentHandler INativeExtractionContentProcessor.Output { get; set; }
Returns
Type Description
INativeExtractionContentHandler

INativeGenerationContentProcessor.Output

Redirected to GenerationOutput

Declaration
INativeGenerationContentHandler INativeGenerationContentProcessor.Output { get; set; }
Returns
Type Description
INativeGenerationContentHandler

Implements