| IPreviewUpdatedViaSegmentFile Interface |
Implemented by the real-time preview controls and applications that can be updated using a "segment file protocol",
i.e. via a file in the orignal document format that contains a single segment.
Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2343.0)
SyntaxThe IPreviewUpdatedViaSegmentFile type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | CreateSegmentFile |
Called by the host application to create a native source document containing the source language
content of the specified segment. The implementation returns the full path to the file created.
|
| UpdatePreviewFromSegmentFile |
Called by the host application to update the preview with the content of a segment file.
The implementation should update the preview by replacing the segment content with the
content in the segment file.
|
RemarksComponents that implement this interface typically also implement INavigablePreview.
This interface is used by the real-time preview for Microsoft Word documents.
The protocol works as follows:
When the translation of a segment is updated in the host application, the application calls CreateSegmentFile(SegmentReference) on this interface. The implementation should create a file in the native format containing the source language sentence for the segment. (E.g. by copying the sentence into a hidden document and saving it to a file.) The host application parses this single segment file using the framework, replaces the source language content with the corresponding translation, and saves the resulting content back to native format through the framework. The application then calls UpdatePreviewFromSegmentFile(SegmentReference, TempFileManager) on this interface, passing in the translated native file produced above. The implementation uses this file to update the visible preview. (E.g. by opening the file hidden, copying its content and by replacing the original source sentence with it.)See AlsoCommunityComments