Click or drag to resize
IDependencyFileProperties Interface
Information on a dependency file used during file conversion.

Namespace: Sdl.FileTypeSupport.Framework.NativeApi
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2551.0)
Syntax
public interface IDependencyFileProperties : ICloneable

The IDependencyFileProperties type exposes the following members.

Properties
  NameDescription
Public propertyCurrentFilePath
The current path to the dependency file
Public propertyDescription
Optional clear text description of the file. This can be used e.g. to explain the origin and purpose of the file to other users and developers.
Public propertyDisposableObject
This property can be used to hold a reference to a disposable object, such as a temp file that should be deleted when it has no more references. (optional)
Public propertyExpectedUsage
Expected usage for this dependency file (optional)
Public propertyFileExists
True if the CurrentFilePath references a file that exists.
Public propertyId
Id associated with this dependency file. (optional)
Public propertyOriginalFilePath
The original path of the dependency file (if known)
Public propertyOriginalLastChangeDate
The timestamp (the last change date) of the original dependency file (if known)
Public propertyPathRelativeToConverted
If the file is a direct dependency of the file being converted, and it is linked rather than embedded, then this property may contain the path to the linked dependency file relative to the .sdlxliff file that refers to it.
Public propertyPreferredLinkage
Indicates the preferred way of handling this file when writing intermediate bilingual content. (optional)
Public propertyZippedCurrentFile
A FileJanitor instance managing the lifetime of a temporary .zip file containing a copy of the file stored in CurrentFilePath.
Top
Methods
  NameDescription
Public methodClone
Creates a new object that is a copy of the current instance.
(Inherited from ICloneable.)
Top
Remarks

Some examples of dependency files include:

  • The original native file, if needed for generation of translated native file.
  • The Filter Framework 1 filter definition file, if required by Filter Framework 1 filter and adapter.
  • Image files required to correctly display an HTML file during preview.
  • An XML schema required for validation of the output.
  • A translation memory that may be used during translation.

Dependency files are not processed for localizable content.

Information on dependency files is particularly important when moving bilingual documents between systems (or even between different locations on the same system). After saving a bilingual document LinkedDependencyFiles, this contains information on which dependency files (if any) were explicitly linked rather than embedded in the bilingual file.

See Also
Community
Edit

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