AbstractSingleFileRefreshablePreviewController Class

Implement this class for single file previews. Override the required properties and methods

Inheritance Hierarchy

SystemObject
Sdl.Core.Settings.ImplementationAbstractSettingsBundleAware
Sdl.FileTypeSupport.Framework.IntegrationApiAbstractSingleFileRefreshablePreviewController

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

C++

Copy

public abstract class AbstractSingleFileRefreshablePreviewController : AbstractSettingsBundleAware, 
	ISingleFileRefreshablePreview, ISingleFilePreviewControl, IAbstractPreviewControl, IAbstractPreviewController, ISingleFilePreviewController, 
	INavigablePreview, IDisposable, IFileTypeDefinitionAware, IPreviewUpdatedViaSegmentFile, IPreviewUpdatedViaRefresh, 
	IAbstractUpdatablePreview

Public MustInherit Class AbstractSingleFileRefreshablePreviewController
	Inherits AbstractSettingsBundleAware
	Implements ISingleFileRefreshablePreview, ISingleFilePreviewControl, IAbstractPreviewControl, IAbstractPreviewController, 
	ISingleFilePreviewController, INavigablePreview, IDisposable, IFileTypeDefinitionAware, IPreviewUpdatedViaSegmentFile, 
	IPreviewUpdatedViaRefresh, IAbstractUpdatablePreview

public ref class AbstractSingleFileRefreshablePreviewController abstract : public AbstractSettingsBundleAware, 
	ISingleFileRefreshablePreview, ISingleFilePreviewControl, IAbstractPreviewControl, IAbstractPreviewController, ISingleFilePreviewController, 
	INavigablePreview, IDisposable, IFileTypeDefinitionAware, IPreviewUpdatedViaSegmentFile, IPreviewUpdatedViaRefresh, 
	IAbstractUpdatablePreview

[<AbstractClassAttribute>]
type AbstractSingleFileRefreshablePreviewController =  
    class
        inherit AbstractSettingsBundleAware
        interface ISingleFileRefreshablePreview
        interface ISingleFilePreviewControl
        interface IAbstractPreviewControl
        interface IAbstractPreviewController
        interface ISingleFilePreviewController
        interface INavigablePreview
        interface IDisposable
        interface IFileTypeDefinitionAware
        interface IPreviewUpdatedViaSegmentFile
        interface IPreviewUpdatedViaRefresh
        interface IAbstractUpdatablePreview
    end

The AbstractSingleFileRefreshablePreviewController type exposes the following members.

Constructors

	Name	Description
	AbstractSingleFileRefreshablePreviewController	Initializes a new instance of the AbstractSingleFileRefreshablePreviewController class

Top

Properties

	Name	Description
	Control	The actual Windows Forms control for the preview display
	FileTypeDefinition	FileTypeDefinition
	PreferredHighlightColor	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.
	PreviewFile	Full path to the file that should be displayed in the preview
	RefreshPreview	RefreshPreview should be set to true in the controller if a full preview regeneration is needed
	SettingsBundle	Access to the settings bundle. (Inherited from AbstractSettingsBundleAware.)
	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.

Top

Methods

	Name	Description
	AfterFileRefresh	Called by the host application after the preview file has been successfully overwritten.
	BeforeFileRefresh	Called by the host application when the preview is about to be updated, before the file at TargetFilePath is overwritten.
	CreateSegmentFile	Called when a segment file should be created
	Dispose	Dispose
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NavigateToSegment	Called by the host application to request that the preview should scroll to the specified segment.
	OnSegmentSelected	Called to fire the SegmentSelected event
	Refresh	Called when a document preview first needs to be been displayed and subsequently each time the document preview needs to be been updated.
	SetSettingsBundle	Implementation stores the settings bundle in a member that can be accessed through the SettingsBundle property. (Inherited from AbstractSettingsBundleAware.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdatePreviewFromSegmentFile	Called when the Preview should be updated from a segment file

Top

Events

	Name	Description
	SegmentSelected	Raised when the user interacts with the preview, selecting a different segment than the one that is currently highlighted.

Top

Reference

Sdl.FileTypeSupport.Framework.IntegrationApi Namespace

Community

Edit

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

Comments

Send comments on this topic to https://community.sdl.com/developers/language-developers/