![shows ultraexplorerbar design time options](Images/WinExplorerbar_Replacing_an_Existing_WinListbar_Element_with_a_WinExplorerbar_01.png)
Though the object models of the WinExplorerBar™ and the WinListbar™ controls are similar they are not the same. For example, Group and Item objects in the WinListbar element are now called UltraExplorerBarGroup and UltraExplorerBarItem .
In addition, many properties that were originally on the Group and Item objects have been moved to the GroupSettings and ItemSettings objects for greater flexibility when setting properties.
If you are replacing an WinListbar element in an existing project with an WinExplorerBar element, there are a couple of tasks you will need to complete:
Copy Group and Item definitions created at design-time in the WinListbar element to the new WinExplorerBar element.
Modify the existing code that manipulates the WinListbar element to work with the WinExplorerBar element.
To assist you with step 1 above, UltraExplorerBar includes an Import function that will let you easily Import Groups and Items defined in an existing UltraListbar element into an UltraExlorerBar element on the same form.
The Import function can be found on a tab within the UltraExplorerBar Designer. The UltraExplorerBar Designer can be started by selecting the 'UltraExplorerBar Designer…' option from the element’s context menu (displayable by right-clicking the UltraExplorerBar element on a form in the Visual Studio IDE at design-time) or from the list of verbs in the Visual Studio IDE Property Browser as shown below:
Once the UltraExplorerBar Designer is displayed, select the 'Import Groups/Items' tab which presents a simple 3 step process as shown below:
The list of elements in the left will show all UltraListbar elements found on the current form.
Step 1 , on the right hand side of the dialog, asks you to select the Groups and Items you would like to import. By default, all Groups and Items are checked. Click the checkbox to deselect a Group or Item and exclude it from the import.
Step 2 asks you to indicate whether Groups and Items (if any) currently defined to the UltraExplorerBar element should be cleared before the UltraListbar Groups/Items are imported. By default the 'Retain current Groups and Items' selection is checked.
Step 3 requires you to click the start button. A message will be displayed at the completion of the import.
When modifying existing UltraListbar code to target the UltraExplorerBar element, there is no automated way to accomplish the conversion. It is a manual effort, but the following guidelines can help speed the process:
The class names for the objects representing groups in the UltraExplorerBar element has changed from Group to UltraExplorerBarGroup.
The class names for the objects representing items in the UltraExplorerBar element has changed from Item to UltraExplorerBarItem.
Many of the properties that existed on the UltraListbar Group object are now on the UltraExplorerBar GroupSettings object. The GroupSettings object can be found on the UltraExplorerBarGroup object under the property name 'Settings'.
In Visual Basic:
Imports Infragistics.Win.UltraWinExplorerBar Imports Infragistics.Win.UltraWinListBar ... Me.UltraListbar1.Groups(0).Style = Style.LargeIcons
In C#:
using Infragistics.Win.UltraWinExplorerBar; using Infragistics.Win.UltraWinListBar; ... this.ultraListBar1.Groups[0].Style = Style.LargeIcons;
In UltraExplorerBar the same property would be accessed as follows.
In Visual Basic:
Me.UltraExplorerBar1.Groups(0).Settings.Style = GroupStyle.LargeImages
In C#:
this.ultraExplorerBar1.Groups[0].Settings.Style = GroupStyle.LargeImages;
Many of the properties that existed on the UltraListbar Item object are now on the UltraExplorerBar ItemSettings object. The ItemSettings object can be found on the UltraExplorerBarItem object under the property name 'Settings'. For example, in UltraListbar the Item’s Appearance property was accessed as follows:
In Visual Basic:
Me.UltraListBar1.Groups(1).Items(0). & _ Appearance.ForeColor = Color.Red
In C#:
this.ultraListBar1.Groups[1].Items[0]. Appearance.ForeColor = Color.Red;
In UltraExplorerBar the same property would be accessed as follows:
In Visual Basic:
Me.UltraExplorerBar1.Groups(1).Items(0).Settings.AppearancesSmall.Appearance.ForeColor = Color.Red
In C#:
this.ultraExplorerBar1.Groups[1].Items[0].Settings.AppearancesSmall.Appearance.ForeColor = Color.Red;
Since the UltraExplorerBar element does not support multiple orientations as the UltraListbar did, the element no longer has an Orientation property. You will need to remove any code that accesses the Orientation property and possibly redesign your form if you were using the element in a horizontal orientation. (The UltraExplorerBar element can only display its contents in a vertical orientation).
The GroupSelected event in the UltraListbar element has been replaced with 2 events:
The ItemSelected event in the UltraListbar element has been replaced by the ItemClick event.