Click or drag to resize
AbstractSourceAndTargetFileRefreshablePreviewController Class
Implement this class for source and target (side-by-side) previews. Override the required properties and methods
Inheritance Hierarchy
SystemObject
  Sdl.FileTypeSupport.Framework.IntegrationApiAbstractSourceAndTargetFileRefreshablePreviewController

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 abstract class AbstractSourceAndTargetFileRefreshablePreviewController : ISourceAndTargetFileRefreshablePreview, 
	ISourceAndTargetFilePreviewControl, IAbstractPreviewControl, IAbstractPreviewController, ISourceAndTargetFilePreviewController, INavigablePreview, 
	IDisposable, IPreviewUpdatedViaRefresh, IAbstractUpdatablePreview

The AbstractSourceAndTargetFileRefreshablePreviewController type exposes the following members.

Constructors
  NameDescription
Protected methodAbstractSourceAndTargetFileRefreshablePreviewController
Initializes a new instance of the AbstractSourceAndTargetFileRefreshablePreviewController class
Top
Properties
  NameDescription
Public propertyControl
The actual Windows Forms control for the preview display
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.
Public propertyRefreshPreview
RefreshPreview should be set to true in the controller if a full preview regeneration is needed
Public propertySourcePreviewFile
Full path to the source language file. This should be set by the application before the first call to Launch or Refresh.
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.
Public propertyTargetPreviewFile
Full path to the target language file, which should be set by the application before the first call to Launch or Refresh.
Top
Methods
  NameDescription
Public methodAfterFileRefresh
Called by the host application after the preview file has been successfully overwritten.
Public methodBeforeFileRefresh
Called by the host application when the preview is about to be updated, before the file at TargetFilePath is overwritten.
Public methodDispose
Dispose
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNavigateToSegment
Called by the host application to request that the preview should scroll to the specified segment.
Public methodOnSegmentSelected
Called to fire the SegmentSelected event
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.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventSegmentSelected
Raised when the user interacts with the preview, selecting a different segment than the one that is currently highlighted.
Top
See Also
Community
Edit

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