C# Class SIL.FieldWorks.Common.Framework.DetailControls.ViewSlice

A tree control item where the embedded form is a View (specifically SIL.FieldWorks.Common.Framework.RootSite).
Inheritance: Slice
Show file Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method Description
AboutToDiscard ( ) : void

Somehow a slice (I think one that has never scrolled to become visible?) can get an OnLoad message for its view in the course of deleting it from the parent controls collection. This can be bad (at best it's a waste of time to do the Layout in the OnLoad, but it can be actively harmful if the object the view is displaying has been deleted). So suppress it.
BecomeRealInPlace ( ) : bool

Some 'unreal' slices can become 'real' (ready to actually display) without actually replacing themselves with a different object. Such slices override this method to do whatever is needed and then answer true. If a slice answers false to IsRealSlice, this is tried, and if it returns false, then BecomeReal is called.
HandleLayoutSizeChanged ( object sender, EventArgs ea ) : void

Install ( DataTree parent ) : void

ViewSlice ( ) : System

ViewSlice ( SimpleRootSite ctrlT ) : System

rs_SizeChanged ( object sender, EventArgs e ) : void

Protected Methods

Method Description
DesiredHeight ( SIL.FieldWorks.Common.RootSites.RootSite rs ) : int

The height that the slice would ideally be to accommodate the rootsite.
Dispose ( bool disposing ) : void

Executes in two distinct scenarios. 1. If disposing is true, the method has been called directly or indirectly by a user's code via the Dispose method. Both managed and unmanaged resources can be disposed. 2. If disposing is false, the method has been called by the runtime from inside the finalizer and you should not reference (access) other managed objects, as they already have been garbage collected. Only unmanaged resources can be disposed.

If any exceptions are thrown, that is fine. If the method is being done in a finalizer, it will be ignored. If it is thrown by client code calling Dispose, it needs to be handled by fixing the bug. If subclasses override this method, they should call the base implementation.

InternalInitialize ( ) : void
OnSizeChanged ( EventArgs e ) : void
SetWidthForDataTreeLayout ( int width ) : void

Private Methods

Method Description
SetHeightFromRootBox ( SIL.FieldWorks.Common.RootSites.RootSite rs ) : void
ViewSlice_Enter ( object sender, System e ) : void

Method Details

AboutToDiscard() public method

Somehow a slice (I think one that has never scrolled to become visible?) can get an OnLoad message for its view in the course of deleting it from the parent controls collection. This can be bad (at best it's a waste of time to do the Layout in the OnLoad, but it can be actively harmful if the object the view is displaying has been deleted). So suppress it.
public AboutToDiscard ( ) : void
return void

BecomeRealInPlace() public method

Some 'unreal' slices can become 'real' (ready to actually display) without actually replacing themselves with a different object. Such slices override this method to do whatever is needed and then answer true. If a slice answers false to IsRealSlice, this is tried, and if it returns false, then BecomeReal is called.
public BecomeRealInPlace ( ) : bool
return bool

DesiredHeight() protected method

The height that the slice would ideally be to accommodate the rootsite.
protected DesiredHeight ( SIL.FieldWorks.Common.RootSites.RootSite rs ) : int
rs SIL.FieldWorks.Common.RootSites.RootSite
return int

Dispose() protected method

Executes in two distinct scenarios. 1. If disposing is true, the method has been called directly or indirectly by a user's code via the Dispose method. Both managed and unmanaged resources can be disposed. 2. If disposing is false, the method has been called by the runtime from inside the finalizer and you should not reference (access) other managed objects, as they already have been garbage collected. Only unmanaged resources can be disposed.
If any exceptions are thrown, that is fine. If the method is being done in a finalizer, it will be ignored. If it is thrown by client code calling Dispose, it needs to be handled by fixing the bug. If subclasses override this method, they should call the base implementation.
protected Dispose ( bool disposing ) : void
disposing bool
return void

HandleLayoutSizeChanged() public method

public HandleLayoutSizeChanged ( object sender, EventArgs ea ) : void
sender object
ea System.EventArgs
return void

Install() public method

public Install ( DataTree parent ) : void
parent DataTree
return void

InternalInitialize() protected method

protected InternalInitialize ( ) : void
return void

OnSizeChanged() protected method

protected OnSizeChanged ( EventArgs e ) : void
e System.EventArgs
return void

SetWidthForDataTreeLayout() protected method

protected SetWidthForDataTreeLayout ( int width ) : void
width int
return void

ViewSlice() public method

public ViewSlice ( ) : System
return System

ViewSlice() public method

public ViewSlice ( SimpleRootSite ctrlT ) : System
ctrlT SIL.FieldWorks.Common.RootSites.SimpleRootSite
return System

rs_SizeChanged() public method

public rs_SizeChanged ( object sender, EventArgs e ) : void
sender object
e System.EventArgs
return void