Class AbstractFileLevelAutomaticTask

Inheritance

System.Object

AbstractFileLevelAutomaticTask

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 AbstractFileLevelAutomaticTask

Constructors

AbstractFileLevelAutomaticTask()

Declaration

protected AbstractFileLevelAutomaticTask()

Properties

IsCancelRequested

Declaration

public bool IsCancelRequested { get; }

Property Value

Type	Description
System.Boolean

Project

Declaration

public IProject Project { get; }

Property Value

Type	Description
IProject

ShouldAddNewFileVersion

Declaration

public bool ShouldAddNewFileVersion { get; set; }

Property Value

Type	Description
System.Boolean

TaskFiles

Declaration

public ProjectFile[] TaskFiles { get; }

Property Value

Type	Description
ProjectFile[]

Methods

Cancel(Boolean)

Declaration

public virtual void Cancel(bool doRollback)

Parameters

Type	Name	Description
System.Boolean	doRollback

Execute()

Declaration

public virtual void Execute()

OnFileProgress(TaskProgressEventArgs)

Declaration

protected virtual void OnFileProgress(TaskProgressEventArgs e)

Parameters

Type	Name	Description
TaskProgressEventArgs	e

OnInitializeTask()

Declaration

protected virtual void OnInitializeTask()

ProcessFile(ProjectFile)

Declaration

protected abstract void ProcessFile(ProjectFile projectFile)

Parameters

Type	Name	Description
ProjectFile	projectFile

TaskComplete()

Declaration

public virtual void TaskComplete()

UploadFile(ProjectFile, String)

Declaration

protected virtual void UploadFile(ProjectFile projectFile, string localFilePath)

Parameters

Type	Name	Description
ProjectFile	projectFile
System.String	localFilePath

Events

Progress

Declaration

public event EventHandler<TaskProgressEventArgs> Progress

Event Type

Type	Description
System.EventHandler<TaskProgressEventArgs>