Interface IPreviewSets

Collection of preview types for this file type, with accessors to get a specified preview by id and the ability to define a default preview type.

Inherited Members

System.Collections.Generic.ICollection<Sdl.FileTypeSupport.Framework.IntegrationApi.IPreviewSet>.Add(Sdl.FileTypeSupport.Framework.IntegrationApi.IPreviewSet)

System.Collections.Generic.ICollection<Sdl.FileTypeSupport.Framework.IntegrationApi.IPreviewSet>.Clear()

System.Collections.Generic.ICollection<Sdl.FileTypeSupport.Framework.IntegrationApi.IPreviewSet>.Contains(Sdl.FileTypeSupport.Framework.IntegrationApi.IPreviewSet)

System.Collections.Generic.ICollection<Sdl.FileTypeSupport.Framework.IntegrationApi.IPreviewSet>.CopyTo(Sdl.FileTypeSupport.Framework.IntegrationApi.IPreviewSet[], System.Int32)

System.Collections.Generic.ICollection<Sdl.FileTypeSupport.Framework.IntegrationApi.IPreviewSet>.Remove(Sdl.FileTypeSupport.Framework.IntegrationApi.IPreviewSet)

System.Collections.Generic.ICollection<Sdl.FileTypeSupport.Framework.IntegrationApi.IPreviewSet>.Count

System.Collections.Generic.ICollection<Sdl.FileTypeSupport.Framework.IntegrationApi.IPreviewSet>.IsReadOnly

System.Collections.Generic.IEnumerable<Sdl.FileTypeSupport.Framework.IntegrationApi.IPreviewSet>.GetEnumerator()

Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public interface IPreviewSets : ICollection<IPreviewSet>, IEnumerable<IPreviewSet>, IEnumerable

Remarks

If no default preview type is defined, the host application may choose to use the first defined preview type as the default.

Properties

DefaultApplicationPreview

The id of the preview type that should be used by default for application previews for this file type.

Declaration

PreviewSetId? DefaultApplicationPreview { get; set; }

Property Value

Type	Description
System.Nullable<PreviewSetId>

Remarks

It is possible to assign a default preview type id that is not defined in this collection. This is intentional, in order to allow a preview type defined for the default bilingual file type to be used as the default for the file format without having to explicitly define it in this file type definition.

The id can be passed to FindFromId(PreviewSetId) to get the corresponding preview type, or null if the preview type is not defined in this file type definition.

DefaultControlPreview

The id of the preview type that should be used as default for control previews for this file type.

Declaration

PreviewSetId? DefaultControlPreview { get; set; }

Property Value

Type	Description
System.Nullable<PreviewSetId>

Remarks

It is possible to assign a default preview type id that is not defined in this collection. This is intentional, in order to allow a preview type defined for the default bilingual file type to be used as the default for the file format without having to explicitly define it in the file type definition.

The id can be passed to FindFromId(PreviewSetId) in order to get the corresponding preview type, or null if the preview type is not defined in this file type definition.

Methods

FindFromId(PreviewSetId)

Returns the preview type with the specified id, or null if no preview type with that id is defined in this collection.

Declaration

IPreviewSet FindFromId(PreviewSetId id)

Parameters

Type	Name	Description
PreviewSetId	id

Returns

Type	Description
IPreviewSet

GetApplicationPreviews()

Returns all "View In" preview sets, i.e. previews that can launch a standalone application instance for viewing the content.

Declaration

IEnumerable<IPreviewSet> GetApplicationPreviews()

Returns

Type	Description
System.Collections.Generic.IEnumerable<IPreviewSet>

GetControlPreviews()

Returns all preview sets that provide controls that can be hosted in a window of the host application.

Declaration

IEnumerable<IPreviewSet> GetControlPreviews()

Returns

Type	Description
System.Collections.Generic.IEnumerable<IPreviewSet>