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

Inheritance: System.Windows.Forms.UserControl, IFWDisposable, INotifyControlInCurrentSlice

Datei anzeigen Open project: sillsdev/FieldWorks Class Usage Examples

Protected Properties

Property	Type	Description
m_btnLauncher	System.Windows.Forms.Button
m_cache	SIL.FieldWorks.FDO.FdoCache
m_configurationNode	System.Xml.XmlNode
m_displayNameProperty	string
m_displayWs	string
m_fieldName	string
m_flid	int
m_mainControl	System.Windows.Forms.Control
m_mediator	XCore.Mediator
m_obj	ICmObject
m_panel	System.Windows.Forms.Panel
m_persistProvider	IPersistenceProvider

Private Properties

Property	Type	Description
InitializeComponent	void

Public Methods

Method	Description
ButtonLauncher ( ) : System	Initializes a new instance of the ReferenceLauncher class.
CheckDisposed ( ) : void	Throw if the IsDisposed property is true
Initialize ( SIL.FieldWorks.FDO.FdoCache cache, ICmObject obj, int flid, string fieldName, IPersistenceProvider persistProvider, XCore.Mediator mediator, string displayNameProperty, string displayWs ) : void	Initialize the launcher.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.
HandleChooser ( ) : void	Handle launching of the standard chooser. Subclasses should override this method.
OnClick ( Object sender, EventArgs arguments ) : void	Handle the click event for the launcher button.
OnObjectCreated ( ) : void	Notifies that m_obj has been created.
ReferenceLauncher_Enter ( object sender, EventArgs e ) : void
ReferenceLauncher_Leave ( object sender, System e ) : void

Private Methods

Method	Description
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.

Method Details

ButtonLauncher() public method

Initializes a new instance of the ReferenceLauncher class.

public ButtonLauncher ( ) : System
return	System

CheckDisposed() public method

Throw if the IsDisposed property is true

public CheckDisposed ( ) : void
return	void

Dispose() protected method

Clean up any resources being used.

protected Dispose ( bool disposing ) : void
disposing	bool	true to release both managed and unmanaged /// resources; false to release only unmanaged resources. ///
return	void

HandleChooser() protected method

Handle launching of the standard chooser.

Subclasses should override this method.

protected HandleChooser ( ) : void
return	void

Initialize() public method

Initialize the launcher.

public Initialize ( SIL.FieldWorks.FDO.FdoCache cache, ICmObject obj, int flid, string fieldName, IPersistenceProvider persistProvider, XCore.Mediator mediator, string displayNameProperty, string displayWs ) : void
cache	SIL.FieldWorks.FDO.FdoCache
obj	ICmObject
flid	int
fieldName	string
persistProvider	IPersistenceProvider
mediator	XCore.Mediator
displayNameProperty	string
displayWs	string
return	void

OnClick() protected method

Handle the click event for the launcher button.

protected OnClick ( Object sender, EventArgs arguments ) : void
sender	Object
arguments	System.EventArgs
return	void

OnObjectCreated() protected method

Notifies that m_obj has been created.

protected OnObjectCreated ( ) : void
return	void

ReferenceLauncher_Enter() protected method

protected ReferenceLauncher_Enter ( object sender, EventArgs e ) : void
sender	object
e	System.EventArgs
return	void

ReferenceLauncher_Leave() protected method

protected ReferenceLauncher_Leave ( object sender, System e ) : void
sender	object
e	System
return	void

Property Details

m_btnLauncher protected_oe property

protected Button,System.Windows.Forms m_btnLauncher
return	System.Windows.Forms.Button

m_cache protected_oe property

protected FdoCache,SIL.FieldWorks.FDO m_cache
return	SIL.FieldWorks.FDO.FdoCache

m_configurationNode protected_oe property

protected XmlNode,System.Xml m_configurationNode
return	System.Xml.XmlNode

m_displayNameProperty protected_oe property

protected string m_displayNameProperty
return	string

m_displayWs protected_oe property

protected string m_displayWs
return	string

m_fieldName protected_oe property

protected string m_fieldName
return	string

m_flid protected_oe property

protected int m_flid
return	int

m_mainControl protected_oe property

protected Control,System.Windows.Forms m_mainControl
return	System.Windows.Forms.Control

m_mediator protected_oe property

protected Mediator,XCore m_mediator
return	XCore.Mediator

m_obj protected_oe property

protected ICmObject m_obj
return	ICmObject

m_panel protected_oe property

protected Panel,System.Windows.Forms m_panel
return	System.Windows.Forms.Panel

m_persistProvider protected_oe property

protected IPersistenceProvider m_persistProvider
return	IPersistenceProvider