Interface IControlPreviewType

Interface implemented by preview types that provide controls, which can be shown in the host application for viewing the preview content.

Inherited Members
Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public interface IControlPreviewType : IPreviewType
Remarks

Two types of controls can be provided: single file and source and target (typically side-by-side). A control preview can provide either or both of these.

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

Properties

SingleFilePreviewControlId

Identifier for the preview control used to display a single source or target preview file, or null if no control has been specified for viewing single files in this preview.

Declaration
PreviewControlId? SingleFilePreviewControlId { get; set; }
Property Value
Type Description
System.Nullable<PreviewControlId>
Remarks

This id can be passed to BuildPreviewControl(PreviewControlId) in order to create an instance of the preview control, which should implement ISingleFilePreviewControl.

SourceAndTargetPreviewControlId

Identifier for the preview control used to display source and target preview files side-by-side, or null if side-by-side preview is not supported for this preview type.

Declaration
PreviewControlId? SourceAndTargetPreviewControlId { get; set; }
Property Value
Type Description
System.Nullable<PreviewControlId>
Remarks

This id can be passed to BuildPreviewControl(PreviewControlId) in order to create an instance of the preview control, which should implement ISourceAndTargetFilePreviewControl.