Click or drag to resize
ProjectFile Class
Represents a file in a project.
Inheritance Hierarchy

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

The ProjectFile type exposes the following members.

Constructors
  NameDescription
Public methodProjectFile
Initializes a new instance of the ProjectFile class
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
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.
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.
Public propertyCheckedOutAt
The date the file was checked or null if not checked out when shared on a project server
Public propertyCheckedOutTo
The user that the file is checked out to if shared on a project server
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.
Public propertyCurrentServerVersion
The version of this file stored in the local file system
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.
Public propertyFolder
Gets the logical project folder in which this file resides.
Public propertyId
Gets the unique ID of the file.
Public propertyIsCheckedOut
Set to true when the file has been checked out for editing by any user when shared on a project server
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
Public propertyIsCheckedOutToMe
Set to true if the file is checked out to the currently logged in user when shared on a project server
Public propertyIsSource
Gets whether this file is a source language or target language file.
Public propertyLanguage
Gets the project language with which this file is associated.
Public propertyLatestServerVersion
The latest version of this file that is stored on the project server
Public propertyLocalFilePath
Returns the local file path where this file resides.
Public propertyLocalFileState
The status of the local file in relation to the file stored on a project server
Public propertyName
Gets the file name of the current version of this file.
Public propertyProjectId
Gets the unique ID of the project to which the file belongs.
Public propertyRole
Gets the file role, which indicates how the file should be treated in the project.
Public propertySourceFile
If this is a target language file, gets the corresponding source language file. Returns
null
for source language files.
Public propertyTargetFiles
If this is a source language file, returns all the corresponding target language files. Returns null for target language files.
Top
See Also
Community
Edit
Be the first to Edit the community content of this topic.
Comments