Interface 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.

Inherited Members
Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public interface IFileTypeComponentBuilder : IFileTypeDefinitionAware

Properties

FileTypeManager

Current File Type Manager instance which will be set by the framework.

Declaration
IFileTypeManager FileTypeManager { get; set; }
Property Value
Type Description
IFileTypeManager

Methods

BuildAbstractGenerator(String)

Gets a native or bilingual document generator of the type defined for the specified name.

Declaration
IAbstractGenerator BuildAbstractGenerator(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAbstractGenerator

BuildAdditionalGeneratorsInfo(String)

The the additional generator information for this file type

Declaration
IAdditionalGeneratorsInfo BuildAdditionalGeneratorsInfo(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAdditionalGeneratorsInfo

BuildBilingualGenerator(String)

Gets the bilingual writer components for this component (if any).

Declaration
IBilingualDocumentGenerator BuildBilingualGenerator(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IBilingualDocumentGenerator

null if no bilingual generator is defined

BuildFileExtractor(String)

Gets the file extractor for this component.

Declaration
IFileExtractor BuildFileExtractor(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IFileExtractor

BuildFileGenerator(String)

Gets the file generator for this component.

Declaration
IFileGenerator BuildFileGenerator(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IFileGenerator

Null if no file generator is defined

BuildFileSniffer(String)

Gets the file sniffer for this component.

Declaration
INativeFileSniffer BuildFileSniffer(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
INativeFileSniffer

BuildFileTypeInformation(String)

Returns a file type information object.

Declaration
IFileTypeInformation BuildFileTypeInformation(string name)
Parameters
Type Name Description
System.String name

The IFileTypeDefinition will pass "" as the name for this parameter
Returns
Type Description
IFileTypeInformation

BuildPreviewApplication(String)

Creates a new instance of the preview application with the specified name.

Declaration
IAbstractPreviewApplication BuildPreviewApplication(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAbstractPreviewApplication

BuildPreviewControl(String)

Creates a new instance of the preview control with the specified name.

Declaration
IAbstractPreviewControl BuildPreviewControl(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAbstractPreviewControl
Remarks

Should only be called from the main thread, as controls must always be instantiated on the same thread as the application message pump.

BuildPreviewSetsFactory(String)

Gets the different sets of previews supported for this component.

Declaration
IPreviewSetsFactory BuildPreviewSetsFactory(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IPreviewSetsFactory

BuildQuickTagsFactory(String)

Gets the QuickTags object for this component.

Declaration
IQuickTagsFactory BuildQuickTagsFactory(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IQuickTagsFactory

BuildVerifierCollection(String)

Gets the verifier list of this component.

Declaration
IVerifierCollection BuildVerifierCollection(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IVerifierCollection
Remarks

The verifier list is an optional component for a file type.