C# Class ComponentFactory.Krypton.Docking.KryptonDockingDockspace

Inheritance: KryptonDockingSpace

Show file Open project: ComponentFactory/Krypton Class Usage Examples

Public Methods

Method	Description
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.
KryptonDockingDockspace ( string name, DockingEdge edge, Size size ) : System	Initialize a new instance of the KryptonDockingDockspace class.
LoadElementFromXml ( XmlReader xmlReader, KryptonPageCollection pages ) : void	Loads docking configuration information using a provider xml reader.
PropogateAction ( DockingPropogateAction action, int value ) : void	Propogates an action 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.
SaveElementToXml ( XmlWriter xmlWriter ) : void	Saves docking configuration information using a provider xml writer.

Protected Methods

Method	Description
OnHasNoVisibleCells ( EventArgs e ) : void	Raises the HasNoVisibleCells event.
OnHasVisibleCells ( EventArgs e ) : void	Raises the HasVisibleCells event.
RaiseCellAdding ( KryptonWorkspaceCell cell ) : void	Raises the type specific cell adding event determinated by the derived class.
RaiseCellRemoved ( KryptonWorkspaceCell cell ) : void	Raises the type specific cell removed event determinated by the derived class.
RaiseRemoved ( ) : void	Raises the type specific space control removed event determinated by the derived class.
RaiseSpacePageDrop ( object sender, PageDropEventArgs e ) : void	Occurs when a page is dropped on the control.

Private Methods

Method	Description
OnDockspaceBeforePageDrag ( object sender, PageDragCancelEventArgs e ) : void
OnDockspaceCellCountChanged ( object sender, EventArgs e ) : void
OnDockspaceCellVisibleCountChanged ( object sender, EventArgs e ) : void
OnDockspaceDropDownClicked ( object sender, CancelDropDownEventArgs e ) : void
OnDockspacePageAutoHiddenClicked ( object sender, UniqueNameEventArgs e ) : void
OnDockspacePageCloseClicked ( object sender, UniqueNameEventArgs e ) : void
OnDockspacePagesDoubleClicked ( object sender, UniqueNamesEventArgs e ) : void

Method Details

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

KryptonDockingDockspace() public method

Initialize a new instance of the KryptonDockingDockspace class.

public KryptonDockingDockspace ( string name, DockingEdge edge, Size size ) : System
name	string	Initial name of the element.
edge	DockingEdge	Docking edge this dockspace is against.
size	System.Drawing.Size	Initial size of the dockspace.
return	System

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

OnHasNoVisibleCells() protected method

Raises the HasNoVisibleCells event.

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

OnHasVisibleCells() protected method

Raises the HasVisibleCells event.

protected OnHasVisibleCells ( EventArgs e ) : void
e	System.EventArgs	An EventArgs containing the event data.
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

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

RaiseCellAdding() protected method

Raises the type specific cell adding event determinated by the derived class.

protected RaiseCellAdding ( KryptonWorkspaceCell cell ) : void
cell	KryptonWorkspaceCell	Referecence to new cell being added.
return	void

RaiseCellRemoved() protected method

Raises the type specific cell removed event determinated by the derived class.

protected RaiseCellRemoved ( KryptonWorkspaceCell cell ) : void
cell	KryptonWorkspaceCell	Referecence to an existing cell being removed.
return	void

RaiseRemoved() protected method

Raises the type specific space control removed event determinated by the derived class.

protected RaiseRemoved ( ) : void
return	void

RaiseSpacePageDrop() protected method

Occurs when a page is dropped on the control.

protected RaiseSpacePageDrop ( object sender, PageDropEventArgs e ) : void
sender	object	Source of the event.
e	ComponentFactory.Krypton.Navigator.PageDropEventArgs	A PageDropEventArgs containing the event data.
return	void

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