C# Class ClearCanvas.ImageViewer.DisplaySet

Inheritance: IDisplaySet

Show file Open project: jasper-yeh/ClearCanvas Class Usage Examples

Private Properties

Property	Type	Description
DisposePresentationImages	void
Initialize	void
OnPresentationImageAdded	void
OnPresentationImageChanged	void
OnPresentationImageChanging	void
OnPresentationImageRemoved	void

Public Methods

Method	Description
Clone ( ) : IDisplaySet	Creates a deep copy of the IDisplaySet. IDisplaySets may not return null from this method.
CreateFreshCopy ( ) : IDisplaySet	Creates a fresh copy of the IDisplaySet. This will instantiate a fresh copy of this IDisplaySet using the same construction parameters as the original.
CreateMemento ( ) : object	Captures the state of an object. The implementation of IMemorable.CreateMemento should return an object containing enough state information so that when IMemorable.SetMemento is called, the object can be restored to the original state.
DisplaySet ( ) : System	Initializes a new instance of DisplaySet.
DisplaySet ( ClearCanvas.ImageViewer.DisplaySetDescriptor descriptor ) : System	Initializes a new instance of DisplaySet with the given DisplaySetDescriptor.
DisplaySet ( string name, string uid ) : System	Initializes a new instance of DisplaySet with the specified parameters.
Dispose ( ) : void	Releases all resources used by this DisplaySet.
Draw ( ) : void	Draws the DisplaySet. The DisplaySet will only be drawn if it is currently visible.
SetMemento ( object memento ) : void	Restores the state of an object. The implementation of IMemorable.SetMemento should return the object to the original state captured by IMemorable.CreateMemento.
ToString ( ) : string	Returns the name of the display set.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Implementation of the IDisposable pattern
OnDrawing ( ) : void	Raises the Drawing event.
OnPresentationImageAdded ( ClearCanvas.ImageViewer.PresentationImage image ) : void	Called when a PresentationImage has been added to the display set.
OnPresentationImageRemoved ( ClearCanvas.ImageViewer.PresentationImage image ) : void	Called when a PresentationImage has been removed from the display set.

Private Methods

Method	Description
DisposePresentationImages ( ) : void
Initialize ( DisplaySet source, ICloningContext context ) : void
OnPresentationImageAdded ( object sender, ListEventArgs e ) : void
OnPresentationImageChanged ( object sender, ListEventArgs e ) : void
OnPresentationImageChanging ( object sender, ListEventArgs e ) : void
OnPresentationImageRemoved ( object sender, ListEventArgs e ) : void

Method Details

Clone() public method

Creates a deep copy of the IDisplaySet.

IDisplaySets may not return null from this method.

public Clone ( ) : IDisplaySet
return	IDisplaySet

CreateFreshCopy() public method

Creates a fresh copy of the IDisplaySet.

This will instantiate a fresh copy of this IDisplaySet using the same construction parameters as the original.

public CreateFreshCopy ( ) : IDisplaySet
return	IDisplaySet

CreateMemento() public method

Captures the state of an object.

The implementation of IMemorable.CreateMemento should return an object containing enough state information so that when IMemorable.SetMemento is called, the object can be restored to the original state.

public CreateMemento ( ) : object
return	object

DisplaySet() public method

Initializes a new instance of DisplaySet.

public DisplaySet ( ) : System
return	System

DisplaySet() public method

Initializes a new instance of DisplaySet with the given DisplaySetDescriptor.

public DisplaySet ( ClearCanvas.ImageViewer.DisplaySetDescriptor descriptor ) : System
descriptor	ClearCanvas.ImageViewer.DisplaySetDescriptor
return	System

DisplaySet() public method

Initializes a new instance of DisplaySet with the specified parameters.

public DisplaySet ( string name, string uid ) : System
name	string
uid	string
return	System

Dispose() public method

Releases all resources used by this DisplaySet.

public Dispose ( ) : void
return	void

Dispose() protected method

Implementation of the IDisposable pattern

protected Dispose ( bool disposing ) : void
disposing	bool	True if this object is being disposed, false if it is being finalized
return	void

Draw() public method

Draws the DisplaySet.

The DisplaySet will only be drawn if it is currently visible.

public Draw ( ) : void
return	void

OnDrawing() protected method

Raises the Drawing event.

protected OnDrawing ( ) : void
return	void

OnPresentationImageAdded() protected method

Called when a PresentationImage has been added to the display set.

protected OnPresentationImageAdded ( ClearCanvas.ImageViewer.PresentationImage image ) : void
image	ClearCanvas.ImageViewer.PresentationImage	The image that was added to the display set.
return	void

OnPresentationImageRemoved() protected method

Called when a PresentationImage has been removed from the display set.

protected OnPresentationImageRemoved ( ClearCanvas.ImageViewer.PresentationImage image ) : void
image	ClearCanvas.ImageViewer.PresentationImage	The image that was removed from the display set.
return	void

SetMemento() public method

Restores the state of an object.

The implementation of IMemorable.SetMemento should return the object to the original state captured by IMemorable.CreateMemento.

public SetMemento ( object memento ) : void
memento	object	The object that was /// originally created with .
return	void

ToString() public method

Returns the name of the display set.

public ToString ( ) : string
return	string