C# Class ComponentFactory.Krypton.Docking.KryptonDockingWorkspace

Inheritance: KryptonDockingSpace
显示文件 Open project: ComponentFactory/Krypton Class Usage Examples

Public Methods

Method Description
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.

HideAllPages ( ) : void

Hide all display elements of all pages.

HidePage ( KryptonPage page ) : void

Hide all display elements of the provided page.

HidePage ( string uniqueName ) : void

Hide all display elements of the provided page.

HidePages ( KryptonPage pages ) : void

Hide all display elements of the provided pages.

HidePages ( string uniqueNames ) : void

Hide all display elements of the provided pages.

KryptonDockingWorkspace ( string name ) : System

Initialize a new instance of the KryptonDockingWorkspace class.

KryptonDockingWorkspace ( string name, string storeName, KryptonDockableWorkspace workspace ) : System

Initialize a new instance of the KryptonDockingWorkspace class.

PropogateAction ( DockingPropogateAction action, string uniqueNames ) : 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.

RemoveAllPages ( bool disposePage ) : void

Remove all pages.

RemovePage ( string uniqueName, bool disposePage ) : void

Remove the named page.

RemovePages ( KryptonPage pages, bool disposePage ) : void

Remove the referenced pages.

RemovePages ( string uniqueNames, bool disposePage ) : void

Remove the named pages.

ShowAllPages ( ) : void

Show all display elements of all pages.

ShowPage ( KryptonPage page ) : void

Show all display elements of the provided page.

ShowPage ( string uniqueName ) : void

Show all display elements of the provided page.

ShowPages ( KryptonPage pages ) : void

Show all display elements of the provided pages.

ShowPages ( string uniqueNames ) : void

Show all display elements of the provided pages.

Protected Methods

Method Description
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
OnDockableWorkspaceBeforePageDrag ( object sender, PageDragCancelEventArgs e ) : void

Method Details

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

HideAllPages() public method

Hide all display elements of all pages.
public HideAllPages ( ) : void
return void

HidePage() public method

Hide all display elements of the provided page.
public HidePage ( KryptonPage page ) : void
page ComponentFactory.Krypton.Navigator.KryptonPage Reference to page that should be hidden.
return void

HidePage() public method

Hide all display elements of the provided page.
public HidePage ( string uniqueName ) : void
uniqueName string Unique name of the page that should be hidden.
return void

HidePages() public method

Hide all display elements of the provided pages.
public HidePages ( KryptonPage pages ) : void
pages ComponentFactory.Krypton.Navigator.KryptonPage Array of references to pages that should be hidden.
return void

HidePages() public method

Hide all display elements of the provided pages.
public HidePages ( string uniqueNames ) : void
uniqueNames string Array of unique names of the pages that should be hidden.
return void

KryptonDockingWorkspace() public method

Initialize a new instance of the KryptonDockingWorkspace class.
public KryptonDockingWorkspace ( string name ) : System
name string Initial name of the element.
return System

KryptonDockingWorkspace() public method

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

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

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

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

RemoveAllPages() public method

Remove all pages.
public RemoveAllPages ( bool disposePage ) : void
disposePage bool Should the page be disposed when removed.
return void

RemovePage() public method

Remove the named page.
public RemovePage ( string uniqueName, bool disposePage ) : void
uniqueName string Unique name of the page that should be removed.
disposePage bool Should the page be disposed when removed.
return void

RemovePages() public method

Remove the referenced pages.
public RemovePages ( KryptonPage pages, bool disposePage ) : void
pages ComponentFactory.Krypton.Navigator.KryptonPage Array of references to pages that should be removed.
disposePage bool Should the page be disposed when removed.
return void

RemovePages() public method

Remove the named pages.
public RemovePages ( string uniqueNames, bool disposePage ) : void
uniqueNames string Array of unique names of the pages that should be removed.
disposePage bool Should the page be disposed when removed.
return void

ShowAllPages() public method

Show all display elements of all pages.
public ShowAllPages ( ) : void
return void

ShowPage() public method

Show all display elements of the provided page.
public ShowPage ( KryptonPage page ) : void
page ComponentFactory.Krypton.Navigator.KryptonPage Reference to page that should be shown.
return void

ShowPage() public method

Show all display elements of the provided page.
public ShowPage ( string uniqueName ) : void
uniqueName string Unique name of the page that should be shown.
return void

ShowPages() public method

Show all display elements of the provided pages.
public ShowPages ( KryptonPage pages ) : void
pages ComponentFactory.Krypton.Navigator.KryptonPage Array of references to pages that should be shown.
return void

ShowPages() public method

Show all display elements of the provided pages.
public ShowPages ( string uniqueNames ) : void
uniqueNames string Array of unique names of the pages that should be shown.
return void