Class AbstractViewController

Base class used in the implementation and integration of a view in desktop applications. Based on an MVC pattern the implementation is the controller of a view.

Inheritance
object
AbstractController
AbstractViewController
AbstractBindedController
Implements
Inherited Members
Namespace: Sdl.Desktop.IntegrationApi
Assembly: Sdl.Desktop.IntegrationApi.dll
Syntax
public abstract class AbstractViewController : AbstractController, IDisposable

Constructors

AbstractViewController()

Declaration
protected AbstractViewController()

Properties

Context

The context in witch the view is executing

Declaration
public virtual IViewContext Context { get; protected set; }
Property Value
Type Description
IViewContext

Methods

Activate()

Activate the view in the Studio application.

Declaration
public virtual void Activate()

Dispose()

Override to implement the dispose of the resources associated with the view.

Declaration
public virtual void Dispose()

Dispose(bool)

Declaration
public virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

GetContentControl()

Get the content control for this view. This control will occupy the content area of the studio window while this view is active.

Declaration
protected virtual IUIControl GetContentControl()
Returns
Type Description
IUIControl

A windows user control.
Remarks

Must be overrided if the view does not allow view parts.

GetExplorerBarControl()

Get the explorer bar control of the view. This control will be placed in the content area of the explorer bar when this view is active.

Declaration
protected virtual IUIControl GetExplorerBarControl()
Returns
Type Description
IUIControl

A Windows Forms control.

Initialize(IViewContext)

Called only once when the controller is initialized

Declaration
protected abstract void Initialize(IViewContext context)
Parameters
Type Name Description
IViewContext context

The context in which the view is initialized.

Refresh()

Called when the view needs to be refreshed.

Declaration
protected virtual void Refresh()
Remarks

By default, this method is also called when the view is being activated.

Events

ActivationChanged

Triggered when the activation of a view is changed

Declaration
public event EventHandler<ActivationChangedEventArgs> ActivationChanged
Event Type
Type Description
EventHandler<ActivationChangedEventArgs>

Implements

Extension Methods