Class SideBySideNavigableWebBrowserPreviewController

A side by side navigable web browser preview controller

Inheritance
System.Object
AbstractFileTypeDefinitionComponent
AbstractPreviewControl
SideBySideNavigableWebBrowserPreviewController
SideBySideRealtimeWebBrowserPreviewController
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Sdl.FileTypeSupport.Framework.PreviewControls
Assembly: Sdl.FileTypeSupport.Framework.PreviewControls.dll
Syntax
public class SideBySideNavigableWebBrowserPreviewController : AbstractPreviewControl, IFileTypeDefinitionAware, ISourceAndTargetFilePreviewControl, IAbstractPreviewControl, IAbstractPreviewController, ISourceAndTargetFilePreviewController, INavigablePreview, IDisposable

Constructors

SideBySideNavigableWebBrowserPreviewController()

SideBySideNavigableWebBroserPreviewController constructor

Declaration
public SideBySideNavigableWebBrowserPreviewController()

Properties

Control

Property to access the Preview Control

Declaration
public override Control Control { get; }
Property Value
Type Description
System.Windows.Forms.Control
Overrides

InitialHtmlPage

If set then an initial HTML page will be displayed containg the content of this string in a tempoary .htm file.

Declaration
public string InitialHtmlPage { get; set; }
Property Value
Type Description
System.String

PreferredHighlightColor

Property for getting/setting preferred highlight color

Declaration
public Color PreferredHighlightColor { get; set; }
Property Value
Type Description
System.Drawing.Color

SourcePreviewFile

Default implementation is accessor for member field.

Declaration
public TempFileManager SourcePreviewFile { get; set; }
Property Value
Type Description
TempFileManager

TargetPreviewFile

Default implementation is accessor for member field.

Declaration
public TempFileManager TargetPreviewFile { get; set; }
Property Value
Type Description
TempFileManager

Methods

Dispose()

Dispose mechanism

Declaration
public void Dispose()

Dispose(Boolean)

Implementation of the recommended dispose protocol. Deletes the managed WebBrowser control

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

true if this method is called from IDisposable.Dispose() and false if called from Finalizer

Finalize()

SideBySideNavigableWebBrowserPreviewController destructor

Declaration
protected void Finalize()

NavigateToSegment(SegmentReference)

Called when navigating to a specific segment is required

Declaration
public void NavigateToSegment(SegmentReference segment)
Parameters
Type Name Description
SegmentReference segment

OnSegmentSelected(Object, SegmentSelectedEventArgs)

Raise the SegmentSelected event.

Declaration
public virtual void OnSegmentSelected(object sender, SegmentSelectedEventArgs args)
Parameters
Type Name Description
System.Object sender
SegmentSelectedEventArgs args

Refresh()

Called to initially display or refresh the display of a the source and target pages in two System.Windows.Forms.WebBrowser controls. If either the source and target files do not exist then the InitialHtmlPage page will be displayed. The GenericInternalWebBrowserPreviewControl can be used to display a single source or target file in a WebBrowser control.

Declaration
public override void Refresh()
Overrides

RefreshTarget()

Called to refresh the Target portion of the control

Declaration
protected void RefreshTarget()

Events

SegmentSelected

Segment selected event

Declaration
public event EventHandler<SegmentSelectedEventArgs> SegmentSelected
Event Type
Type Description
System.EventHandler<SegmentSelectedEventArgs>

Implements

System.IDisposable