Search Results for

    Show / Hide Table of Contents

    Class AbstractFileContentProcessingAutomaticTask

    Inheritance
    System.Object
    AbstractFileContentProcessingAutomaticTask
    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.ProjectAutomation.AutomaticTasks
    Assembly: Sdl.ProjectAutomation.AutomaticTasks.dll
    Syntax
    public abstract class AbstractFileContentProcessingAutomaticTask

    Constructors

    AbstractFileContentProcessingAutomaticTask()

    Declaration
    protected AbstractFileContentProcessingAutomaticTask()

    Properties

    Project

    Declaration
    public IProject Project { get; }
    Property Value
    Type Description
    IProject

    TaskFiles

    Declaration
    public ProjectFile[] TaskFiles { get; }
    Property Value
    Type Description
    ProjectFile[]

    TaskId

    Declaration
    public string TaskId { get; }
    Property Value
    Type Description
    System.String

    Methods

    Cancel(Boolean)

    Declaration
    public virtual void Cancel(bool doRollback)
    Parameters
    Type Name Description
    System.Boolean doRollback

    ConfigureConverter(ProjectFile, IMultiFileConverter)

    Declaration
    protected abstract void ConfigureConverter(ProjectFile projectFile, IMultiFileConverter multiFileConverter)
    Parameters
    Type Name Description
    ProjectFile projectFile
    IMultiFileConverter multiFileConverter

    CreateReport(String, String, String)

    Declaration
    public void CreateReport(string name, string description, string data)
    Parameters
    Type Name Description
    System.String name
    System.String description
    System.String data

    CreateReport(String, String, String, LanguageDirection)

    Declaration
    public void CreateReport(string name, string description, string data, LanguageDirection languageDirection)
    Parameters
    Type Name Description
    System.String name
    System.String description
    System.String data
    LanguageDirection languageDirection

    GetSetting<TSettings>()

    Declaration
    protected TSettings GetSetting<TSettings>()
        where TSettings : ISettingsGroup, new()
    Returns
    Type Description
    TSettings
    Type Parameters
    Name Description
    TSettings

    GetWordCounter(ProjectFile)

    Declaration
    public WordCounter GetWordCounter(ProjectFile projectFile)
    Parameters
    Type Name Description
    ProjectFile projectFile
    Returns
    Type Description
    WordCounter

    OnFileComplete(ProjectFile, IMultiFileConverter)

    Declaration
    public virtual bool OnFileComplete(ProjectFile projectFile, IMultiFileConverter multiFileConverter)
    Parameters
    Type Name Description
    ProjectFile projectFile
    IMultiFileConverter multiFileConverter
    Returns
    Type Description
    System.Boolean

    OnInitializeTask()

    Declaration
    protected virtual void OnInitializeTask()

    ShouldProcessFile(ProjectFile)

    Declaration
    public virtual bool ShouldProcessFile(ProjectFile projectFile)
    Parameters
    Type Name Description
    ProjectFile projectFile
    Returns
    Type Description
    System.Boolean

    TaskComplete()

    Declaration
    public virtual void TaskComplete()

    On this page

    • Constructors
      • AbstractFileContentProcessingAutomaticTask()
    • Properties
      • Project
      • TaskFiles
      • TaskId
    • Methods
      • Cancel(Boolean)
      • ConfigureConverter(ProjectFile, IMultiFileConverter)
      • CreateReport(String, String, String)
      • CreateReport(String, String, String, LanguageDirection)
      • GetSetting<TSettings>()
      • GetWordCounter(ProjectFile)
      • OnFileComplete(ProjectFile, IMultiFileConverter)
      • OnInitializeTask()
      • ShouldProcessFile(ProjectFile)
      • TaskComplete()
    Back to top Generated by DocFX