C# Class SIL.FieldWorks.Common.Controls.FwPopup

Protected Properties

Property	Type	Description
m_host	ToolStripControlHost
m_monitorMouseOver	bool
m_mouseOver	bool
m_owningDropDown	ToolStripDropDown
m_timer	Timer

Private Properties

Property	Type	Description
InitializeTimer	void
m_owningDropDown_Closed	void
m_owningDropDown_Opened	void
m_owningDropDown_Opening	void
m_timer_Tick	void

Public Methods

Method	Description
CheckDesiredPopupLocation ( Point ptDesired, bool &tooWide, bool &tooTall ) : void	Determines whether or not the popup's right or bottom edge will extend beyond the bounds of the screen if shown at the specified location.
FwPopup ( ) : System	Initializes a new instance of the T:FwPopup class.
Hide ( ) : void	Hides the popup.
Show ( Control ctrl, Point location ) : void	Shows the popup at the specified location (which is relative to ctrl) with the specified owning control.
Show ( Point screenLocation ) : void	Shows the popup at the specified screen location.
m_owningDropDown_VisibleChanged ( object sender, EventArgs e ) : void	Start and stop the timer when the owning drop-down's visibility changes.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.
OnClosed ( ToolStripDropDownClosedEventArgs e ) : void	Handles the Closed event of the popup.
OnMouseEntered ( EventArgs e ) : void	Fires the mouse entered event.
OnMouseLeft ( EventArgs e ) : void	Fires the MouseLeft event.
OnOpened ( EventArgs e ) : void	Handles the Opened event of the popup.
OnOpening ( EventArgs e ) : void	Handles the Opening event of the popup.
OnSizeChanged ( EventArgs e ) : void
OnTimerTick ( ) : void	Fires when the timer Tick event occurs.

Private Methods

Method	Description
InitializeTimer ( ) : void
m_owningDropDown_Closed ( object sender, ToolStripDropDownClosedEventArgs e ) : void	Handles the Closed event of the popup.
m_owningDropDown_Opened ( object sender, EventArgs e ) : void	Handles the Opened event of the popup.
m_owningDropDown_Opening ( object sender, CancelEventArgs e ) : void	Handles the Opening event of the m_owningDropDown control.
m_timer_Tick ( object sender, EventArgs e ) : void

Method Details

CheckDesiredPopupLocation() public method

Determines whether or not the popup's right or bottom edge will extend beyond the bounds of the screen if shown at the specified location.

public CheckDesiredPopupLocation ( Point ptDesired, bool &tooWide, bool &tooTall ) : void
ptDesired	Point
tooWide	bool
tooTall	bool
return	void

Dispose() protected method

Clean up any resources being used.

protected Dispose ( bool disposing ) : void
disposing	bool	true if managed resources should be disposed; otherwise, /// false.
return	void

FwPopup() public method

Initializes a new instance of the T:FwPopup class.

public FwPopup ( ) : System
return	System

Hide() public method

Hides the popup.

public Hide ( ) : void
return	void

OnClosed() protected method

Handles the Closed event of the popup.

protected OnClosed ( ToolStripDropDownClosedEventArgs e ) : void
e	ToolStripDropDownClosedEventArgs
return	void

OnMouseEntered() protected method

Fires the mouse entered event.

protected OnMouseEntered ( EventArgs e ) : void
e	EventArgs
return	void

OnMouseLeft() protected method

Fires the MouseLeft event.

protected OnMouseLeft ( EventArgs e ) : void
e	EventArgs
return	void

OnOpened() protected method

Handles the Opened event of the popup.

protected OnOpened ( EventArgs e ) : void
e	EventArgs
return	void

OnOpening() protected method

Handles the Opening event of the popup.

protected OnOpening ( EventArgs e ) : void
e	EventArgs
return	void

OnSizeChanged() protected method

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

OnTimerTick() protected method

Fires when the timer Tick event occurs.

protected OnTimerTick ( ) : void
return	void

Show() public method

Shows the popup at the specified location (which is relative to ctrl) with the specified owning control.

public Show ( Control ctrl, Point location ) : void
ctrl	Control
location	Point
return	void

Show() public method

Shows the popup at the specified screen location.

public Show ( Point screenLocation ) : void
screenLocation	Point
return	void

m_owningDropDown_VisibleChanged() public method

Start and stop the timer when the owning drop-down's visibility changes.

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

Property Details

m_host protected_oe property

host for this custom control

protected ToolStripControlHost m_host
return	ToolStripControlHost

m_monitorMouseOver protected_oe property

flag indicated whether the mouses movement should be monitored

protected bool m_monitorMouseOver
return	bool

m_mouseOver protected_oe property

flag whether the mouse is within the bounds of the popup

protected bool m_mouseOver
return	bool

m_owningDropDown protected_oe property

owns the host--drop down containing the host that hosts the custom control

protected ToolStripDropDown m_owningDropDown
return	ToolStripDropDown

m_timer protected_oe property

updates m_mouseOver when m_monitorMouseOver is true

protected Timer m_timer
return	Timer