IProject Interface

IProject Interface

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

Namespace: Sdl.ProjectAutomation.Core
Assembly: Sdl.ProjectAutomation.Core (in Sdl.ProjectAutomation.Core.dll) Version: 3.0.0.0 (3.1.5799.0)

Syntax

C++

Copy

public interface IProject

Public Interface IProject

public interface class IProject

type IProject =  interface end

The IProject type exposes the following members.

Methods

	Name	Description
	AddBilingualReferenceFile	Associates a bilingual reference file with a particular source file and target language using a BilingualFileMapping
	AddBilingualReferenceFiles	Associates a number of Bilingual reference file to particular source file in a target language using an array of BilingualFileMapping
	AddFiles(String)	Adds a set of files into the project, in the root folder.
	AddFiles(String, String)	Adds a set of files into the project, below a specified project folder.
	AddFolderWithFiles(String, Boolean)	Adds all the files from a folder into the project, in the root folder
	AddFolderWithFiles(String, String, Boolean)	Adds all the files from a folder into the project, below a specified project folder.
	AddNewFileVersion	Adds a new version of the file into the project.
	CreateManualTask(String, String, DateTime, TaskFileInfo)	Creates a manual task. A manual task includes a set of files that is assigned to a user. The created manual task can be used to create a project package using CreateProjectPackage(Guid, String, String, ProjectPackageCreationOptions, EventHandlerProgressEventArgs, EventHandlerMessageEventArgs)
	CreateManualTask(String, String, DateTime, Guid)	Creates a manual task. A manual task includes a set of files that is assigned to a user. The created manual task can be used to create a project package using CreateProjectPackage(Guid, String, String, ProjectPackageCreationOptions, EventHandlerProgressEventArgs, EventHandlerMessageEventArgs)
	CreateMergedProjectFile	Creates a merged file from a number of translatable files in the project. This allows manipulating the content of all the child files within one physical file. For more information, see MergedProjectFile.
	CreateProjectPackage(Guid, String, String, ProjectPackageCreationOptions)	Creates a project package. The package can then be obtained using SavePackageAs(Guid, String).
	CreateProjectPackage(Guid, String, String, ProjectPackageCreationOptions, EventHandlerProgressEventArgs, EventHandlerMessageEventArgs)	Creates a project package. The package can then be obtained using SavePackageAs(Guid, String).
	CreateReturnPackage(Guid, String, String)	Creates a return package from a set of files. The files must all have previously been received as part of a project package in order for the return package to be created.
	CreateReturnPackage(Guid, String, String, EventHandlerProgressEventArgs, EventHandlerMessageEventArgs)	Creates a return package from a set of files. The files must all have previously been received as part of a project package in order for the return package to be created.
	GetAutomaticTask	Retrieves an existing automatic task.
	GetFile	Retrieves the file with specified ID.
	GetManualTask	Retrieves an existing manual task.
	GetProjectInfo	Retrieves information about the project
	GetProjectStatistics	Gets the aggregated analysis, word count and confirmation statistics for all the files in the project. This will not actually compute the statistics, but just return a snapshot of the statistics that where most recently computed. To update the statistics, run the relevant task: WordCount, AnalyzeFiles or TranslationCount.
	GetSettings	Gets the project-level settings.
	GetSettings(Language)	Gets the settings for a specific target language.
	GetSourceLanguageFiles	Retrieves all source language files.
	GetTargetLanguageFiles	Retrieves all target language files.
	GetTargetLanguageFiles(Language)	Retrieves all files for the specified target language.
	GetTermbaseConfiguration	Retrieves all termbase-related settings that are associated with this project.
	GetTranslationProviderConfiguration	Gets the translation provider configuration for this project.
	GetTranslationProviderConfiguration(Language)	Gets the translation provider configuration for the specified target language. If no specific configuration has been specified for the specified target language, this method returns an empty (not null!) configuration.
	ImportReturnPackage(String)	Imports a return package into this project.
	ImportReturnPackage(String, EventHandlerProgressEventArgs, EventHandlerMessageEventArgs)	Imports a return package into this project.
	OpenProjectFileStream	Returns a stream that can be used to save out the latest version of the file.
	RemoveBilingualReferenceFile	Removes a Bilingual reference file from a target project file
	RunAutomaticTask(Guid, String)	Runs an automatic task on a set of files. Automatic task template IDs are defined in AutomaticTaskTemplateIds.
	RunAutomaticTask(Guid, String, EventHandlerTaskStatusEventArgs, EventHandlerTaskMessageEventArgs)	Runs an automatic task on a set of files. Automatic task template IDs are defined in AutomaticTaskTemplateIds. This overload allows event handlers to be specified for task status and message events. These events support cancellation of the task.
	SavePackageAs	Saves out a created project or return package to a specified file location.
	SaveProjectFileAs	Saves out the file to a specified file location.
	SaveTaskReportAs	Saves the task report out to a file, in the specified format
	SetFileRole	Changes the role of the file. A Scan task (Scan) should be run after changing the file role in this way.
	UpdateProject	Updates the project with the new information contained in projectInfo.
	UpdateSettings(ISettingsBundle)	Updates the project-level settings.
	UpdateSettings(Language, ISettingsBundle)	Updates the settings for a specific target language.
	UpdateTermbaseConfiguration	Updates the termbase-related settings for this project.
	UpdateTranslationProviderConfiguration(TranslationProviderConfiguration)	Updates the project-wide translation provider configuration.
	UpdateTranslationProviderConfiguration(Language, TranslationProviderConfiguration)	Updates the translation provider configuration for a specific project target language.

Top

Reference

Sdl.ProjectAutomation.Core Namespace

Community

Edit

Be the first to Edit the community content of this topic.

Comments

Send comments on this topic to https://community.sdl.com/developers/language-developers/