C# Class SIL.FieldWorks.LexText.Controls.InsertionControl

This class represents a rule insertion control. A rule insertion control consists of a set of hotlinks that are used to insert various rule items. Rule formula controls provide information about which type of items it is interested in inserting and in what context the hotlinks should be displayed. It provides an Insert event that indicates when a user has attempted to insert an item.

Inheritance: System.Windows.Forms.UserControl, IFWDisposable

Show file Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method	Description
AddMultiOption ( object option, bool>.Func shouldDisplay, Func	Adds an index option. A predicate can be provided to determine what indices to display.
AddOption ( object option, bool>.Func shouldDisplay ) : void	Adds an insertion option. A predicate can be provided to determine in what contexts this insertion option can be displayed.
CheckDisposed ( ) : void	Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.
InsertionControl ( ) : System

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.
OnSizeChanged ( EventArgs e ) : void

Private Methods

Method	Description
InitializeComponent ( ) : void
UpdateOptionsDisplay ( ) : void
link_LinkClicked ( object sender, LinkLabelLinkClickedEventArgs e ) : void

Method Details

AddMultiOption() public method

Adds an index option. A predicate can be provided to determine what indices to display.

public AddMultiOption ( object option, bool>.Func shouldDisplay, Func
option	object
shouldDisplay	bool>.Func	The should display predicate.
displaySuboptions	Func
return	void

AddOption() public method

Adds an insertion option. A predicate can be provided to determine in what contexts this insertion option can be displayed.

public AddOption ( object option, bool>.Func shouldDisplay ) : void
option	object
shouldDisplay	bool>.Func	The should display predicate.
return	void

CheckDisposed() public method

Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.

public CheckDisposed ( ) : void
return	void

Dispose() protected method

Clean up any resources being used.

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

InsertionControl() public method

public InsertionControl ( ) : System
return	System

OnSizeChanged() protected method

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