Click or drag to resize
ISingleFileRefreshablePreview Interface
Interface which amalgamates all other required interfaces for single file preview

Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2551.0)
Syntax
Copy
public interface ISingleFileRefreshablePreview : ISingleFilePreviewControl, 
	IAbstractPreviewControl, IAbstractPreviewController, ISingleFilePreviewController, INavigablePreview, IDisposable, 
	IFileTypeDefinitionAware, IPreviewUpdatedViaSegmentFile, IPreviewUpdatedViaRefresh, IAbstractUpdatablePreview

The ISingleFileRefreshablePreview type exposes the following members.

Properties
  NameDescription
Public propertyControl
The actual Windows Forms control for the preview display
(Inherited from IAbstractPreviewControl.)
Public propertyFileTypeDefinition
The framework sets this property for components that are instantiated from a file type definition.
(Inherited from IFileTypeDefinitionAware.)
Public propertyPreferredHighlightColor
Set by the host application to indicate the preferred color to be used for highlighting the current segment in the preview when NavigateToSegment(SegmentReference) is called.
(Inherited from INavigablePreview.)
Public propertyPreviewFile
Full path to the file that should be displayed in the preview
(Inherited from ISingleFilePreviewController.)
Public propertyRefreshPreview
RefreshPreview should be set to true in the controller if a full preview regeneration is needed
Public propertyTargetFilePath
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.
(Inherited from IPreviewUpdatedViaRefresh.)
Top
Methods
  NameDescription
Public methodAfterFileRefresh
Called by the host application after the preview file has been successfully overwritten.
(Inherited from IPreviewUpdatedViaRefresh.)
Public methodBeforeFileRefresh
Called by the host application when the preview is about to be updated, before the file at TargetFilePath is overwritten.
(Inherited from IPreviewUpdatedViaRefresh.)
Public methodCreateSegmentFile
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.
(Inherited from IPreviewUpdatedViaSegmentFile.)
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodNavigateToSegment
Called by the host application to request that the preview should scroll to the specified segment.
(Inherited from INavigablePreview.)
Public methodRefresh
Called when a document preview first needs to be been displayed and subsequently each time the document preview needs to be been updated.
(Inherited from IAbstractPreviewControl.)
Public methodUpdatePreviewFromSegmentFile
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.
(Inherited from IPreviewUpdatedViaSegmentFile.)
Top
Events
  NameDescription
Public eventSegmentSelected
Raised when the user interacts with the preview, selecting a different segment than the one that is currently highlighted.
(Inherited from INavigablePreview.)
Top
See Also
Community
Edit

Be the first to Edit the community content of this topic.
Comments