C# Class ComponentFactory.Krypton.Docking.KryptonDockingSpace

Inheritance: DockingElementClosedCollection
Datei anzeigen Open project: ComponentFactory/Krypton

Public Methods

Method Description
Append ( KryptonPage page ) : void

Add a KryptonPage to the currently active cell or create a new cell is no cell is currently active.

CellAppend ( KryptonWorkspaceCell cell, KryptonPage page ) : void

Add a KryptonPage into an existing cell.

CellForPage ( string uniqueName ) : KryptonWorkspaceCell

Return the workspace cell that contains the named page.

CellInsert ( KryptonWorkspaceCell cell, int index, KryptonPage page ) : void

Add a KryptonPage array into an existing cell starting at the provided index.

CellVisiblePages ( string uniqueName ) : ComponentFactory.Krypton.Navigator.KryptonPage[]

Return an array of the visible pages that are inside the cell that contains the provided unique name.

KryptonDockingSpace ( string name, string storeName ) : System

Initialize a new instance of the KryptonDockingSpace 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.

PropogateCellList ( DockingPropogateCellList state, KryptonWorkspaceCellList cells ) : void

Propogates a workspace cell list 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.

SelectPage ( string uniqueName ) : void

Ensure the provided page is selected within the cell that contains it.

UpdateStrings ( ) : void

Update the strings from the docking manager.

Protected Methods

Method Description
LoadDockingElement ( XmlReader xmlReader, KryptonPageCollection pages ) : void

Perform docking element specific actions based on the loading xml.

OnSpaceCellPageInserting ( object sender, KryptonPageEventArgs e ) : void

Occurs when a page is added to a cell in the workspace.

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
OnSpaceCellAdding ( object sender, WorkspaceCellEventArgs e ) : void
OnSpaceCellRemoved ( object sender, EventArgs e ) : void
OnSpaceControlPageLoading ( object sender, PageLoadingEventArgs e ) : void
OnSpaceControlPageSaving ( object sender, PageSavingEventArgs e ) : void
OnSpaceControlRecreateLoadingPage ( object sender, RecreateLoadingPageEventArgs e ) : void
OnSpaceDisposed ( object sender, EventArgs e ) : void

Method Details

Append() public method

Add a KryptonPage to the currently active cell or create a new cell is no cell is currently active.
public Append ( KryptonPage page ) : void
page ComponentFactory.Krypton.Navigator.KryptonPage KryptonPage to be added.
return void

CellAppend() public method

Add a KryptonPage into an existing cell.
public CellAppend ( KryptonWorkspaceCell cell, KryptonPage page ) : void
cell KryptonWorkspaceCell Reference to existing workspace cell.
page ComponentFactory.Krypton.Navigator.KryptonPage KryptonPage instance to be added.
return void

CellForPage() public method

Return the workspace cell that contains the named page.
public CellForPage ( string uniqueName ) : KryptonWorkspaceCell
uniqueName string Unique name for search.
return KryptonWorkspaceCell

CellInsert() public method

Add a KryptonPage array into an existing cell starting at the provided index.
public CellInsert ( KryptonWorkspaceCell cell, int index, KryptonPage page ) : void
cell KryptonWorkspaceCell Reference to existing workspace cell.
index int Index for inserting new pages.
page ComponentFactory.Krypton.Navigator.KryptonPage KryptonPage instance to be added.
return void

CellVisiblePages() public method

Return an array of the visible pages that are inside the cell that contains the provided unique name.
public CellVisiblePages ( string uniqueName ) : ComponentFactory.Krypton.Navigator.KryptonPage[]
uniqueName string Unique name of page that is inside the target cell.
return ComponentFactory.Krypton.Navigator.KryptonPage[]

KryptonDockingSpace() public method

Initialize a new instance of the KryptonDockingSpace class.
public KryptonDockingSpace ( string name, string storeName ) : System
name string Initial name of the element.
storeName string Name to use for storage pages.
return System

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

OnSpaceCellPageInserting() protected method

Occurs when a page is added to a cell in the workspace.
protected OnSpaceCellPageInserting ( object sender, KryptonPageEventArgs e ) : void
sender object Source of the event.
e KryptonPageEventArgs A 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?

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

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

RaiseCellAdding() protected abstract method

Raises the type specific cell adding event determinated by the derived class.
protected abstract RaiseCellAdding ( KryptonWorkspaceCell cell ) : void
cell KryptonWorkspaceCell Referecence to new cell being added.
return void

RaiseCellRemoved() protected abstract method

Raises the type specific cell removed event determinated by the derived class.
protected abstract RaiseCellRemoved ( KryptonWorkspaceCell cell ) : void
cell KryptonWorkspaceCell Referecence to an existing cell being removed.
return void

RaiseRemoved() protected abstract method

Raises the type specific space control removed event determinated by the derived class.
protected abstract RaiseRemoved ( ) : void
return void

RaiseSpacePageDrop() protected abstract method

Occurs when a page is dropped on the control.
protected abstract 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

SelectPage() public method

Ensure the provided page is selected within the cell that contains it.
public SelectPage ( string uniqueName ) : void
uniqueName string Unique name to be selected.
return void

UpdateStrings() public method

Update the strings from the docking manager.
public UpdateStrings ( ) : void
return void