Click or drag to resize
MergedProjectFile Class
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.
Inheritance Hierarchy

Namespace: Sdl.ProjectAutomation.Core
Assembly: Sdl.ProjectAutomation.Core (in Sdl.ProjectAutomation.Core.dll) Version: 3.0.0.0 (3.1.5799.0)
Syntax
public class MergedProjectFile : ProjectFile

The MergedProjectFile type exposes the following members.

Constructors
  NameDescription
Public methodMergedProjectFile
Default constructor.
Top
Properties
  NameDescription
Public propertyAnalysisStatistics
Gets the analysis statistics for this file. Returns null if this is not a translatable file. For source-language files, returns the word count statistics only. For target-language files, returns the full translation provider analysis statistics. Note that you need to run the AnalyzeFiles or WordCount tasks to generate these statistics.
(Inherited from ProjectFile.)
Public propertyBilingualReferenceFileLocalPath
Gets the path of the bilingual reference file associated with this file (Previously translated version of the file). Thi is required for Perfect Match operations.
(Inherited from ProjectFile.)
Public propertyCheckedOutAt
The date the file was checked or null if not checked out when shared on a project server
(Inherited from ProjectFile.)
Public propertyCheckedOutTo
The user that the file is checked out to if shared on a project server
(Inherited from ProjectFile.)
Public propertyChildFiles
Gets the translatable files this merged file consists of.
Public propertyConfirmationStatistics
Gets the confirmation statistics for this file. Returns null if this is not a translatable file. Note that you need to run the TranslationCount task to generate these statistics.
(Inherited from ProjectFile.)
Public propertyCurrentServerVersion
The version of this file stored in the local file system
(Inherited from ProjectFile.)
Public propertyFileTypeId
Gets the File Type Identifier of the file type that will be used to process this file. This is only relevant for translatable files (where Role equals Translatable) and is set by the Scan task (see Scan.
(Inherited from ProjectFile.)
Public propertyFolder
Gets the logical project folder in which this file resides.
(Inherited from ProjectFile.)
Public propertyId
Gets the unique ID of the file.
(Inherited from ProjectFile.)
Public propertyIsCheckedOut
Set to true when the file has been checked out for editing by any user when shared on a project server
(Inherited from ProjectFile.)
Public propertyIsCheckedOutToAnotherUser
Set to true when the file has been checked out by any user other than the current user when shared on a project server
(Inherited from ProjectFile.)
Public propertyIsCheckedOutToMe
Set to true if the file is checked out to the currently logged in user when shared on a project server
(Inherited from ProjectFile.)
Public propertyIsSource
Gets whether this file is a source language or target language file.
(Inherited from ProjectFile.)
Public propertyLanguage
Gets the project language with which this file is associated.
(Inherited from ProjectFile.)
Public propertyLatestServerVersion
The latest version of this file that is stored on the project server
(Inherited from ProjectFile.)
Public propertyLocalFilePath
Returns the local file path where this file resides.
(Inherited from ProjectFile.)
Public propertyLocalFileState
The status of the local file in relation to the file stored on a project server
(Inherited from ProjectFile.)
Public propertyMergeState
Gets the current merge state of the file.
Public propertyName
Gets the file name of the current version of this file.
(Inherited from ProjectFile.)
Public propertyProjectId
Gets the unique ID of the project to which the file belongs.
(Inherited from ProjectFile.)
Public propertyRole
Gets the file role, which indicates how the file should be treated in the project.
(Inherited from ProjectFile.)
Public propertySourceFile
If this is a target language file, gets the corresponding source language file. Returns
null
for source language files.
(Inherited from ProjectFile.)
Public propertyTargetFiles
If this is a source language file, returns all the corresponding target language files. Returns null for target language files.
(Inherited from ProjectFile.)
Top
Remarks

To create a merged file, first add all the individual files to the project and subsequently call CreateMergedProjectFile(String, String, Guid) to create the merged file object. initially, the merge state (MergeState) of the file is NotMerged, which indicates that the merged SDLXLIFF file has not actually been created yet. In order to do this, you need to run a "Convert to Bilingual" task after which the merge state changes to Merged.

A merged project file with merge state Merged can be used for all operations any other translatable project file can be used. The operation will then be performed on the merged SDLXLIFF file.

The Generate Target Translation task (GenerateTargetTranslations) will effectively "split" the merged file again and produce all the native target language files. After this has happened, the merge state of the merged file changes to Split. After this point, no operations can be performed on the merged file anymore.

See Also
Community
Edit

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