Search Results for

    Show / Hide Table of Contents

    Class AbstractNativeFileTypeComponent

    Convenient base class for implementing file type components.

    Holds data members that are supplied by the framework during initialization.

    Inheritance
    System.Object
    AbstractNativeFileTypeComponent
    AbstractNativeExtractionContentProcessor
    AbstractNativeExtractionGenerationContentProcessor
    AbstractNativeFileParser
    AbstractNativeGenerationContentProcessor
    Implements
    INativeFileTypeComponent
    INativeContentStreamMessageReporter
    IBasicMessageReporter
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Sdl.FileTypeSupport.Framework.NativeApi
    Assembly: Sdl.FileTypeSupport.Framework.Core.dll
    Syntax
    public abstract class AbstractNativeFileTypeComponent : INativeFileTypeComponent, INativeContentStreamMessageReporter, IBasicMessageReporter
    Remarks

    For convenience, implements INativeContentStreamMessageReporter, the implementation relays calls to the MessageReporter property if it is not null.

    Constructors

    AbstractNativeFileTypeComponent()

    Protected default constructor, should only be called by derived classes.

    Declaration
    protected AbstractNativeFileTypeComponent()

    Properties

    MessageReporter

    The message reporter to be used for reporting non-critical issues.

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

    Critical issues should throw exceptions.

    PropertiesFactory

    The factory used to create native properties objects

    Declaration
    public virtual IPropertiesFactory PropertiesFactory { get; set; }
    Property Value
    Type Description
    IPropertiesFactory

    Methods

    ReportMessage(Object, String, ErrorLevel, String, LocationMarkerId, LocationMarkerId)

    Calls the corresponding method on the message reporter property.

    Declaration
    public void ReportMessage(object source, string origin, ErrorLevel level, string message, LocationMarkerId fromLocation, LocationMarkerId uptoLocation)
    Parameters
    Type Name Description
    System.Object source
    System.String origin

    The description of the action/component from which this message originates.

    ErrorLevel level
    System.String message
    LocationMarkerId fromLocation
    LocationMarkerId uptoLocation

    ReportMessage(Object, String, ErrorLevel, String, String)

    Calls the corresponding method on the message reporter property.

    Declaration
    public void ReportMessage(object source, string origin, ErrorLevel level, string message, string locationDescription)
    Parameters
    Type Name Description
    System.Object source
    System.String origin

    The description of the action/component from which this message originates.

    ErrorLevel level
    System.String message
    System.String locationDescription

    Implements

    INativeFileTypeComponent
    INativeContentStreamMessageReporter
    IBasicMessageReporter

    On this page

    • Constructors
      • AbstractNativeFileTypeComponent()
    • Properties
      • MessageReporter
      • PropertiesFactory
    • Methods
      • ReportMessage(Object, String, ErrorLevel, String, LocationMarkerId, LocationMarkerId)
      • ReportMessage(Object, String, ErrorLevel, String, String)
    • Implements
    Back to top Generated by DocFX