C# Class ComponentFactory.Krypton.Docking.DockingElement

Implements base docking element functionality.

Inheritance: System.ComponentModel.Component, IDockingElement

Mostra file Open project: Cocotteseb/Krypton Class Usage Examples

Private Properties

Property	Type	Description
IEnumerable	IEnumerator

Public Methods

Method	Description
DemandDockingManager ( ) : void	Checks that this element has access to a docking manager, throwing exception if not.
DemandPagesNotBePresent ( KryptonPage pages ) : void	Checks that the provided set of pages are not already present in the docking hierarchy.
DockingElement ( string name ) : System	Initialize a new instance of the DockingElement class.
FindDockingEdgeAutoHidden ( string uniqueName ) : KryptonDockingEdgeAutoHidden	Find a edge auto hidden element by searching the hierarchy.
FindDockingEdgeDocked ( string uniqueName ) : KryptonDockingEdgeDocked	Find a edge docked element by searching the hierarchy.
FindDockingFloating ( string uniqueName ) : KryptonDockingFloating	Find a floating docking element by searching the hierarchy.
FindDockingNavigator ( string uniqueName ) : KryptonDockingNavigator	Find a navigator element by searching the hierarchy.
FindDockingWorkspace ( string uniqueName ) : KryptonDockingWorkspace	Find a workspace element by searching the hierarchy.
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.
GetEnumerator ( ) : IEnumerator	Shallow enumerate over child docking elements.
GetParentType ( Type findType ) : IDockingElement	Search up the parent chain looking for the specified type of object.
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, int value ) : 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.
PropogateCellList ( DockingPropogateCellList state, KryptonWorkspaceCellList cells ) : void	Propogates a workspace cell list request down the hierarchy of docking elements.
PropogateDragTargets ( KryptonFloatingWindow floatingWindow, PageDragEndData dragData, DragTargetList targets ) : void	Propogates a request for drag targets down the hierarchy of docking elements.
PropogateIntState ( DockingPropogateIntState state, int &value ) : void	Propogates an integer 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.
ResolvePath ( string path ) : IDockingElement	Resolve the provided path.
SaveElementToXml ( XmlWriter xmlWriter ) : void	Saves docking configuration information using a provider xml writer.
this ( int index ) : IDockingElement	Gets the docking element at the specified index.
this ( string name ) : IDockingElement	Gets the docking element with the specified name.

Protected Methods

Method	Description
LoadChildDockingElement ( XmlReader xmlReader, KryptonPageCollection pages, IDockingElement child ) : void	Perform docking element specific actions for loading a child xml.
LoadDockingElement ( XmlReader xmlReader, KryptonPageCollection pages ) : void	Perform docking element specific actions based on the loading xml.

Private Methods

Method	Description
IEnumerable ( ) : IEnumerator	Enumerate using non-generic interface.

Method Details

DemandDockingManager() public method

Checks that this element has access to a docking manager, throwing exception if not.

public DemandDockingManager ( ) : void
return	void

DemandPagesNotBePresent() public method

Checks that the provided set of pages are not already present in the docking hierarchy.

public DemandPagesNotBePresent ( KryptonPage pages ) : void
pages	ComponentFactory.Krypton.Navigator.KryptonPage
return	void

DockingElement() public method

Initialize a new instance of the DockingElement class.

public DockingElement ( string name ) : System
name	string	Initial name of the element.
return	System

FindDockingEdgeAutoHidden() public method

Find a edge auto hidden element by searching the hierarchy.

public FindDockingEdgeAutoHidden ( string uniqueName ) : KryptonDockingEdgeAutoHidden
uniqueName	string	Named page for which a suitable auto hidden edge element is required.
return	KryptonDockingEdgeAutoHidden

FindDockingEdgeDocked() public method

Find a edge docked element by searching the hierarchy.

public FindDockingEdgeDocked ( string uniqueName ) : KryptonDockingEdgeDocked
uniqueName	string	Named page for which a suitable docking edge element is required.
return	KryptonDockingEdgeDocked

FindDockingFloating() public method

Find a floating docking element by searching the hierarchy.

public FindDockingFloating ( string uniqueName ) : KryptonDockingFloating
uniqueName	string	Named page for which a suitable floating element is required.
return	KryptonDockingFloating

FindDockingNavigator() public method

Find a navigator element by searching the hierarchy.

public FindDockingNavigator ( string uniqueName ) : KryptonDockingNavigator
uniqueName	string	Named page for which a suitable navigator element is required.
return	KryptonDockingNavigator

FindDockingWorkspace() public method

Find a workspace element by searching the hierarchy.

public FindDockingWorkspace ( string uniqueName ) : KryptonDockingWorkspace
uniqueName	string	Named page for which a suitable workspace element is required.
return	KryptonDockingWorkspace

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

GetEnumerator() public method

Shallow enumerate over child docking elements.

public GetEnumerator ( ) : IEnumerator
return	IEnumerator

GetParentType() public method

Search up the parent chain looking for the specified type of object.

public GetParentType ( Type findType ) : IDockingElement
findType	System.Type	Type of the instance we are searching for.
return	IDockingElement

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

LoadDockingElement() protected method

Perform docking element specific actions based on the loading xml.

protected LoadDockingElement ( XmlReader xmlReader, KryptonPageCollection pages ) : void
xmlReader	XmlReader	Xml reader object.
pages	KryptonPageCollection	Collection of available pages.
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

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, int value ) : void
action	DockingPropogateAction	Action that is requested to be performed.
value	int	Integer value associated with the request.
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?

PropogateCellList() public method

Propogates a workspace cell list request down the hierarchy of docking elements.

public PropogateCellList ( DockingPropogateCellList state, KryptonWorkspaceCellList cells ) : void
state	DockingPropogateCellList	Request that should result in the cells collection being modified.
cells	KryptonWorkspaceCellList	Cells collection for modification by the docking elements.
return	void

PropogateDragTargets() public method

Propogates a request for drag targets down the hierarchy of docking elements.

public PropogateDragTargets ( KryptonFloatingWindow floatingWindow, PageDragEndData dragData, DragTargetList targets ) : void
floatingWindow	KryptonFloatingWindow	Reference to window being dragged.
dragData	ComponentFactory.Krypton.Navigator.PageDragEndData	Set of pages being dragged.
targets	DragTargetList	Collection of drag targets.
return	void

PropogateIntState() public method

Propogates an integer state request down the hierarchy of docking elements.

public PropogateIntState ( DockingPropogateIntState state, int &value ) : void
state	DockingPropogateIntState	Integer state that is requested to be recovered.
value	int	Value discovered from matching
return	void

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

ResolvePath() public method

Resolve the provided path.

public ResolvePath ( string path ) : IDockingElement
path	string	Comma separated list of names to resolve.
return	IDockingElement

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

this() public method

Gets the docking element at the specified index.

public this ( int index ) : IDockingElement
index	int	Index.
return	IDockingElement

this() public method

Gets the docking element with the specified name.

public this ( string name ) : IDockingElement
name	string	Name of element.
return	IDockingElement