Interface IFileTypeInformation

Information that a host application may need to 'know' about a file type, such as the localized name of the file type, the wildcard expression (file extensions) for the file dialog, and which settings pages are available.

Inherited Members

IFileTypeDefinitionAware.FileTypeDefinition

IMetaDataContainer.MetaDataContainsKey(string)

IMetaDataContainer.GetMetaData(string)

IMetaDataContainer.SetMetaData(string, string)

IMetaDataContainer.RemoveMetaData(string)

IMetaDataContainer.ClearMetaData()

IMetaDataContainer.MetaData

IMetaDataContainer.HasMetaData

IMetaDataContainer.MetaDataCount

Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public interface IFileTypeInformation : IFileTypeDefinitionAware, IMetaDataContainer

Remarks

The file type information can also contain additional metadata, in the form of key/value pairs, which are accessible through the IMetaDataContainer implementation.

Properties

DefaultFileExtension

The default file extension to use in a Save As dialog and automatically append to the file name if it does not match the file dialog wildcard expression.

Declaration

string DefaultFileExtension { get; set; }

Property Value

Type	Description
string

Remarks

Typically used for intermediate bilingual file formats like SDL XLIFF.

The file extension should not contain a leading '.' character.

Description

Descriptive text for the file type definition. This is stored in a LocalizableString, which contains either a plain text value or an embedded resource identifier.

Declaration

LocalizableString Description { get; set; }

Property Value

Type	Description
LocalizableString

Enabled

Determines whether the file type is considered as a candidate for processing a file. This allows us to have filters present in the file type manager that won't be used for processing.

Declaration

bool Enabled { get; set; }

Property Value

Type	Description
bool

Expression

This regular expression is applied to the file name to determine if it matches, when the file is about to be opened. This expression is created from the FileDialogWildcardExpression.

Declaration

Regex Expression { get; }

Property Value

Type	Description
Regex

FileDialogWildcardExpression

The wildcard expression shows up with the file type name in File Open dialogs.

This is used both for displaying and for filtering file types in the file dialog.

Declaration

string FileDialogWildcardExpression { get; set; }

Property Value

Type	Description
string

Examples

In the following string from the open dialog: Microsoft Word Documents (.doc;.dot) the FileDialogWildcardExpression would be '.doc;.dot'

FileTypeDefinitionId

Unique file type definition identifier. The convention is to use the following format: "[Document Type] [Document Type Version] v [File Type Definition version]", where the file type definition version is a four digit version number. Example: "SDL XLIFF 1.0 v 1.0.0.0", for version 1.0.0.0 of the file type definition for the SDL XLIFF file format, version 1.0, or "Microsoft Word 2007 v 1.1.0.0", and so on.

Declaration

FileTypeDefinitionId FileTypeDefinitionId { get; set; }

Property Value

Type	Description
FileTypeDefinitionId

FileTypeDocumentName

Friendly name of the type of an individual file of this file type. This is used when referring to a single item, e.g. in a File Save As dialog.

Declaration

LocalizableString FileTypeDocumentName { get; set; }

Property Value

Type	Description
LocalizableString

Remarks

By convention, this is often the file type name followed by "Document" or "File".

See Also

FileTypeName

FileTypeDocumentsName

FileTypeDocumentsName

Friendly name of a set of files of this file type. This name is used when referring to a collection of files, e.g. in a File Open dialog.

Declaration

LocalizableString FileTypeDocumentsName { get; set; }

Property Value

Type	Description
LocalizableString

Remarks

By convention, this is often the file type name, followed by "Documents" or "Files".

See Also

FileTypeName

FileTypeDocumentName

FileTypeFrameworkVersion

The version of the File Type Framework the file type definition was designed for.

Declaration

Version FileTypeFrameworkVersion { get; set; }

Property Value

Type	Description
Version

Remarks

This is used during a system upgrade to determine how the definition content should be adapted to work with a different version of the framework.

FileTypeName

Friendly name for the file type, which may be shown to the user.

This is the short version of the file type name that is used in settings dialogs, messages etc.

There are two additional versions of the file type name, FileTypeDocumentName and FileTypeDocumentsName, which are used to denote individual documents and sets of documents of this file type (e.g. in File Open and Save As dialogs).

This is stored in a LocalizableString, which contains either a plain text value or an embedded resource identifier.

Declaration

LocalizableString FileTypeName { get; set; }

Property Value

Type	Description
LocalizableString

Remarks

The file type name is the core name of the file type; it normally does not end on "documents" or "files".

Hidden

Determines whether the file type will be displayed in the UI of the host application. If a file type is hidden, then it would normally also be disabled.

Declaration

bool Hidden { get; set; }

Property Value

Type	Description
bool

Icon

Declaration

IconDescriptor Icon { get; set; }

Property Value

Type	Description
IconDescriptor

IsBilingualDocumentFileType

True for file types that can be used as intermediate bilingual documents to store all information available in the bilingual content model.

Declaration

bool IsBilingualDocumentFileType { get; set; }

Property Value

Type	Description
bool

Remarks

The first file type definition in the file type manager for which this property is true, becomes the default bilingual file type.

An example of a bilingual document file type is SDL XLIFF.

Removed

Determines whether the file type should be removed from the list of File Types shown by a given host e.g. not used by the host - this is different from enabled, where the File Type might still be shown in the list

Declaration

bool Removed { get; set; }

Property Value

Type	Description
bool

SilverlightSettingsPageIds

List of IDs for settings UI pages for this file type, implemented in Silverlight.

Declaration

string[] SilverlightSettingsPageIds { get; set; }

Property Value

Type	Description
string[]

Remarks

Each settings page is implemented as a Silverlight plug-in. The settings page ID is the ID of the plug-in that implements the settings page.

The settings page implementation class must be decorated with the Sdl.FileTypeSupport.Framework.Core.Settings.FileTypeSettingsPageAttribute attribute, and the assembly must be built and deployed as a plug-in.

WinFormSettingsPageIds

List of IDs for settings UI pages for this file type, implemented in Windows Forms.

Declaration

string[] WinFormSettingsPageIds { get; set; }

Property Value

Type	Description
string[]

Remarks

Settings pages are implemented in desktop plug-ins. The settings page ID is the ID of the plug-in component that implements the settings page.

The settings page implementation class must be decorated with the Sdl.FileTypeSupport.Framework.Core.Settings.FileTypeSettingsPageAttribute attribute, and the assembly must be built and deployed as a plug-in.