Interface IApplicationPreviewType

Interface implemented by preview types that provide a mechanism to launch an external application to view the content.

Inherited Members

IPreviewType.SourceGeneratorId

IPreviewType.TargetGeneratorId

Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public interface IApplicationPreviewType : IPreviewType

Remarks

Two types of preview applications can be provided: single file and "source and target" (typically side-by-side). The implementation can provide either or both of these.

Host applications can check these ids to determine which launch buttons/tabs should be available in the UI for a specific preview type.

Properties

SingleFilePreviewApplicationId

Id for preview application implementation that can be used to launch a preview for a single (source or target language) file.

Declaration

PreviewApplicationId? SingleFilePreviewApplicationId { get; set; }

Property Value

Type	Description
Nullable<PreviewApplicationId>

Remarks

This id can be passed to BuildPreviewApplication(PreviewApplicationId) to create an instance of the application, which should implement ISingleFilePreviewApplication.

SourceAndTargetPreviewApplicationId

Id of the preview application implementation, which can be used to launch a preview for both source and target files.

Declaration

PreviewApplicationId? SourceAndTargetPreviewApplicationId { get; set; }

Property Value

Type	Description
Nullable<PreviewApplicationId>

Remarks

This id can be passed to BuildPreviewApplication(PreviewApplicationId) in order to create an instance of the application, which should implement ISourceAndTargetFilePreviewApplication.