C# Class SIL.FieldWorks.IText.Sandbox

The 'Sandbox' is a small view used to edit the data associated with a single Wordform... specifically, the data associated with a standard interlinear view. It uses a different, simpler model than the real interlinear view, documented below under the constants we use to describe it. This view makes editing easier. A further advantage is that we don't have to worry, until the view closes, about whether the user is editing one of the existing analyses or creating a new one.

Inheritance: SandboxBase, IAnalysisControlInternal

Show file Open project: sillsdev/FieldWorks Class Usage Examples

Private Properties

Property	Type	Description
IAnalysisControlInternal	void

Public Methods

Method	Description
Sandbox ( ) : System.Linq	Default Constructor.
Sandbox ( SIL.FieldWorks.FDO.FdoCache cache, XCore.Mediator mediator, IVwStylesheet ss, SIL.FieldWorks.IText.InterlinLineChoices choices ) : System.Linq
Sandbox ( SIL.FieldWorks.FDO.FdoCache cache, XCore.Mediator mediator, IVwStylesheet ss, SIL.FieldWorks.IText.InterlinLineChoices choices, SIL.FieldWorks.FDO.DomainServices.AnalysisOccurrence selected, FocusBoxController focusBox ) : System.Linq	Create a new one.
SwitchWord ( SIL.FieldWorks.FDO.DomainServices.AnalysisOccurrence selected ) : void	Set up the sandbox to display the specified analysis, hvoAnalysis, which might be a WfiWordform, WfiAnalysis, or WfiGloss.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.
LoadForWordBundleAnalysis ( int hvoAnalysis ) : void	We don't want to do a load on our hvoAnalysis until our HvoAnnotation is setup.
OnHandleEnter ( ) : void

Private Methods

Method	Description
IAnalysisControlInternal ( ) : void	This function will undo the last changes done to the project. This function is executed when the user clicks the undo menu item.

Method Details

Dispose() protected method

Clean up any resources being used.

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

LoadForWordBundleAnalysis() protected method

We don't want to do a load on our hvoAnalysis until our HvoAnnotation is setup.

protected LoadForWordBundleAnalysis ( int hvoAnalysis ) : void
hvoAnalysis	int
return	void

OnHandleEnter() protected method

protected OnHandleEnter ( ) : void
return	void

Sandbox() public method

Default Constructor.

public Sandbox ( ) : System.Linq
return	System.Linq

Sandbox() public method

public Sandbox ( SIL.FieldWorks.FDO.FdoCache cache, XCore.Mediator mediator, IVwStylesheet ss, SIL.FieldWorks.IText.InterlinLineChoices choices ) : System.Linq
cache	SIL.FieldWorks.FDO.FdoCache
mediator	XCore.Mediator
ss	IVwStylesheet
choices	SIL.FieldWorks.IText.InterlinLineChoices
return	System.Linq

Sandbox() public method

Create a new one.

public Sandbox ( SIL.FieldWorks.FDO.FdoCache cache, XCore.Mediator mediator, IVwStylesheet ss, SIL.FieldWorks.IText.InterlinLineChoices choices, SIL.FieldWorks.FDO.DomainServices.AnalysisOccurrence selected, FocusBoxController focusBox ) : System.Linq
cache	SIL.FieldWorks.FDO.FdoCache
mediator	XCore.Mediator
ss	IVwStylesheet
choices	SIL.FieldWorks.IText.InterlinLineChoices
selected	SIL.FieldWorks.FDO.DomainServices.AnalysisOccurrence
focusBox	FocusBoxController
return	System.Linq

SwitchWord() public method

Set up the sandbox to display the specified analysis, hvoAnalysis, which might be a WfiWordform, WfiAnalysis, or WfiGloss.

public SwitchWord ( SIL.FieldWorks.FDO.DomainServices.AnalysisOccurrence selected ) : void
selected	SIL.FieldWorks.FDO.DomainServices.AnalysisOccurrence
return	void