C# Class SIL.FieldWorks.FwCoreDlgs.SampleView

Inheritance: SIL.FieldWorks.Common.RootSites.SimpleRootSite

Datei anzeigen Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method	Description
AddPara ( ITsString tss ) : void	Add a new string as the next line of the text. Does not display. Call Complete() to update after adding all lines.
AddPara ( string para ) : void	Add a sample paragraph just using a string. A TsString encoded using the UI writing system is created.
Clear ( bool fReconstruct ) : void	Clear all text. If fReconstruct is true, also clears the display.
CompleteSetText ( ) : void	Call this when done adding paragraphs. The typical calling sequence is Clear(), AddPara() x n, CompleteSetText().
MakeRoot ( ) : void	Make the root box.

Protected Methods

Method	Description
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.

Private Methods

Method	Description
OnKeyDown ( KeyEventArgs e ) : void

Method Details

AddPara() public method

Add a new string as the next line of the text. Does not display. Call Complete() to update after adding all lines.

public AddPara ( ITsString tss ) : void
tss	ITsString
return	void

AddPara() public method

Add a sample paragraph just using a string. A TsString encoded using the UI writing system is created.

public AddPara ( string para ) : void
para	string
return	void

Clear() public method

Clear all text. If fReconstruct is true, also clears the display.

public Clear ( bool fReconstruct ) : void
fReconstruct	bool
return	void

CompleteSetText() public method

Call this when done adding paragraphs. The typical calling sequence is Clear(), AddPara() x n, CompleteSetText().

public CompleteSetText ( ) : void
return	void

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

MakeRoot() public method

Make the root box.

public MakeRoot ( ) : void
return	void