breaking-changes-in-2014-volume-1.adoc

Breaking Changes in 2014 Volume 1

Breaking Changes Summary

Breaking changes summary chart

The following table summarizes the breaking changes of the Infragistics WPF 2014 Volume 1 Release. Detailed explanations of the issues and the existing workarounds are provided after the summary table.

Legend:

– Workaround available

– No known workaround

– No known workaround, fix planned

XamComboEditor, XamMultiColumnComboEditor

Issue	Description	Status
Change in the SelectionChanged event argument type	The SelectionChanged event argument’s type is changed so it has to be replaced with the new extended type.
Changes in item filtering implementation and renamed properties	In order to enhance the implementation of the custom item filtering in the control, the following properties were changed: ItemsFilter and CustomItemsFilter.

XamGeographicMap

Issue	Description	Status
Renaming members	Renaming of some members
Removing members	Removing of some members

XamRichTextEditor

Issue	Description	Status
Renaming members	Renaming of some members
Default property value changed	The default value of a property has been changed

XamSyntaxEditor

Issue	Description	Status
Members rename	Renaming of some members

XamComboEditor, XamMultiColumnComboEditor

Change in the SelectionChanged event argument type

The type of the event argument of the SelectionChanged event is changed from EventArgs to SelectionChangedEventArgs in order to provide information for selected/unselected control’s items.

Old Event Argument Type	New Event Argument Type
System.EventArgs	Infragistics.Controls.Editors.SelectionChangedEventArgs

Workaround

Note	Note To work around this breaking change rename all occurrences of the old event’s argument type with the new one.

Changes in item filtering implementation and renamed properties

In order to enhance the custom item filtering in the control, the following properties were changed:

• ItemsFilter

• CustomItemsFilter

Till the 2014 Volume 1 release, only one filter was possible to apply in the control. After creating an ItemsFilter object, it was set to the XamComboEditor/ XamMultiColumnComboEditor CustomItemsFilter property.

After enhancing the custom item filtering logic, it is possible to create many filters of type ComboItemFilter and they are added to the XamComboEditor/ XamMultiColumnComboEditor ItemFilters property of type ObservableCollection<ComboItemFilter>.

Note	Note When creating a custom ComboItemFilter, the ComboItemFilter FieldName property must be set to the name of the data property to be filtered. If FieldName property is not set, an exception is thrown.

Following is a table that lists the old properties names and the new ones:

Old Property Name	New Property Name
Infragistics.Controls.Editors.ItemsFilter	Infragistics.Controls.Editors.ComboItemFilter
Infragistics.Controls.Editors.CustomItemsFilter	Infragistics.Controls.Editors.ItemFilters

For more information about implementing custom item filtering, check the following topics:

• Configuring Item Filtering (xamComboEditor)

• Configuring Item Filtering (xamMultiColumnComboEditor)

Workaround

Note	Note To work around this breaking change rename all occurrences of the old properties with the new ones.

XamGeographicMap

Renaming members

Renaming of members in the {ApiPlatform}Controls.Maps.XamGeographicMap.v14.1.dll assembly:

Old Member	New Member
HorizontalZoomable	Zoomable
VerticalZoomable	Zoomable
HorizontalWindowScale	WindowScale
VerticalWindowScale	WindowScale

Workaround

Note	Note To work around this breaking change rename all occurrences of the old members with the new members.

Removing members

Removing of members in the {ApiPlatform}Controls.Maps.XamGeographicMap.v14.1.dll assembly:

Removed Member
HorizontalZoombarVisibility
VerticalZoombarVisibility

Workaround

Note	Note To work around this breaking change remove all occurrences of the old members.

XamRichTextEditor

Renaming members

Renaming of members in the {ApiPlatform}Controls.Editors.XamRichTextEditor.v14.1.dll assembly:

Old Member	New Member
AdornmentGeneratorBase	RichTextAdornmentGeneratorBase
CaretPresenter	RichTextCaretPresenter
SelectionChangedEventArgs	RichTextSelectionChangedEventArgs

Workaround

Note	Note To work around this breaking change rename all occurrences of the old members with the new members.

Default property value changed

The default value of the xamRichTextEditor’s AllowDocumentViewSplitting has been changed from true to false.

Workaround

Note	Note To work around this breaking change add this property to your xamRichTextEditor and set it to true.

XamSyntaxEditor

Members rename

Renaming of members in the {ApiPlatform}Controls.Editors.XamSyntaxEditor.v14.1.dll assembly:

Old Member	New Member
AdornmentGeneratorBase	SyntaxEditorAdornmentGeneratorBase
CaretPresenter	SyntaxEditorCaretPresenter
SelectionChangedEventArgs	SyntaxEditorSelectionChangedEventArgs

Workaround

Note	Note To work around this breaking change rename all occurrences of the old members with the new members.