Class AbstractViewPartController

Base class used in the implementation and integration of a view part in desktop applications.

Inheritance
System.Object
AbstractController
AbstractViewPartController
Implements
System.IDisposable
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.Desktop.IntegrationApi
Assembly: Sdl.Desktop.IntegrationApi.dll
Syntax
public abstract class AbstractViewPartController : AbstractController, IDisposable

Constructors

AbstractViewPartController()

Declaration
protected AbstractViewPartController()

Fields

ActivationChanged

Triggered when the view part activation state has changed

Declaration
public EventHandler<ActivationChangedEventArgs> ActivationChanged
Field Value
Type Description
System.EventHandler<ActivationChangedEventArgs>

VisibilityChanged

Triggered when the viewpart visibility has been changed.

Declaration
public EventHandler<VisibilityChangedEventArgs> VisibilityChanged
Field Value
Type Description
System.EventHandler<VisibilityChangedEventArgs>

Properties

IsActive

Returns true if the associated view part is currently the active view part in the view.

Declaration
public bool IsActive { get; }
Property Value
Type Description
System.Boolean
Remarks

If the check is done while processing the ActivationChangedevent this property is reflecting the previous state.

IsInView

Returns true if the contents of the viewpart are currently in the viewable area.

Declaration
public bool IsInView { get; }
Property Value
Type Description
System.Boolean

IsVisible

Returns true if the associated view part is currently visible in the view.

Declaration
public bool IsVisible { get; }
Property Value
Type Description
System.Boolean
Remarks

If the check is done while processing the VisibilityChanged event this property is reflecting the previous state.

Methods

Activate()

Shows and activates the view part. To just show aview part without changing the focus to it, use Show().

Declaration
public void Activate()
Remarks

This method has no effect if the corresponding view is not active.

Dispose()

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

Declaration
public virtual void Dispose()

Dispose(Boolean)

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

GetContentControl()

Get the content control for this view part.

Declaration
protected abstract IUIControl GetContentControl()
Returns
Type Description
IUIControl

A windows user control.

Hide()

Hide the view part.

Declaration
public void Hide()

Initialize()

Called only once when the controller is initialized

Declaration
protected abstract void Initialize()

Refresh()

Called when the view part needs to be refreshed.

Declaration
protected virtual void Refresh()
Remarks

This method is called when the view is being activated.

Show()

Shows the view part without switching the input focus to it.

Declaration
public void Show()

Implements

System.IDisposable

Extension Methods