C# Class ClearCanvas.Desktop.Shelf

Represents a shelf within a desktop window.

Inheritance: ClearCanvas.Desktop.DesktopObject, IShelf

Private Properties

Property	Type	Description

Method	Description
Hide ( ) : void	Hides the shelf from view.
Show ( ) : void	Makes the shelf visible.

Method	Description
CanClose ( ) : bool	Checks if the hosted component can exit.
CreateView ( ) : IDesktopObjectView	Creates a view for this shelf.
Dispose ( bool disposing ) : void	Disposes of this object, stopping the hosted component.
Initialize ( ) : void	Starts the hosted component.
PrepareClose ( CloseReason reason ) : bool	Gives the hosted component a chance to prepare for a forced exit.
Shelf ( ClearCanvas.Desktop.ShelfCreationArgs args, DesktopWindow desktopWindow ) : ClearCanvas.Common	Constructor.

Checks if the hosted component can exit.

protected CanClose ( ) : bool
return	bool

Creates a view for this shelf.

protected final CreateView ( ) : IDesktopObjectView
return	IDesktopObjectView

Disposes of this object, stopping the hosted component.

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

Hides the shelf from view.

public Hide ( ) : void
return	void

Starts the hosted component.

protected Initialize ( ) : void
return	void

Gives the hosted component a chance to prepare for a forced exit.

protected PrepareClose ( CloseReason reason ) : bool
reason	CloseReason
return	bool

Constructor.

protected Shelf ( ClearCanvas.Desktop.ShelfCreationArgs args, DesktopWindow desktopWindow ) : ClearCanvas.Common
args	ClearCanvas.Desktop.ShelfCreationArgs	Object used to specify how the should be created.
desktopWindow	DesktopWindow	The owner window of the .
return	ClearCanvas.Common

Makes the shelf visible.

public Show ( ) : void
return	void