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

Summary description for ViewPropertyItem.

Inheritance: ViewPropertySlice

Exibir arquivo Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method	Description
FinishInit ( ) : void
GetVisibleWSSPropertyValue ( ) : string	Get the visible writing systems list in terms of a singlePropertySequenceValue string. if it hasn't been defined yet, we'll use the WritingSystemOptions for default.
HandleRightMouseClickedEvent ( SimpleRootSite sender, FwRightMouseClickEventArgs e ) : void
Install ( DataTree parent ) : void
OnDataTreeWritingSystemsConfigureDlg ( object args ) : bool	Show a dialog to allow the user to select/unselect multiple writing systems at a time, whether or not to display them (if they don't have data) If they do have data, we show the fields anyhow.
OnDataTreeWritingSystemsShowAll ( object args ) : bool	Show all the available writing system fields for this slice, while it is the "current" slice on the data tree. When it is no longer current, we'll reload/refresh the slice in SetCurrentState().
OnDisplayWritingSystemOptionsForSlice ( object parameter, UIListDisplayProperties &display ) : bool	Populate the writing system options for the slice.
OnPropertyChanged ( string name ) : void	Called when property changed.
Reuse ( ICmObject obj, int flid, int ws, int wsOptional, bool forceIncludeEnglish, bool editable, bool spellCheck ) : void	Reset the slice to the state as if it had been constructed with these arguments. (It is going to be reused for a different record.)
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.
SetCurrentState ( bool isCurrent ) : void	when our slice moves from being current to not being current, we want to redisplay the writing systems configured for that slice, since the user may have selected "Show all for now" which is only valid while the slice is current.
view_LostFocus ( object sender, EventArgs e ) : void

Private Methods

Method	Description
AddWritingSystemListWithIcuLocales ( XCore.UIListDisplayProperties display, IEnumerable list ) : void	stores the list values in terms of icu locale
DoSideEffects ( ) : void
EncodeWssToDisplayPropertyValue ( IEnumerable wss ) : string	convert the given writing systems into a property containing comma-delimited icuLocales.
GetVisibleWritingSystems ( ) : IEnumerable	Gets a list of the visible writing systems stored in our layout part ref override.
GetVisibleWritingSystems ( string singlePropertySequenceValue ) : IEnumerable	Get the writing systems we should actually display right now. That is, from the ones that are currently possible, select any we've previously configured to show.
MultiStringSlice ( ICmObject obj, int flid, int ws, int wsOptional, bool forceIncludeEnglish, bool editable, bool spellCheck ) : System
PersistAndRedisplayWssToDisplayForPart ( IEnumerable wssToDisplay ) : void
PersistAndRedisplayWssToDisplayForPart ( string singlePropertySequenceValue ) : void
ReloadWssToDisplayForPart ( ) : void	reload the WssToDisplay if we haven't defined any, since OnDataTreeWritingSystemsShowAll may have temporary masked them.
SetWssToDisplayForPart ( IEnumerable wssToDisplay ) : void	go through all the data tree slices, finding the slices that refer to the same part as this slice setting them to the same writing systems to display and redisplaying their views.
SetupWssToDisplay ( ) : void	Setup our view's Wss to display from our persisted layout/part ref override
UpdatePronunciationWritingSystems ( IEnumerable newValues ) : void	Get the language project's list of pronunciation writing systems into sync with the supplied list.
view_Display ( object sender, VwEnvEventArgs e ) : void

Method Details

FinishInit() public method

public FinishInit ( ) : void
return	void

GetVisibleWSSPropertyValue() public method

Get the visible writing systems list in terms of a singlePropertySequenceValue string. if it hasn't been defined yet, we'll use the WritingSystemOptions for default.

public GetVisibleWSSPropertyValue ( ) : string
return	string

HandleRightMouseClickedEvent() public method

public HandleRightMouseClickedEvent ( SimpleRootSite sender, FwRightMouseClickEventArgs e ) : void
sender	SIL.FieldWorks.Common.RootSites.SimpleRootSite
e	SIL.FieldWorks.Common.RootSites.FwRightMouseClickEventArgs
return	void

Install() public method

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

OnDataTreeWritingSystemsConfigureDlg() public method

Show a dialog to allow the user to select/unselect multiple writing systems at a time, whether or not to display them (if they don't have data) If they do have data, we show the fields anyhow.

public OnDataTreeWritingSystemsConfigureDlg ( object args ) : bool
args	object
return	bool

OnDataTreeWritingSystemsShowAll() public method

Show all the available writing system fields for this slice, while it is the "current" slice on the data tree. When it is no longer current, we'll reload/refresh the slice in SetCurrentState().

public OnDataTreeWritingSystemsShowAll ( object args ) : bool
args	object
return	bool

OnDisplayWritingSystemOptionsForSlice() public method

Populate the writing system options for the slice.

public OnDisplayWritingSystemOptionsForSlice ( object parameter, UIListDisplayProperties &display ) : bool
parameter	object	The parameter.
display	UIListDisplayProperties	The display.
return	bool

OnPropertyChanged() public method

Called when property changed.

public OnPropertyChanged ( string name ) : void
name	string	The name.
return	void

Reuse() public method

Reset the slice to the state as if it had been constructed with these arguments. (It is going to be reused for a different record.)

public Reuse ( ICmObject obj, int flid, int ws, int wsOptional, bool forceIncludeEnglish, bool editable, bool spellCheck ) : void
obj	ICmObject
flid	int
ws	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

SetCurrentState() public method

when our slice moves from being current to not being current, we want to redisplay the writing systems configured for that slice, since the user may have selected "Show all for now" which is only valid while the slice is current.

public SetCurrentState ( bool isCurrent ) : void
isCurrent	bool
return	void

view_LostFocus() public method

public view_LostFocus ( object sender, EventArgs e ) : void
sender	object
e	EventArgs
return	void