Navigation:  API Change History > 1.3 >

Breaking Changes

Previous pageReturn to chapter overviewNext page

Common.Actions

Type

Change

IXmlActionCompilerOperator<T>

Changed generic types

From:

public interface IXmlActionCompilerOperator<T>

To:

public interface IXmlActionCompilerOperator<TActionContext, TSchemaContext>

Changed method

From:

public abstract System.Xml.Schema.XmlSchemaElement GetSchema()

To:

public abstract System.Xml.Schema.XmlSchemaElement GetSchema(TSchemaContext context);

XmlActionCompiler<T>

Changed generic types

From:

public class XmlActionCompiler<T>

To:

public class XmlActionCompiler<TActionContext, TSchemaContext>

Removed property public System.Xml.Schema.XmlSchema Schema { get; }

XmlActionCompilerOperatorExtensionPoint<T>

Changed generic types

From:

public sealed class XmlActionCompilerOperatorExtensionPoint<T> : ExtensionPoint<IXmlActionCompilerOperator<T>>

To:

public sealed class XmlActionCompilerOperatorExtensionPoint<TActionContext, TSchemaContext> : ExtensionPoint<IXmlActionCompilerOperator<TActionContext, TSchemaContext>>

Common.Specifications

Type

Change

RegexSpecification

Changed constructor parameters

From:

public RegexSpecification(System.String pattern, bool ignoreCase);

To:

public RegexSpecification(System.String pattern, bool ignoreCase, bool nullMatches);

Common.Statistics

Type

Change

RateStatistics

Changed property

From:

public long ElapsedTime { get; }

To:

public TimeSpan ElapsedTime { get; }

Common.Utilities

Type

Change

ObjectWalker

Removed constructor public ObjectWalker (MemberHandlerDelegate memberHandler);

Removed constructor public ObjectWalker (MemberHandlerDelegate memberHandler, MemberFilterDelegate memberFilter);

Removed property public MemberFilterDelegate MemberFilter { get; set; }

Removed property public MemberHandlerDelegate MemberHandler { get; set; }

Removed delegate public delegate bool MemberFilterDelegate(MemberInfo property);

Removed delegate public delegate void MemberHandlerDelegate(IObjectMemberContext context);

Changed method

From:

public void Walk(System.Object obj);

To:

public IEnumerable<IObjectMemberContext> Walk(System.Object obj);

Changed method

From:

public void Walk(System.Type type);

To:

public IEnumerable<ClearCanvas.Common.Utilities.IObjectMemberContext> Walk(System.Type type);

Desktop

Type

Change

Path

Changed property

From:

public PathSegment[] Segments { get; set; }

To:

public IList<PathSegment> Segments { get; }

Changed method parameters

From:

public Path SubPath(int depth);

To:

public Path SubPath(int start, int count);

IDesktopWindow

Added method public FileDialogResult ShowOpenFileDialogBox(FileDialogCreationArgs args);

Added method public FileDialogResult ShowSaveFileDialogBox(FileDialogCreationArgs args);

IDesktopWindowView

Added method public FileDialogResult ShowOpenFileDialogBox(FileDialogCreationArgs args);

Added method public FileDialogResult ShowSaveFileDialogBox(FileDialogCreationArgs args);

IGalleryItem

Added property public System.String Name { get; set; }

IWorkspaceHost

Added property public bool IsWorkspaceActive { get; }

Added event public event System.EventHandler IsWorkspaceActiveChanged;

UndoableCommand

Made class abstract public abstract class UndoableCommand : Command

Note: the memento functionality that was previously in UndoableCommand is now in a new class called MemorableUndoableCommand.

Desktop.Actions

Type

Change

ActionModelNode

Made class abstract public abstract class ActionModelNode

Removed property public IAction Action { get; set; }

Removed method protected virtual ActionModelNode CreateNode(PathSegment pathSegment);

Removed method protected void InsertAction(IAction action, int pathDepth);

Removed property public bool IsLeaf { get; }

ActionModelRoot

Removed method protected virtual ActionModelNode CreateNode(PathSegment pathSegment);

Desktop.Tables

Type

Change

ITableColumn

Added method public abstract void ClickLink(System.Object item);

Added property public bool HasClickableLink { get; }

Desktop.Trees

Type

Change

CanHaveSubTreeDelegate<T>

Removed delegate public delegate bool CanHaveSubTreeDelegate<T>(T item);

IconSetProviderDelegate<T>

Removed delegate public delegate public class IconSet IconSetProviderDelegate<T>(T item);

IsCheckedGetterDelegate<T>

Removed delegate public delegate bool IsCheckedGetterDelegate<T>(T item);

IsCheckedSetterDelegate<T>

Removed delegate public delegate void IsCheckedSetterDelegate<T>(T item, bool value);

IsInitiallyExpandedDelegate<T>

Removed delegate public delegate bool IsInitiallyExpandedDelegate<T>(T item);

ITreeItemBinding

Added method public abstract bool GetExpanded(System.Object item);

Removed method public abstract bool IsInitiallyExpanded(System.Object item);

Added method public abstract void SetExpanded(System.Object item, bool expanded);

ResourceResolverProviderDelegate<T>

Removed delegate public delegate ClearCanvas.Common.Utilities.IResourceResolver ResourceResolverProviderDelegate<T>(T item);

TextProviderDelegate<T>

Removed delegate public delegate System.String TextProviderDelegate<T>(T item);

TreeItemBinding<TItem>

Changed constructor

From:

public TreeItemBinding(TextProviderDelegate<TItem> nodeTextProvider);

To:

public TreeItemBinding(System.Converter<TItem, System.String> nodeTextProvider);

Changed constructor

From:

public TreeItemBinding(TextProviderDelegate<TItem> nodeTextProvider, TreeProviderDelegate<TItem> subTreeProvider);

To:

public TreeItemBinding(System.Converter<TItem, System.String> nodeTextProvider, System.Converter<TItem, ITree> subTreeProvider);

Removed method public bool IsInitiallyExpanded(System.Object item);

Changed property

From:

public CanHaveSubTreeDelegate<TItem> CanHaveSubTreeHandler { get; set; }

To:

public System.Converter<TItem, bool> CanHaveSubTreeHandler { get; set; }

Changed property

From:

public IconSetProviderDelegate<TItem> IconSetProvider { get; set; }

To:

public System.Converter<TItem, IconSet> IconSetProvider { get; set; }

Changed property

From:

public IsCheckedGetterDelegate<TItem> IsCheckedGetter { get; set; }

To:

public System.Converter<TItem, bool> IsCheckedGetter { get; set; }

Changed property

From:

public IsCheckedSetterDelegate<TItem> IsCheckedSetter { get; set; }

To:

public SetterDelegate<TItem, bool> IsCheckedSetter { get; set; }

Removed property public IsInitiallyExpandedDelegate<TItem> IsInitiallyExpandedHandler { get; set; }

Changed property

From:

public TextProviderDelegate<TItem> NodeTextProvider { get; set; }

To:

public System.Converter<TItem, System.String> NodeTextProvider { get; set; }

Changed property

From:

public ResourceResolverProviderDelegate<TItem> ResourceResolverProvider { get; set; }

To:

public System.Converter<TItem, ClearCanvas.Common.Utilities.IResourceResolver> ResourceResolverProvider { get; set; }

Changed property

From:

public TreeProviderDelegate<TItem> SubTreeProvider { get; set; }

To:

public System.Converter<TItem, ITree> SubTreeProvider { get; set; }

Changed property

From:

public TextProviderDelegate<TItem> TooltipTextProvider { get; set; }

To:

public System.Converter<TItem, System.String> TooltipTextProvider { get; set; }

TreeItemBindingBase

Removed method public virtual bool IsInitiallyExpanded(System.Object item);

TreeProviderDelegate<T>

Removed delegate public delegate ITree TreeProviderDelegate<T>(T item);

ImageViewer

Type

Change

DrawableUndoableCommand

Changed base class

From:

public class DrawableUndoableCommand : ClearCanvas.Desktop.UndoableCommand

To:

public class DrawableUndoableCommand : ClearCanvas.Desktop.CompositeUndoableCommand

Removed constructor public DrawableUndoableCommand(IDrawable drawable, ClearCanvas.Desktop.IMemorable originator);

IImageOperation

Added base interface

From:

public interface IImageOperation;

To:

public interface IImageOperation : ClearCanvas.Desktop.IUndoableOperation<IPresentationImage>

Note: this can be a breaking change when implementing the interface explicitly; otherwise, it is non-breaking as the method signatures have not changed.

ImageOperationApplicator

Changed constructor

From:

public ImageOperationApplicator(IPresentationImage presentationImage, IImageOperation operation);

To:

public ImageOperationApplicator(IPresentationImage referenceImage, ClearCanvas.Desktop.IUndoableOperation<IPresentationImage> operation);

Changed method

From:

public virtual System.Object CreateMemento();

To:

public System.Object CreateMemento();

Changed method

From:

public virtual void SetMemento(System.Object memento);

To:

public void SetMemento(System.Object memento);

IPhysicalWorkspace

Added property public System.Drawing.Rectangle ScreenRectangle { get; }

Added event public System.EventHandler ScreenRectangleChanged;

SimpleLogicalWorkspaceBuilder

Removed class public static class SimpleLogicalWorkspaceBuilder

SimplePhysicalWorkspaceFiller

Removed class public static class SimplePhysicalWorkspaceFiller

ImageViewer.Annotations.Dicom

Type

Change

DicomDataFormatHelper

Changed method

From:

public static System.String PersonNameFormatter(ClearCanvas.Dicom.PersonName personName);

To:

public static System.String PersonNameFormatter(ClearCanvas.Dicom.Iod.PersonName personName);

Changed method

From:

public static System.String PersonNameListFormatter(System.Collections.Generic.IEnumerable<ClearCanvas.Dicom.PersonName> personNames);

To:

public static System.String PersonNameListFormatter(System.Collections.Generic.IEnumerable<ClearCanvas.Dicom.Iod.PersonName> personNames);

ImageViewer.Graphics

Type

Change

InsertRemoveOverlayGraphicUndoableCommand

Removed class public class InsertRemoveOverlayGraphicUndoableCommand : DrawableUndoableCommand

ImageViewer.Imaging

Type

Change

ColorSpaceConverter

Changed method

From:

public static void ToArgb(ClearCanvas.Dicom.PhotometricInterpretation photometricInterpretation, int planarConfiguration, byte[] srcPixelData, byte[] argbPixelData);

To:

public static void ToArgb(ClearCanvas.Dicom.Iod.PhotometricInterpretation photometricInterpretation, int planarConfiguration, byte[] srcPixelData, byte[] argbPixelData);

ImageViewer.Rendering

Type

Change

DrawArgs

Changed constructor

From:

public DrawArgs(IRenderingSurface surface, IScreenInfo screenInfo, DrawMode drawMode);

To:

public DrawArgs(IRenderingSurface surface, ClearCanvas.Desktop.Screen screen, DrawMode drawMode);

Changed property

From:

public IScreenInfo ScreenInfo { get; }

To:

public ClearCanvas.Desktop.Screen Screen { get; }

IScreenInfo

Removed interface public interface IScreenInfo

ImageViewer.StudyManagement

Type

Change

Frame

Changed method

From:

public abstract byte[] GetNormalizedPixelData();

To:

public byte[] GetNormalizedPixelData();

Changed property

From:

public ClearCanvas.Dicom.ImageOrientationPatient ImageOrientationPatient { get; }

To:

public ClearCanvas.Dicom.Iod.ImageOrientationPatient ImageOrientationPatient { get; }

Changed property

From:

public ClearCanvas.Dicom.ImagePositionPatient ImagePositionPatient { get; }

To:

public ClearCanvas.Dicom.Iod.ImagePositionPatient ImagePositionPatient { get; }

Changed property

From:

public ClearCanvas.Dicom.PixelSpacing ImagerPixelSpacing { get; }

To:

public ClearCanvas.Dicom.Iod.PixelSpacing ImagerPixelSpacing { get; }

Changed property

From:

public ClearCanvas.Dicom.PatientOrientation PatientOrientation { get; }

To:

public ClearCanvas.Dicom.Iod.PatientOrientation PatientOrientation { get; }

Changed property

From:

public ClearCanvas.Dicom.PhotometricInterpretation PhotometricInterpretation { get; }

To:

public ClearCanvas.Dicom.Iod.PhotometricInterpretation PhotometricInterpretation { get; }

Changed property

From:

public ClearCanvas.Dicom.PixelAspectRatio PixelAspectRatio { get; }

To:

public ClearCanvas.Dicom.Iod.PixelAspectRatio PixelAspectRatio { get; }

Changed property

From:

public ClearCanvas.Dicom.PixelSpacing PixelSpacing { get; }

To:

public ClearCanvas.Dicom.Iod.PixelSpacing PixelSpacing { get; }

Changed method

From:

protected byte[] ToArgb(byte[] pixelData, ClearCanvas.Dicom.PhotometricInterpretation photometricInterpretation);

To:

protected byte[] ToArgb(byte[] pixelData, ClearCanvas.Dicom.Iod.PhotometricInterpretation photometricInterpretation);

Changed method

From:

public abstract void UnloadPixelData();

To:

public void UnloadPixelData();

ImageSop

Note: ImageSop inherits from Sop, so all API changes for that class are also applicable here.

Changed constructor

From:

protected ImageSop();

To:

protected ImageSop(ClearCanvas.Dicom.DicomMessageBase dicomMessage);

Changed property

From:

public ClearCanvas.Dicom.ImageOrientationPatient ImageOrientationPatient { get; }

To:

public ClearCanvas.Dicom.Iod.ImageOrientationPatient ImageOrientationPatient { get; }

Changed property

From:

public ClearCanvas.Dicom.ImagePositionPatient ImagePositionPatient { get; }

To:

public ClearCanvas.Dicom.Iod.ImagePositionPatient ImagePositionPatient { get; }

Changed property

From:

public ClearCanvas.Dicom.PatientOrientation PatientOrientation { get; }

To:

public ClearCanvas.Dicom.Iod.PatientOrientation PatientOrientation { get; }

Changed property

From:

public ClearCanvas.Dicom.PhotometricInterpretation PhotometricInterpretation { get; }

To:

public ClearCanvas.Dicom.Iod.PhotometricInterpretation PhotometricInterpretation { get; }

Changed property

From:

public ClearCanvas.Dicom.PixelAspectRatio PixelAspectRatio { get; }

To:

public ClearCanvas.Dicom.Iod.PixelAspectRatio PixelAspectRatio { get; }

Changed property

From:

public ClearCanvas.Dicom.PixelSpacing PixelSpacing { get; }

To:

public ClearCanvas.Dicom.Iod.PixelSpacing PixelSpacing { get; }

IStudyLoader

Added property public IPrefetchingStrategy PrefetchingStrategy { get; }

Changed method

From:

public abstract int Start(System.String studyInstanceUID);

To:

public abstract int Start(StudyLoaderArgs studyLoaderArgs);

LocalFrame

Removed class public class LocalFrame : Frame, System.IDisposable

LocalImageSop

Note: LocalImageSop inherits from ImageSop and Sop, so all API changes for those classes are also applicable here.

NormalizedPixelSpacing

Changed base class

From:

public class NormalizedPixelSpacing : ClearCanvas.Dicom.PixelSpacing

To:

public class NormalizedPixelSpacing : ClearCanvas.Dicom.Iod.PixelSpacing

Patient

Changed property

From:

public ClearCanvas.Dicom.PersonName PatientsName { get; }

To:

public ClearCanvas.Dicom.Iod.PersonName PatientsName { get; }

PatientCollection

Changed base class

From:

public class PatientCollection : ClearCanvas.Common.Utilities.ObservableDictionary<System.String, Patient>

To:

public class PatientCollection : ClearCanvas.Common.Utilities.ObservableList<Patient>

SeriesCollection

Changed base class

From:

public class SeriesCollection : ClearCanvas.Common.Utilities.ObservableDictionary<System.String, Series>

To:

public class SeriesCollection : ClearCanvas.Common.Utilities.ObservableList<Series>

Sop

Changed constructor

From:

protected Sop();

To:

protected Sop(ClearCanvas.Dicom.DicomMessageBase dicomMessage);

Changed property

From:

public ClearCanvas.Dicom.PersonName PatientsName { get; }

To:

public ClearCanvas.Dicom.Iod.PersonName PatientsName { get; }

Changed property

From:

public ClearCanvas.Dicom.PersonName ReferringPhysiciansName { get; }

To:

public ClearCanvas.Dicom.Iod.PersonName ReferringPhysiciansName { get; }

SopCollection

Changed base class

From:

public class SopCollection : ClearCanvas.Common.Utilities.ObservableDictionary<System.String, Sop>

To:

public class SopCollection : ClearCanvas.Common.Utilities.ObservableList<Sop>

Study

Changed property

From:

public ClearCanvas.Dicom.PersonName ReferringPhysiciansName { get; }

To:

public ClearCanvas.Dicom.Iod.PersonName ReferringPhysiciansName { get; }

StudyCollection

Changed base class

From:

public class StudyCollection : ClearCanvas.Common.Utilities.ObservableDictionary<System.String, Study>

To:

public class StudyCollection : ClearCanvas.Common.Utilities.ObservableList<Study>

StudyItem

Changed property

From:

public ClearCanvas.Dicom.PersonName PatientsName { get; set; }

To:

public ClearCanvas.Dicom.Iod.PersonName { get; set; }

Changed property

From:

public ClearCanvas.Dicom.OffisNetwork.ApplicationEntity Server { get; set; }

To:

public ApplicationEntity Server { get; set; }