Interface IPreviewUpdatedViaRefresh

Defines the protocol used for updating real-time previews through a file refresh mechanism, by which the same file gets overwritten and re-loaded in the preview when target content changes in the editor (typically when a segment is confirmed by the user).

Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public interface IPreviewUpdatedViaRefresh : IAbstractUpdatablePreview

Properties

TargetFilePath

Full path to the target language file that is overwritten when the preview is refreshed. This path is typically set once and stays unchanged during the lifetime of the preview.

Declaration

TempFileManager TargetFilePath { get; set; }

Property Value

Type	Description
TempFileManager

Methods

AfterFileRefresh()

Called by the host application after the preview file has been successfully overwritten.

Declaration

void AfterFileRefresh()

Remarks

The implementation typically re-loads (refreshes) the file in the preview and (if necessary) navigates to the previously displaying content.

BeforeFileRefresh()

Called by the host application when the preview is about to be updated, before the file at TargetFilePath is overwritten.

Declaration

void BeforeFileRefresh()

Remarks

This call allows the implementation to release any file locks and/or try to 'remember' the current location of the file before it is overwritten.