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

Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public interface IPreviewSet

Remarks

This can be a set of application previews or a set of control previews, or a mix of these (discouraged). Check the PreviewSetKind property to find out which one applies.

Properties

Description

Description of the preview (optional)

Declaration

LocalizableString Description { get; set; }

Property Value

Type	Description
LocalizableString

Id

Unique identifier for this preview type within the file type definition.

Declaration

PreviewSetId Id { get; set; }

Property Value

Type	Description
PreviewSetId

Name

Descriptive name of the preview, which may be shown to the user.

Declaration

LocalizableString Name { get; set; }

Property Value

Type	Description
LocalizableString

PreviewSetKind

Convenient way of determining whether this preview set represents application previews or control previews (or a mix of both, which is not recommended).

Declaration

PreviewSetKind PreviewSetKind { get; }

Property Value

Type	Description
PreviewSetKind

Remarks

The implementation checks whether the source, target and side-by-side preview types implement IApplicationPreviewType or IControlPreviewType.

SideBySide

The preview type that should be treated as a source and target language, side-by-side preview in the user interface, or null if there is no such preview in this set.

Declaration

IPreviewType SideBySide { get; set; }

Property Value

Type	Description
IPreviewType

Source

The preview type that should be treated as a source language preview in the user interface, or null if there is no such preview in this set.

Declaration

IPreviewType Source { get; set; }

Property Value

Type	Description
IPreviewType

Target

The preview type that should be treated as a target language preview in the user interface, or null if there is no such preview in this set.

Declaration

IPreviewType Target { get; set; }

Property Value

Type	Description
IPreviewType