C# Class SIL.FieldWorks.Common.Widgets.LabeledMultiStringView

LabeledMultiStringView displays one or more writing system alternatives of a string property. It simply edits that property.

Inheritance: SIL.FieldWorks.Common.RootSites.RootSiteControl

Show file Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method	Description
CheckDisposed ( ) : void	Throw if the IsDisposed property is true
FinishInit ( ) : void	Call this on initialization when all properties (e.g., ConfigurationNode) are set. The purpose is when reusing the slice, when we may have to reconstruct the root box.
FinishInit ( XmlNode configurationNode ) : void	Get any text styles from configuration node (which is now available; it was not at construction)
GetMessageTargets ( ) : IxCoreColleague[]	Required method for IXCoreColleague. Return the message targets for the inner view.
GetWritingSystemOptions ( bool fIncludeUncheckedActiveWss ) : List	returns a list of the writing systems available to display for this view
Init ( XCore.Mediator mediator, XmlNode configurationParameters ) : void	Required method for IXCoreColleague. As a colleague, it behaves exactly like its inner view.
LabeledMultiStringView ( int hvo, int flid, int wsMagic, bool forceIncludeEnglish, bool editable ) : System	Constructor.
LabeledMultiStringView ( int hvo, int flid, int wsMagic, int wsOptional, bool forceIncludeEnglish, bool editable, bool spellCheck ) : System	Constructor.
RefreshDisplay ( ) : bool	On a major refresh, the writing system list may have changed; update accordingly.
Reuse ( int hvo, int flid, int wsMagic, int wsOptional, bool forceIncludeEnglish, bool editable, bool spellCheck ) : void	Re-initialize this view as if it had been constructed with the specified arguments.
SelectAt ( int ws, int ich ) : void	Make a selection in the specified writing system at the specified character offset. Note: selecting other than the first writing system is not yet implemented.

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.
OnLayout ( LayoutEventArgs levent ) : void	Arrange our sound controls if any.

Private Methods

Method	Description
CreateNewSoundFilename ( string &path ) : string
DisposeSoundControls ( ) : void
SetupSoundControls ( ) : void
TriggerDisplay ( IVwEnv vwenv ) : void
WsForSoundField ( ShortSoundFieldControl sc, int &wsIndex ) : IWritingSystem	If we're shutting down, this might return null
soundFieldControl_BeforeStartingToRecord ( object sender, EventArgs e ) : void
soundFieldControl_SoundDeleted ( object sender, EventArgs e ) : void
soundFieldControl_SoundRecorded ( object sender, EventArgs e ) : void

Method Details

CheckDisposed() public method

Throw if the IsDisposed property is true

public CheckDisposed ( ) : 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

FinishInit() public method

Call this on initialization when all properties (e.g., ConfigurationNode) are set. The purpose is when reusing the slice, when we may have to reconstruct the root box.

public FinishInit ( ) : void
return	void

FinishInit() public method

Get any text styles from configuration node (which is now available; it was not at construction)

public FinishInit ( XmlNode configurationNode ) : void
configurationNode	System.Xml.XmlNode
return	void

GetMessageTargets() public method

Required method for IXCoreColleague. Return the message targets for the inner view.

public GetMessageTargets ( ) : IxCoreColleague[]
return	IxCoreColleague[]

GetWritingSystemOptions() public method

returns a list of the writing systems available to display for this view

public GetWritingSystemOptions ( bool fIncludeUncheckedActiveWss ) : List
fIncludeUncheckedActiveWss	bool	if false, include only current wss, /// if true, includes unchecked active wss.
return	List

Init() public method

Required method for IXCoreColleague. As a colleague, it behaves exactly like its inner view.

public Init ( XCore.Mediator mediator, XmlNode configurationParameters ) : void
mediator	XCore.Mediator
configurationParameters	System.Xml.XmlNode
return	void

LabeledMultiStringView() public method

Constructor.

public LabeledMultiStringView ( int hvo, int flid, int wsMagic, bool forceIncludeEnglish, bool editable ) : System
hvo	int
flid	int
wsMagic	int
forceIncludeEnglish	bool
editable	bool
return	System

LabeledMultiStringView() public method

Constructor.

public LabeledMultiStringView ( int hvo, int flid, int wsMagic, int wsOptional, bool forceIncludeEnglish, bool editable, bool spellCheck ) : System
hvo	int
flid	int
wsMagic	int
wsOptional	int
forceIncludeEnglish	bool
editable	bool
spellCheck	bool
return	System

OnLayout() protected method

Arrange our sound controls if any.

protected OnLayout ( LayoutEventArgs levent ) : void
levent	LayoutEventArgs
return	void

RefreshDisplay() public method

On a major refresh, the writing system list may have changed; update accordingly.

public RefreshDisplay ( ) : bool
return	bool

Reuse() public method

Re-initialize this view as if it had been constructed with the specified arguments.

public Reuse ( int hvo, int flid, int wsMagic, int wsOptional, bool forceIncludeEnglish, bool editable, bool spellCheck ) : void
hvo	int
flid	int
wsMagic	int
wsOptional	int
forceIncludeEnglish	bool
editable	bool
spellCheck	bool
return	void

SelectAt() public method

Make a selection in the specified writing system at the specified character offset. Note: selecting other than the first writing system is not yet implemented.

public SelectAt ( int ws, int ich ) : void
ws	int
ich	int
return	void