Interface IQuickTagsFactory
Inteface used to instantiate a set of QuickTags available for a specific file.
Inherited Members
Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public interface IQuickTagsFactory : IFileTypeDefinitionAware
Remarks
Normally accessed via BuildQuickTagsFactory().
The set of available QuickTags that are available for a file type sometimes depends on the actual file itself (e.g. for TTX documents, the underlying file format can vary significantly). However, for most file formats, the set is the same for all document instances. You can check the IsFileAgnostic property to determine if this is the case.
Properties
IsFileAgnostic
Returns true
if the set of QuickTags is the same for
all files that the factory applies to, in which case passing
null
to GetQuickTags(IFileProperties) will yield the
full set of QuickTags for the document type.
Declaration
bool IsFileAgnostic { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
GetQuickTags(IFileProperties)
Gets the set of QuickTags that can be used with the specified file.
Declaration
IQuickTags GetQuickTags(IFileProperties fileProperties)
Parameters
Type | Name | Description |
---|---|---|
IFileProperties | fileProperties | Properties of the file instance
for which the QuickTags should be specialized, or |
Returns
Type | Description |
---|---|
IQuickTags | An instance of IQuickTags, or |
Remarks
The file properties are used when initializing QuickTags for file types such as TTX, for which the actual QuickTags available depend on the underlying file format.
For most file formats, the QuickTags do not depend on the file properties.