FileBasedProject Methods |
The FileBasedProject type exposes the following members.
Name | Description | |
---|---|---|
AddBilingualReferenceFile(BilingualFileMapping) |
Associates a bilingual reference file (previously translated version) to a file in the project using a BilingualFileMapping
| |
AddBilingualReferenceFile(Guid, String) |
Associates a bilingual reference file (previously translated version) to a file in the project.
| |
AddBilingualReferenceFiles |
Associates bilingual reference files (previously translated versions) to project files using an array of BilingualFileMapping objects
| |
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.
| |
AddMasterTM |
Set master tm for target language
| |
AddNewFileVersion |
Adds the new file version.
| |
CheckinFiles |
Uploads the specifies including potentially related files that should be uploaded at the same time and checks them in.
| |
CheckoutFiles | ||
Complete |
Change the project status to completed.
| |
CreateFromProjectPackage(String, String, ProjectPackageImport) |
Creates a new project from a project package.
| |
CreateFromProjectPackage(String, String, EventHandlerProgressEventArgs, EventHandlerMessageEventArgs, ProjectPackageImport) |
Creates a new project from a project package.
| |
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.
| |
Delete |
Deletes the project. This deletes the entire project folder.
| |
DeleteFromServer |
Deletes the project from the server
| |
DownloadLatestServerVersion |
Downloads the latest version of a file from the project server.
| |
DownloadSpecificServerVersion |
Downloads a specific version of a file from the server in to the specified location
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetAutomaticTask |
Retrieves an existing automatic task.
| |
GetFile |
Gets the file.
| |
GetFiles |
Gets an array of files from an array of file ids.
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetManualTask |
Retrieves an existing manual task.
| |
GetProjectFileVersionHistory | ||
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.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
ImportReturnPackage(String) |
Imports a return package into this project.
| |
ImportReturnPackage(String, EventHandlerProgressEventArgs, EventHandlerMessageEventArgs) |
Imports a return package into this project.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OpenProjectFileStream |
Returns a stream that can be used to save out the latest version of the file.
| |
PublishProject |
Publish this project to a Groupshare Project Server.
| |
RemoveBilingualReferenceFile |
Removes a bilingual reference file (previously translated version) from a 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.
| |
RunAutomaticTasks(Guid, String) |
Runs a sequence of automatic tasks on a set of project files. This can be more efficient than running tasks
individually using RunAutomaticTask(Guid, String), because content processing tasks can
be executed in parallel. See the comments on AnalyzeFiles for more details.
| |
RunAutomaticTasks(Guid, String, EventHandlerTaskStatusEventArgs, EventHandlerTaskMessageEventArgs) |
Runs a sequence of automatic tasks on a set of project files. This can be more efficient than running tasks
individually using RunAutomaticTask(Guid, String), because content processing tasks can
be executed in parallel. See the comments on AnalyzeFiles for more details.
| |
RunDefaultTaskSequence(Guid) |
Runs the default task sequence of automatic tasks on a set of project files.
| |
RunDefaultTaskSequence(Guid, EventHandlerTaskStatusEventArgs, EventHandlerTaskMessageEventArgs) |
Runs the default task sequence of automatic tasks on a set of project files.
| |
Save |
Persists the project file. The file has extension .sdlproj and is located in the folder given by LocalProjectFolder.
The project file path can be obtained using FilePath.
| |
SavePackageAs |
Saves out the 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.
| |
SynchronizeServerProjectData |
Synchronizes the local project information with the information stored on the server
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
UndoCheckoutFiles |
Removes the lock on server files without changing the version of the file on the server
| |
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.
|