| IFileTypeInformation Interface |
Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2343.0)
SyntaxThe IFileTypeInformation type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | ClearMetaData |
Removes all key/value pairs from the meta data collection.
(Inherited from IMetaDataContainer.) |
| GetMetaData |
Returns the metadata value associated with the specified key,
or null if no such key exists in the collection.
(Inherited from IMetaDataContainer.) |
| MetaDataContainsKey | True if a metadata value with the specified key exists
(Inherited from IMetaDataContainer.) |
| RemoveMetaData |
Removes the metadata key/value pair with the specified key
from the collection. No changes are made if the collection
does not contain such a key.
(Inherited from IMetaDataContainer.) |
| SetMetaData | Sets the value of the specified metadata key. If the key already exists in the collection, its value gets overwritten. |
Properties| Name | Description | |
|---|---|---|
 | 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.
|
| 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.
|
| 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.
|
| 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.
|
 | 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. |
| FileTypeDefinition |
The framework sets this property for components that are
instantiated from a file type definition.
(Inherited from IFileTypeDefinitionAware.) |
| 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.
|
| 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.
|
| 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.
|
| FileTypeFrameworkVersion |
The version of the File Type Framework the file type definition was
designed for.
|
| 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. |
| HasMetaData | True if there is any metadata in the container
(Inherited from IMetaDataContainer.) |
| 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.
|
| Icon |
The icon representing this particular file type
|
| IsBilingualDocumentFileType | True for file types that can be used as intermediate bilingual documents
to store all information available in the bilingual content model.
|
| MetaData |
Enumerator for the metadata key/value pairs.
(Inherited from IMetaDataContainer.) |
| MetaDataCount |
The number of meta data key/value pairs in the container
(Inherited from IMetaDataContainer.) |
| SilverlightSettingsPageIds |
List of IDs for settings UI pages for this file type, implemented in Silverlight.
|
| WinFormSettingsPageIds |
List of IDs for settings UI pages for this file type, implemented in Windows Forms.
|
RemarksThe file type information can also contain additional metadata, in the form of key/value pairs, which are accessible through the IMetaDataContainer implementation.
See AlsoCommunityComments