Search Results for

    Show / Hide Table of Contents

    Interface IBilingualProcessorContainer

    Common base interface for components that hold bilingual content processors

    Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi
    Assembly: Sdl.FileTypeSupport.Framework.Core.dll
    Syntax
    public interface IBilingualProcessorContainer

    Properties

    FileRestriction

    This delegate will be invoked for each file to be processed. If the delegate returns true, the file will be processed as normal, but if it returns false, the file will be skipped.

    Declaration
    Predicate<IPersistentFileConversionProperties> FileRestriction { get; set; }
    Property Value
    Type Description
    Predicate<IPersistentFileConversionProperties>
    Remarks

    If the value is null, no file restrictions apply, and all files will be processed.

    This allows content processing to be restricted to individual files in a multi-file document.

    ParagraphUnitRestriction

    If set, this delegate will be invoked for each paragraph unit to be processed. If the delegate returns true, the paragraph unit will be processed as normal. If it returns false, the paragraph unit will be skipped.

    Declaration
    Predicate<IParagraphUnitProperties> ParagraphUnitRestriction { get; set; }
    Property Value
    Type Description
    Predicate<IParagraphUnitProperties>
    Remarks

    This mechanism is used when verifying an individual part of the document.

    Methods

    AddBilingualProcessor(IBilingualContentProcessor)

    Appends a bilingual content processor to the container.

    Declaration
    void AddBilingualProcessor(IBilingualContentProcessor processor)
    Parameters
    Type Name Description
    IBilingualContentProcessor processor
    Remarks

    To add a bilingual content handler (rather than a processor), use a Sdl.FileTypeSupport.Framework.Core.Utilities.BilingualApi.BilingualContentHandlerAdapter.

    GetBilingualProcessors()

    The content processors, in the order in which they will be invoked

    Declaration
    IEnumerable<IBilingualContentProcessor> GetBilingualProcessors()
    Returns
    Type Description
    IEnumerable<IBilingualContentProcessor>

    InsertBilingualProcessor(int, IBilingualContentProcessor)

    Inserts a bilingual processor at a specified position in the container. Any item that is currently occupying that position will - after this operation - appear after the inserted processor.

    Declaration
    void InsertBilingualProcessor(int index, IBilingualContentProcessor processor)
    Parameters
    Type Name Description
    int index

    Must be a value in the range [0 - Count]

    IBilingualContentProcessor processor
    Remarks

    To insert a bilingual content handler (rather than a processor), use a Sdl.FileTypeSupport.Framework.Core.Utilities.BilingualApi.BilingualContentHandlerAdapter.

    RemoveBilingualProcessor(IBilingualContentProcessor)

    Declaration
    bool RemoveBilingualProcessor(IBilingualContentProcessor processor)
    Parameters
    Type Name Description
    IBilingualContentProcessor processor
    Returns
    Type Description
    bool

    True if anything was removed from the collection, otherwise false

    In this article
    • Properties
      • FileRestriction
      • ParagraphUnitRestriction
    • Methods
      • AddBilingualProcessor(IBilingualContentProcessor)
      • GetBilingualProcessors()
      • InsertBilingualProcessor(int, IBilingualContentProcessor)
      • RemoveBilingualProcessor(IBilingualContentProcessor)
    Back to top Generated by DocFX