C# Class ComponentFactory.Krypton.Docking.KryptonDockingAutoHiddenGroup

Inheritance: DockingElementClosedCollection

Show file Open project: ComponentFactory/Krypton Class Usage Examples

Public Methods

Method	Description
Append ( KryptonPage page ) : void	Add a KryptonPage to the end of the auto hidden group.
FindPageElement ( string uniqueName ) : IDockingElement	Find the docking element that contains the named page.
FindPageLocation ( string uniqueName ) : DockingLocation	Find the docking location of the named page.
FindStorePageElement ( DockingLocation location, string uniqueName ) : IDockingElement	Find the docking element that contains the location specific store page for the named page.
KryptonDockingAutoHiddenGroup ( string name, DockingEdge edge ) : System	Initialize a new instance of the KryptonDockingAutoHiddenGroup class.
LoadElementFromXml ( XmlReader xmlReader, KryptonPageCollection pages ) : void	Loads docking configuration information using a provider xml reader.
PropogateAction ( DockingPropogateAction action, KryptonPage pages ) : void	Propogates an action request down the hierarchy of docking elements.
PropogateAction ( DockingPropogateAction action, string uniqueNames ) : void	Propogates an action request down the hierarchy of docking elements.
PropogateBoolState ( DockingPropogateBoolState state, string uniqueName ) : bool?	Propogates a boolean state request down the hierarchy of docking elements.
PropogatePageList ( DockingPropogatePageList state, KryptonPageCollection pages ) : void	Propogates a page list request down the hierarchy of docking elements.
PropogatePageState ( DockingPropogatePageState state, string uniqueName ) : KryptonPage	Propogates a page request down the hierarchy of docking elements.
SaveElementToXml ( XmlWriter xmlWriter ) : void	Saves docking configuration information using a provider xml writer.
VisiblePages ( ) : ComponentFactory.Krypton.Navigator.KryptonPage[]	Return an array of the visible pages that are inside the auto hidden group.

Protected Methods

Method	Description
LoadChildDockingElement ( XmlReader xmlReader, KryptonPageCollection pages, IDockingElement child ) : void	Perform docking element specific actions for loading a child xml.
OnPageClicked ( KryptonPageEventArgs e ) : void	Raises the PageClicked event.
OnPageHoverEnd ( EventArgs e ) : void	Raises the PageHoverEnd event.
OnPageHoverStart ( KryptonPageEventArgs e ) : void	Raises the PageHoverStart event.

Private Methods

Method	Description
AppendPagesToControl ( KryptonPage pages ) : void
OnAutoHiddenGroupDisposed ( object sender, EventArgs e ) : void
OnAutoHiddenGroupHoverEnd ( object sender, EventArgs e ) : void
OnAutoHiddenGroupHoverStart ( object sender, KryptonPageEventArgs e ) : void
OnAutoHiddenGroupStoringPage ( object sender, UniqueNameEventArgs e ) : void
OnAutoHiddenGroupTabClicked ( object sender, KryptonPageEventArgs e ) : void
OnAutoHiddenGroupTabVisibleCountChanged ( object sender, EventArgs e ) : void

Method Details

Append() public method

Add a KryptonPage to the end of the auto hidden group.

public Append ( KryptonPage page ) : void
page	ComponentFactory.Krypton.Navigator.KryptonPage	KryptonPage to be added.
return	void

FindPageElement() public method

Find the docking element that contains the named page.

public FindPageElement ( string uniqueName ) : IDockingElement
uniqueName	string	Unique name of the page.
return	IDockingElement

FindPageLocation() public method

Find the docking location of the named page.

public FindPageLocation ( string uniqueName ) : DockingLocation
uniqueName	string	Unique name of the page.
return	DockingLocation

FindStorePageElement() public method

Find the docking element that contains the location specific store page for the named page.

public FindStorePageElement ( DockingLocation location, string uniqueName ) : IDockingElement
location	DockingLocation	Location to be searched.
uniqueName	string	Unique name of the page to be found.
return	IDockingElement

KryptonDockingAutoHiddenGroup() public method

Initialize a new instance of the KryptonDockingAutoHiddenGroup class.

public KryptonDockingAutoHiddenGroup ( string name, DockingEdge edge ) : System
name	string	Initial name of the element.
edge	DockingEdge	Docking edge being managed.
return	System

LoadChildDockingElement() protected method

Perform docking element specific actions for loading a child xml.

protected LoadChildDockingElement ( XmlReader xmlReader, KryptonPageCollection pages, IDockingElement child ) : void
xmlReader	XmlReader	Xml reader object.
pages	KryptonPageCollection	Collection of available pages.
child	IDockingElement	Optional reference to existing child docking element.
return	void

LoadElementFromXml() public method

Loads docking configuration information using a provider xml reader.

public LoadElementFromXml ( XmlReader xmlReader, KryptonPageCollection pages ) : void
xmlReader	XmlReader	Xml reader object.
pages	KryptonPageCollection	Collection of available pages for adding.
return	void

OnPageClicked() protected method

Raises the PageClicked event.

protected OnPageClicked ( KryptonPageEventArgs e ) : void
e	KryptonPageEventArgs	An KryptonPageEventArgs containing the event data.
return	void

OnPageHoverEnd() protected method

Raises the PageHoverEnd event.

protected OnPageHoverEnd ( EventArgs e ) : void
e	System.EventArgs	An EventArgs containing the event data.
return	void

OnPageHoverStart() protected method

Raises the PageHoverStart event.

protected OnPageHoverStart ( KryptonPageEventArgs e ) : void
e	KryptonPageEventArgs	An KryptonPageEventArgs containing the event data.
return	void

PropogateAction() public method

Propogates an action request down the hierarchy of docking elements.

public PropogateAction ( DockingPropogateAction action, KryptonPage pages ) : void
action	DockingPropogateAction	Action that is requested to be performed.
pages	ComponentFactory.Krypton.Navigator.KryptonPage	Array of pages the action relates to.
return	void

PropogateAction() public method

Propogates an action request down the hierarchy of docking elements.

public PropogateAction ( DockingPropogateAction action, string uniqueNames ) : void
action	DockingPropogateAction	Action that is requested to be performed.
uniqueNames	string	Array of unique names of the pages the action relates to.
return	void

PropogateBoolState() public method

Propogates a boolean state request down the hierarchy of docking elements.

public PropogateBoolState ( DockingPropogateBoolState state, string uniqueName ) : bool?
state	DockingPropogateBoolState	Boolean state that is requested to be recovered.
uniqueName	string	Unique name of the page the request relates to.
return	bool?

PropogatePageList() public method

Propogates a page list request down the hierarchy of docking elements.

public PropogatePageList ( DockingPropogatePageList state, KryptonPageCollection pages ) : void
state	DockingPropogatePageList	Request that should result in pages collection being modified.
pages	KryptonPageCollection	Pages collection for modification by the docking elements.
return	void

PropogatePageState() public method

Propogates a page request down the hierarchy of docking elements.

public PropogatePageState ( DockingPropogatePageState state, string uniqueName ) : KryptonPage
state	DockingPropogatePageState	Request that should result in a page reference if found.
uniqueName	string	Unique name of the page the request relates to.
return	ComponentFactory.Krypton.Navigator.KryptonPage

SaveElementToXml() public method

Saves docking configuration information using a provider xml writer.

public SaveElementToXml ( XmlWriter xmlWriter ) : void
xmlWriter	System.Xml.XmlWriter	Xml writer object.
return	void

VisiblePages() public method

Return an array of the visible pages that are inside the auto hidden group.

public VisiblePages ( ) : ComponentFactory.Krypton.Navigator.KryptonPage[]
return	ComponentFactory.Krypton.Navigator.KryptonPage[]