| Sdl.FileTypeSupport.Framework.IntegrationApi Namespace |
[Missing <summary> documentation for "N:Sdl.FileTypeSupport.Framework.IntegrationApi"]
Classes| Class | Description | |
|---|---|---|
 | AbstractFileTypeDefinitionComponent |
Convenient default implementation of IFileTypeDefinitionAware;
ensures synchronized access to the data member, so that components
can be safely marked as singletons in the spring configuration files.
|
| AbstractSingleFileRefreshablePreviewController |
Implement this class for single file previews. Override the required properties and methods
|
| AbstractSourceAndTargetFileRefreshablePreviewController |
Implement this class for source and target (side-by-side) previews. Override the required properties and methods
|
| BatchProgressEventArgs |
Properties of a progress event in a batch process
|
| DynamicFilterComponentBuilder |
DynamicFilterComponentBuilder class allows an inheriting class to effectively create a new file type based upon an existing file type.
|
| ExtendedMessageEventData |
ExtendedMessageEventData class represents extended message event data within message event arguments.
The extended message event data includes the message type property. It is expected that developers will
inherit from this class to include further properties specific to the message. For example, segment verifier
developers could inherit from ExtendedMessageEventData to include further verification message properties to
help describe and display verification messages to the user.
|
| FileNotSupportedException |
Used in OneOrMoreFilesNotSupportedException to convey the details of
a single file that was not supported by any installed file type when using one
of the GetConverter... overloads in IFileTypeManager.
|
| FileTypeComponentBuilderAttribute |
Apply this attribute to a class implementing Sdl.FileTypeSupport.Framework.IntegrationApi.IFileTypeComponentBuilder.
|
| FileTypeComponentBuilderExtensionAttribute |
Apply this attribute to a class implementing Sdl.FileTypeSupport.Framework.IntegrationApi.IFileTypeComponentBuilder. This should be used for extension ComponentBuilders only
|
| FileTypeCreatorAttribute |
Attribute to mark a class as a FileTypeCreator
|
| FileTypeCreatorWizardPage |
A wizard page data object. Used by the FileType Configuration implementation to hold the data required for the construction of the Wizard page
|
| FileTypeDefinitionNotFoundException |
Exception thrown by the IFileTypeManager implementation when a
required file type definition could not be located.
|
| FileTypeProfile |
This class is a collection of data that's required to build up an XML chunk for file type information override
|
| IconDescriptor |
Represents an icon that is loaded from a file path, from an embedded resource, or from a base64-encoding string.
|
| MessageEventArgs |
Information passed in Message events
|
| NoDefaultBilingualFileTypeException |
Thrown by IFileTypeManager when attempting to create a converter for the
default bilingual file type, but when no default bilingual file type has been set.
|
| NotBilingualFileTypeException |
Exception thrown when attempting to set a default bilingual file type
to a file type for which IsBilingualDocumentFileType is not set to true.
|
| OneOrMoreFilesNotSupportedException |
Exception thrown by the IFileTypeManager implementation
for operations that may involve multiple files if one or more of the files
are not supported by any file type definition in the file type manager.
|
| PreviewClosedEventArgs |
Information passed in the PreviewClosed event
|
| SegmentReference |
Serializable reference to a segment that can be used
to reference a specific segment in a paragraph and file
e.g. when processing content for preview.
|
| SegmentSelectedEventArgs |
Information passed in the SegmentSelected event
|
| SubContentProcessorDoesNotExistException |
This exception is thrown when a subcontent FileTypeDefinition cannot be found during processing
|
| TemplateComponentBuilderManager |
TemplateComponentBuilderManager class represents a template component builder manager.
|
| UnknownFileTypeDefinitionException |
Thrown by the IFileTypeManager implementation when attempting to use
a file type definition id that is not part of the file type manager file type definitions.
|
Structures| Structure | Description | |
|---|---|---|
 | GeneratorId |
Type safe wrapper around an id for a native or bilingual document generator
|
| PreviewApplicationId |
Type safe wrapper around a preview application type id
|
| PreviewControlId |
Type safe wrapper around a preview control type id
|
| PreviewSetId |
Type safe wrapper around a unique id for a preview set
|
Interfaces| Interface | Description | |
|---|---|---|
 | IAbstractGenerator |
Common base interface for native and bilingual document generators
|
| IAbstractPreviewApplication |
Common base interface for managing standalone applications
that are used for previews.
|
| IAbstractPreviewControl |
Interface implemented by file type components that can be used
for displaying a preview in a .NET control that can be hosted
in the application.
|
| IAbstractPreviewController |
Common base interface for preview controllers, currently specialized into
IAbstractPreviewControl derivatives and IAbstractPreviewApplication derivatives.
|
| IAbstractUpdatablePreview |
Base interface for previews that can be dynamically updated as
content in the editor changes.
|
| IAdditionalGeneratorsInfo |
Collection of information on the extra generators that are specified for this file type
in addition to the default generator. These generators will be used for tasks such as
previewing the file and generating the original document format from older bilingual formats (ITD and TTX).
|
| IApplicationPreviewType |
Interface implemented by preview types that provide a mechanism
to launch an external application to view the content.
|
| IBilingualDocumentGenerator |
A set of bilingual content processors together with a bilingual writer
that can be used to process the entire content (all files) of a bilingual document.
|
| IBilingualProcessorContainer |
Common base interface for components that hold bilingual content processors
|
| IControlPreviewType |
Interface implemented by preview types that provide controls, which can be
shown in the host application for viewing the preview content.
|
| IDefaultQuickTagInfo |
This interface represents the default QuickTag info available for the file type.
|
| IFileExtractor |
Represents a native parser with native components (or a bilingual parser) and bilingual content
processors used when reading native or bilingual file.
|
| IFileGenerator |
Represents a set of bilingual content processors, native content
processors, and a native writer, which work together to output native files
from bilingual content.
|
| IFileTypeComponentBuilder |
Interface implemented by anything that can create the components that make up a file type.
This may be achieved by reading from a configuration file, or by directly instantiating the objects (in an implementation specific to a file type).
The SpringFileTypeComponentBuilder implements this interface and uses the
spring framework to do this.
|
| IFileTypeComponentBuilderAdapter |
Adapter interface for FileType extensions
|
| IFileTypeCreator |
Object that controls the creation of a new file type from an existing base file type definition. This object will use the
IFileTypeConfigurer specified in the configurer property to supply the custom settings for the
new file type.
|
| IFileTypeDefinition |
Represents the functionality of a file type definition as a read-only
object, which can be used to instantiate the file type support components.
The file type definition includes all information on the support
for a specific file type.
The file type definition uses a IFileTypeComponentBuilder to retrieve the
relevant information from persistent storage, e.g. file type definition
XML files or database tables.
|
| IFileTypeDefinitionAware |
This interface is implemented by components that are instantiated
through a file type definition. The framework sets the FileTypeDefinition
property when a component is instantiated using a file type definition.
|
| IFileTypeDefinitionConfiguringControl |
Used by the Configuration Wizard to save the state of a control
|
| IFileTypeDefinitionFactory |
Factory for file type definitions. This is typically accessed from
FileTypeDefinitionFactory.
|
| 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.
|
| IFileTypeManager | This is the main access point for file conversion operations. The file type manager holds a prioritized list of file type definitions. The order of file type definitions is important, as it determines which file types take precedence over others in case multiple file type definitions could be used to process the same file. The most significant file type definition appears first in the list. In implementations, the file type manager is often pre-configured with a set of file type definitions in the host application. However, the list can also be explicitly manipulated by calling AddFileTypeDefinition(IFileTypeDefinition), InsertFileTypeDefinition(Int32, IFileTypeDefinition) or RemoveFileTypeDefinition(IFileTypeDefinition). File type definitions can be instantiated from existing files or resources using the FileTypeDefinitionFactory. Call one of the overloaded GetConverter...() methods to use the file type definitions to automatically detect file types and initialize a IMultiFileConverter to process the content. |
| IFilterFramework1FilterDefinitionFile |
A public interface for holding a spring .net framework created
by a filter framework 1 filter definition file.
|
| IGeneratorInfo |
Information on a generator component that is specified for the file type
|
| IInteractivePreviewComponent |
A control representing the native type of a document with methods
to allow scrolling, searching and replacement of text within the
native document.
|
| IInteractivePreviewComponentFactory |
Simple class for creating generator classes used for generating
and populating native document previews.
|
| IMessageLocation |
Used with messages that link to a document location to
provide a mechanism to retrieve the corresponding positions
in the bilingual content model.
|
| IMultiFileConverter |
Used for converting and processing content from one or more files as a single bilingual document.
|
| INavigablePreview |
Provides services for navigating in a preview, to
highlight a specific segment in the preview, and to
generate events when the user selects a segment in the
preview.
|
| IPreviewSet |
A group of preview types that has a common name and that can be
assigned to a group of source/target/side-by-side preview commands
in the user interface.
|
| IPreviewSets |
Collection of preview types for this file type, with accessors to get
a specified preview by id and the ability to define a
default preview type.
|
| IPreviewSetsFactory |
Interface used for instantiating a set of preview types available
for a specific file.
|
| IPreviewType |
Describes a type of preview that is available for a file type
through its file type definition. This interface is further specialized
into IControlPreviewType and IApplicationPreviewType
for previews that can be hosted in controls or launch standalone
applications. The preview type is normally defined as part of a IPreviewSet.
The preview set determines whether the preview type is used as a source, target, or side-by-side
preview in the user interface.
|
| IPreviewUpdatedViaRefresh |
Defines the protocol used for updating real-time previews through
a file refresh mechanism, by which the same file gets overwritten and
re-loaded in the preview when target content changes in the editor
(typically when a segment is confirmed by the user).
|
| IPreviewUpdatedViaSegmentFile |
Implemented by the real-time preview controls and applications that can be updated using a "segment file protocol",
i.e. via a file in the orignal document format that contains a single segment.
|
| IQuickTag |
This interface represents an individual QuickTag. You can retrieve the markup data
for this QuickTag by reading the MarkupDataContent property.
|
| IQuickTagContent |
Template for the document content that the QuickTag represents
|
| IQuickTags |
This interface represents the QuickTags in a file type definition file.
|
| IQuickTagsFactory |
Inteface used to instantiate a set of QuickTags available
for a specific file.
|
| ISettingsAware |
This interface should be implemented by components which need to be aware of a
particular settings group in order to read their settings from this group
(during extraction or generation).
|
| ISingleFilePreviewApplication |
Manages a standalone application that can be used to preview
a single (source or target language) file.
|
| ISingleFilePreviewControl |
Implemented by preview controls that display a single file
|
| ISingleFilePreviewController |
Base interface for preview controllers that take single files as input
|
| ISingleFileRefreshablePreview |
Interface which amalgamates all other required interfaces for single file preview
|
| ISourceAndTargetFilePreviewApplication |
Implementated by components that can manage simultanous previews
of source and target language files in standalone applications.
|
| ISourceAndTargetFilePreviewControl |
Implemented by preview controls that display source
and target files together, e.g. side-by-side previews.
|
| ISourceAndTargetFilePreviewController |
Base interface for preview controllers that show both the a source and target language file
|
| ISourceAndTargetFileRefreshablePreview |
Interface which amalgamates all other required interfaces for Source and Target (SideBySide) preview
|
| ISubContentComponentBuilder |
Interface which is implemented by sub-content component builders
|
| ISubContentExtractor |
Represents a native parser with native components (or a bilingual parser) and bilingual content
processors used when reading native or bilingual file.
|
| ISubContentGenerator |
Represents a set of bilingual content processors, native content
processors, and a native writer, which work together to output native files
from bilingual content.
|
| IVerifierCollection |
Represents a set of bilingual content verifiers that work together to send
non-critical messages to the client application through the verifier plug-ins.
|
Delegates| Delegate | Description | |
|---|---|---|
 | BilingualDocumentOutputPropertiesProvider |
This delegate is used with IMultiFileConverter to determine the output properties
for bilingual document files (e.g. SDL XLIFF). The implementation should set the relevant
properties on the outputProperties object, supported by proposedFileInfo as required.
|
| BilingualParserFactory |
Used to allow the component to retrieve a bilingual parser whenever it needs one
|
| BilingualVerifiersProvider |
Delegate that is used to supply bilingual verifiers to the file extractor in order to perform the verification
|
| NativeGeneratorProvider |
Creates and initializes a file generator that can be used to write native content.
|
| OutputPropertiesProvider |
Called by the framework when native output settings for a file
need to be determined.
The implementation should set the output file name, codepage, etc.
of the output properties based on the file conversion info.
|
| PreviewControlHandler |
Delegate type to allow specific implementations of IInteractivePreviewControl
to send events in a standardised way
|
Enumerations| Enumeration | Description | |
|---|---|---|
 | FileTypeDefinitionCustomizationLevel |
Used by the CustomizationLevel property to
indicate level of File Type Definition customization.
|
| PreviewSetKind |
Used by the PreviewSetKind property to
indicate whether a preview set contains application or control previews.
|
| QuickTagDefaultId |
Command ids used for default QuickTags.
|
CommunityComments