Namespace Sdl.ProjectAutomation.Core

Classes

AnalysisBand

Represents a range of translation memory scores between a minimum and maximum match value used to categorize segments in translatable files according to the quality of translation memory match exist in the translation memory.

AnalysisStatistics

This class represents analysis statistics for a section of content.

AutomaticTask

Represents an automatic task which is executing or has finished executing.

AutomaticTaskTemplateIds

This class defines a set of well-known automatic task template IDs, which can be used to pass to RunAutomaticTask(Guid[], String) for running automatic tasks.

BilingualFileMapping

This hold the mapping between a file in the project and a previously translated version in a particular language

ConfirmationStatistics

This class represents confirmation statistics for a single target language file or for all the target language files in a given project target language.

CountData

Represents various summary statistics about a piece of content.

DataTransferEventArgs

Used for tracking progess of file uploads/downloads to and from a project server

ExecutionMessage

Represents a message generated while executing an automatic task (see Messages) or performing a package-related operation (see Messages). The message may be relevant to the entire process or to a specific file (see ProjectFileId).

ExtensionMethods

Useful extension methods

FuzzyCountData

Represents statistics for a piece of content that falls into a particular analysis band.

LocalTermbase

Represents a reference to a local (file-based) termbase that can be added to the TermbaseConfiguration of a project.

ManualTask

Represents a manual task, which is a Task that is assigned to and executed by a user and can be included in a project package if it needs to be performed offline by someone else (CreateProjectPackage(Guid, String, String, ProjectPackageCreationOptions). To create a new manual task, use CreateManualTask(String, String, DateTime, TaskFileInfo[]).

MergedProjectFile

Represents a merged translatable file, which consists of a number of child translatable files. This allows manipulating the content of all the child files within one physical SDLXLIFF file.

MessageEventArgs

Cancelable event args class for callbacks when messages are reported during autoamtic task execution (see RunAutomaticTask(Guid[], String)) or package-related operations (see CreateProjectPackage(Guid, String, String, ProjectPackageCreationOptions) and ImportReturnPackage(String)).

PackageOperation

Base class to represent completed or in progress package operations, such as a package import or export.

PackageStatusEventArgs

Event args class for progress information callbacks while package-related operations are executing. See CreateProjectPackage(Guid, String, String, ProjectPackageCreationOptions, EventHandler<ProgressEventArgs>, EventHandler<MessageEventArgs>) and ImportReturnPackage(String, EventHandler<ProgressEventArgs>, EventHandler<MessageEventArgs>).

ProgressEventArgs

Cancelable event args class for progress information callbacks during automatic task execution (see RunAutomaticTask(Guid[], String)) or during package-related operations (see CreateProjectPackage(Guid, String, String, ProjectPackageCreationOptions) and ImportReturnPackage(String)).

ProjectAutomationException

Exception type for specific project automation exceptions.

ProjectFile

Represents a file in a project.

ProjectFileVersion

Class which holds the version details for a particular file

ProjectInfo

Holds information about a project. This class is used when accessing information about an existing project, and for updating a project with new information. It is also used when creating a new project. Not all properties are supported for project updating.

ProjectPackageCreation

Represents the creation of a project package which is ongoing or has been completed. See CreateProjectPackage(Guid, String, String, ProjectPackageCreationOptions).

ProjectPackageCreationOptions

Represents options that can be passed to CreateProjectPackage(Guid, String, String, ProjectPackageCreationOptions, EventHandler<ProgressEventArgs>, EventHandler<MessageEventArgs>) to control what will be included in a project package.

ProjectPackageImport

Represents the import of a project package. To create a new project from a package, use FileBasedProject.CreateFromProjectPackage.

ProjectReference

Represents a reference to an existing project.

ProjectStatistics

This class represents word count, analysis and confirmation statistics for a project.

ProjectTemplateInfo

Holds information about a project template.

ProjectTemplateReference

Represents a reference to an existing project template.

ReportFormat

Represents a file format to which an automatic task report (see Reports) can be saved (SaveTaskReportAs(Guid, String, ReportFormat)). You cannot create new instances of this class. Rather, use one of the predefined static instances (Excel, Html, Mht or Xml).

ReturnPackageCreation

Represents the creation of a return package from an existing project. To create a return package, call CreateReturnPackage(Guid[], String, String).

ReturnPackageImport

Represents the import of a return package into an existing project. To import a return package, call ImportReturnPackage(String).

ServerTermbase

Represents a reference to a server-based termbase that can be added to the TermbaseConfiguration of a project. A server-based reference is interpreted together with the TermbaseServerUri, which identifies the server on which the termbase is hosted.

TargetLanguageStatistics

This class represents total analysis and confirmation statistics for a single project target language.

Task

Abstract base class which represents common properties of the AutomaticTask and ManualTask classes.

TaskFile

Represents a reference to a ProjectFile that is part of a ManualTask or an AutomaticTask.

TaskFileInfo

Represents the necessary information to create a TaskFile for inclusion in a manual task, consisting of a project file ID and a boolean that indicates whether the file should be included in the task as a read-only file. See CreateManualTask(String, String, DateTime, Guid[]).

TaskMessageEventArgs

An event args class for callbacks when a message is generated during the execution of an automatic task.

TaskReport

This class represents a report that was generated by an automatic task.

TaskStatusEventArgs

Event args class for progress callbacks when running automatic tasks.

Termbase

Abstract base class, representing a reference to a termbase that can be part of a TermbaseConfiguration. The two supported concrete implementations of this class are LocalTermbase and ServerTermbase.

TermbaseConfiguration

This class represents all termbase-related settings that control which termbases are used within a project. To get the termbase configuration of a project, use GetTermbaseConfiguration(). To update the termbase configuration, use UpdateTermbaseConfiguration(TermbaseConfiguration).

TermbaseLanguageIndex

Represents a mapping of a project language (source or target) to a termbase index. The system cannot automatically determine which termbase index to use for a certain project language, since termbase indexes can be named arbitrarily. Termbase index mappings need to be specified in the LanguageIndexes list for all project languages where termbase functionality is required. The mapping of the project source language is required. Project target language mappings are optional; project target languages for which no mapping is specified will be ignored during termbase processing.

TermRecognitionOptions

This class exposes a number of options that affect interactive terminology recognition behavior. Thee options are used in combination with the termbases set up in the TermbaseConfiguration.

TranslationProviderCascadeEntry

This class represents an entry in a translation provider configuration (see Entries), consisting of a main translation provider (MainTranslationProvider), which is generally specified at project creation time and one or more project translation memories (ProjectTranslationMemories which are usually populated automatically by the "Populate Project Translation Memories" batch task as part of project preparation.

TranslationProviderConfiguration

This class represents the configuration settings related to the use of translation providers within a project, including the list of translation providers to use, the project translation memories and in which scenarios to use these translation providers.

TranslationProviderReference

This class represents a reference to a translation provider, represented by a

Uri

and optional provider-specific state information. There is also also an Enabled property which determines whether this translation provider will be used during translation provider operations in project.

WordCountStatistics

This class represents word count statistics for a section of content.

Interfaces

IProject

Represents a project. Provides access to project information and settings, and provides functionality for modifying the project, running tasks etc.

IProjectDeleteOperation

Represents a project operation. Provides access to project information and settings, and provides functionality for deleting the project etc.

Namespace Sdl.ProjectAutomation.Core

Classes

Interfaces

Enums