Infragistics2.Win.UltraWinListBar.v9.2 Returns the localized category name Name of the category to retreive The localized string value Return the list of products that this control can be licensed with Controls class loading and mandates what class to load. Controls the binding of a serialized object to a type Specifies the Assembly name of the serialized object Specifies the Type name of the serialized object. The type of the object the formatter creates a new instance of. Enumerator used to determine the orientation of the UltraWinListBar.

The enumerator is used to set the display orientation of the UltraWinListBar. The UltraWinListBar can be displayed vertically or horizontally. If you would like the orientation to be vertical, set the enumerator equal to zero or use this code:

UltraListBar1.Orientation = Infragistics.Win.UltraWinListBar.Orientation.Vertical

If you would like the orientation to be horizontal, you can set the property equal to one or use this code:

UltraListBar1.Orientation = Infragistics.Win.UltraWinListBar.Orientation.Horizontal

When retrieving the value of this property, the enumerator 0 (vertical) or 1 (horizontal) will be returned.

 The UltraListBar will be oriented vertically. The UltraListBar will be oriented horizontally. Enumerator used to determine the presentation style of the icons for Items within a .

The enumerator is used to set the size of the icons used for the Items within a Group. If you want to set the style to use large icons (32 x 32), then set the enumerator equal to 0 or use this code:

UltraListBar1.DefaultStyle = Infragistics.Win.UltraWinListBar.Style.LargeIcons

If you would like to set the style to use small icons (16 x 16), set the enumerator equal to one or use this code:

UltraListBar1.DefaultStyle = Infragistics.Win.UltraWinListBar.Style.SmallIcons

When retrieving this property, the enumerator 0 (large icons) or 1 (small icons) will be returned.

 Use large icons (32 x 32). Use small icons (16 x 16). Enumeration of actions which can be performed using the default context menu Remove Group Add Group Remove Item Add Item LargeIcons Delegate for handling events that take as one of the event arguments. Delegate for handling events that take as one of the event arguments. Delegate for handling events that take as one of the event arguments. Delegate for handling events that take as one of the event arguments. Event parameters used for events that take a as one of its arguments. Constructor for the class that uses a as a parameter. the Read-only property that returns the associated with the . Event parameters used for events that take an Item as one of its arguments. Constructor for the class that uses an as a parameter. Read-only property that returns the associated with the . Event params used in BeforeDefaultContextMenuClick Constructor for the Context of item being modified, can be an or specifying the action taking place. Context of item affected by action. Action ID specifying current context menu action. Event params used in AfterDefaultContextMenuClick Constructor for the Context of item being modified, can be an or specifying the action taking place. Context of item affected by action. Action ID specifying current context menu action. The Group object is the container object for all items housed at a single level within the UltraListBar. There may be several groups within the Groups collection.

Before adding an to the UltraListBar, you must first have a object. You can access all the items within a group through the Group object's ItemsCollection. When a group is added and the of the group has not been specified, the default text is "New Group". The following code adds a group to the end of the collection:

UltraListBar1.Groups.Add()

You may also add a group and pass it a unique Key.

UltraListBar1.Groups.Add("First Group")

Additionally, you may assign the text to the group at this time.

UltraListBar1.Groups.Add("Second Group", "Test Text")

 Default constructor used to create a new Group object.

This constructor will create a new object and give it an empty ItemsCollection. It will assign the value "New Group" to the property.

 Serialization constructor for the Group class.

This constructor uses a Boolean value to determine if the was while it was being serialized.

 True to indicate that this is the selected group. Method used to display a textbox control over the group header so that the user can change the group's display text.

The Rename method will allow the user to change the property of a .

UltraListBar1.Groups(0).Rename()

 Constructor used for de-serialization of the class. The used to obtain the serialized properties of the object Context for the deserialization Serializes the collection of Group objects. Called when the group is disposed.

OnDisposed sets the object to null when the Dispose method has been called.

 Returns true if there are any items whose properties are not equal to their default values. Method used to clear the items collection.

This method will clear every from the items collection of a group.

UltraListBar1.Groups(0).Items.Clear()

 Called when any property on a sub object has changed. PropChangeInfo contains information on which subobject changed and which property of the subobject changed. Returns the Appearance properties to their default values before rendering the item display area of the selected group. The structure to contain the resolved apperance. Bit flags indictaing which properties to resolve. Returns the Appearance properties to their default values before rendering the of the selected group. The structure to contain the resolved apperance. Bit flags indictaing which properties to resolve. Returns the Appearance properties to their default values before rendering the items of the selected group. The structure to contain the resolved apperance. Bit flags indictaing which properties to resolve. Method that returns true if the current text is not the default text. Method used to set the text of the group back to its default value.

If a default value for the Text of the group was not explicitly assigned, then the default value of the text property is "New Group".

 Method used to return the Text property.

The ToString method is used to return the property as a string variable.

MsgBox(UltraListBar1.Groups(0).ToString())

 Returns true if the default style does not match the current setting of the property. Method used to reset the style back to the default value.

The ResetStyle method allows you to set the property of the group back to its default value.

 Returns true if the object has any non-default property values set. Method that resets all Appearance properties to their default values.

The ResetAppearance method gives you the ability to undo all changes made to the of the group and revert the Appearance property values back to their defaults.

 Returns true if the Appearance object assigned to the property of the group has any non-default property values set. Method that resets all the Appearance property values for the back to their defaults.

This method gives you the ability to undo all changes made to the appearance of the items within the group and revert the Appearance property values back to their defaults.

 Read-only property that returns true if the Appearance object assigned to the has any non-default property values set. Method used to reset the Appearance properties of the to their default values.

The ResetHeaderAppearance method gives you the ability to undo all changes made to the appearance of the group's header and revert the Appearance property values back to their defaults.

 Invoked during the serialization of the object. The used to obtain the serialized properties of the object Context for the deserialization Invoked after the entire object graph has been deserialized. The object that initiated the callback. The functionality for the this parameter is not currently implemented. Read-only property that returns the index of the group within the GroupsCollection.

The Index property of the group is useful in returning a specific group's index within the collection after the collection has been manipulated. It is recommended that you assign a Key to an added group whenever possible and manipulate groups according to their key and not their index.

Dim grpIndex As VariantType

grpIndex = (UltraListBar4.Groups("First Group").Index())

MsgBox(grpIndex)

 Read-only property that returns the collection of items contained within the group.

The Items property of the group gives you the ability to manipulate the Items collection as a whole and the each within the collection. For example, you can add items to the collection:

UltraListBar1.Groups(0).Items.Add("Key","Text")

You can also add an object to the items within the collection:

UltraListBar1.Groups(0).Items("Key").Appearance = appearance

The appearance variable in the above sample code must be declared in this manner:

Dim appearance As Infragistics.Win.AppearanceBase

 Property that gets/sets whether this group is the selected group.

Setting the Selected property equal to true causes the group to be selected. This property can also be used to return if the group is currently selected.

UltraListBar1.Groups(0).Selected = True

 Read-only property that returns the control that contains the group.

The UltraListBar property allows you to work with the control object that contains the group. You can manipulate the control using the returned reference.

Dim thisControl As Infragistics.Win.UltraWinListBar.UltraListBar

thisControl = UltraListBar1.Groups(0).Control()

thisControl.BorderStyle = Infragistics.Win.UIElementBorderStyle.Dashed

 Property that gets/sets the caption text for a group.

The Text property uses a string variable to determine the text that will be displayed for a group.

UltraListBar1.Groups(0).Text = "Group Text"

 Property that gets/sets the style (large or small icons) of this group.

The Style property determines the size of the icons used for the items within a group. You may use large (32 x 32) or small (16 x 16) icons. This property will return an enumerator: 0 for large icons and 1 for small icons.

UltraListBar1.Groups(0).Style = Infragistics.Win.UltraWinListBar.Style.LargeIcons

 Returns the main UIElement for the group.

The group's UIElement property returns the user interface element associated with the group. This is useful in manipulating the of individual groups.

MsgBox(UltraListBar4.Groups(0).UIElement.IsFullyVisible)

 Gets/sets the Appearance object for the group.

The Appearance property gets/sets the Appearance object assigned to the group. The Appearance object allows you to create appearances that can be assigned to many different objects. Therefore, the Appearance object saves you valuable time that would otherwise be spent setting formatting properties for each object.

Dim myAppearance As Infragistics.Win.AppearanceBase

myAppearance.BorderAlpha = Infragistics.Win.Alpha.Transparent

UltraListBar1.Groups(0).Appearance = myAppearance

You could also go directly through the appearance object of each group to assign formatting properties.

UltraListBar1.Groups(0).Appearance.BorderAlpha = Infragistics.Win.Alpha.Transparent

 Read-only property that returns true if an Appearance object has been assigned to the group.

The HasAppearance property returns true if an object has been assigned to the group. This property allows you to check if the group has an appearance before assigning one to the group.

 Returns the default object assigned to the items within the group. Read-only property that returns true if an Appearance object has been assigned to the ItemAppearance property of the group.

The HasItemAppearance property is used to determine if the group's Items collection has been assigned an object. Keep in mind that all items within a group can be assigned separate Appearance objects. The following code assigns an Appearance object to every item within the group.

UltraListBar1.Groups(0).ItemAppearance = myAppearance

 Property that gets/sets the Appearance object for the group's header area.

The HeaderAppearance property gets/sets the Appearance object assigned to the group's header. The Appearance object allows you to create appearances that can be assigned to many different objects. Therefore, the Appearance object saves you valuable time that would otherwise be spent setting formatting properties for each object.

Dim myAppearance As Infragistics.Win.AppearanceBase

myAppearance.BorderAlpha = Infragistics.Win.Alpha.Transparent

UltraListBar4.Groups(0).HeaderAppearance = myAppearance

You could also go directly through the appearance object of each group to assign formatting properties.

UltraListBar4.Groups(0).HeaderAppearance.BorderAlpha = Infragistics.Win.Alpha.Transparent

 Read-only property that returns true if an Appearance object has been assigned to the header of the group.

The HasHeaderAppearance property returns true if a object has been assigned to the group's header.

 TypeConverter for an UltraWinListBar Group. Indicates which types the class can be cast to. ITypeDescriptorContext Type A boolean indicating if the class can be converted to the specified type. Converts the object to the specified type. ITypeDescriptorContext CultureInfo Object to convert. Type to which the object is to be converted. The converted object. This class encapsulates the drawn UIElement associated with the header for a group.

The GroupHeaderUIElement behaves like a button and contains the associated with the . When the header is clicked, items contained within the group's Items collection become visible.

 Constructor used to create a GroupHeaderUIElement. The parameter that must be passed is a UIElement. The parent element Initializes the structure for this GroupHeaderUIElement. The appearance structure to initialize The properties that are needed Positions the child elements for this group. Handles rendering the theme appearance for the GroupHeaderUIElement. The used to provide rendering information. A boolean indicating if it rendered as a themed element. Returns the associated with the GroupHeaderUIElement. Returns the cursor of the associated with the GroupHeaderUIElement. Returns the rectangle that houses the within the GroupHeaderUIElement. Gets the ButtonStyle setting for the GroupHeaderUIElement.

The ButtonStyle property of the GroupHeaderUIElement has twelve settings. These settings are: Borderless, Button, Button3D, ButtonSoft, ButtonSoftExtended, Default, Flat, FlatBorderless, PopUp, PopUpBorderless, PupUpSoft and PopUpSoftBorderless.

 This class encapsulates the drawn UIElement associated with the items' area for a group.

The GroupItemAreaUIElement class contains the icons associated with each visible within the UltraListBar. The item icons behave as buttons. The GroupItemAreaUIElement also consists of the drawn rectangle that holds the items' icons.

 Default constructor used to create the GroupItemAreaUIElement. Needs a UIElement passed as a parameter. The parent element Positions the child elements for this group. Initializes the for the GroupItemAreaUIElement. The appearance structure to initialize The properties that are needed Returns the parent of the GroupItemAreaUIElement. Returns the cursor of the associated with the GroupItemAreaUIElement. Returns the BorderStyle of the GroupItemAreaUIElement.

The property has ten settings. These settings are: Dashed, Default, Dotted, Etched, Inset, InsetSoft, None, Raised, RaisedSoft and Solid.

 A collection of objects. The Group object is the container object for every housed at a single level within the UltraListBar. The Groups collection allows you to manipulate all the groups within the collection at a common parent level.

Before adding any items to the UltraListBar, you must first have a Group object. When a group is added and the text of the group has not been specified, the default text is New Group. The following code adds a group to the end of the collection:

UltraListBar1.Groups.Add()

You may also add a group and pass it a unique key as well as determine the text of the group.

 Constructor used for de-serialization of the GroupsCollection. The parameters for this constructor are SerializationInfo and StreamingContext. The used to obtain the serialized properties of the object Context for the deserialization Serialize the collection Method that adds a specific group to the end of the collection.

The Add method is an overloaded method. This version of the Add method adds a specified object to the end of the collection.

UltraListBar1.Groups.Add(New Infragistics.Win.UltraWinListBar.Group())

 Must be a group The index at which the object was added to the collection. Removes a group from the GroupsCollection.

The Remove method must be passed a as a parameter.

UltraListBar1.Groups.Remove(UltraListBar1.Groups(0))

 Must be a group Method that removes a group from the GroupsCollection based on the index of the group within the collection.

The RemoveAt method removes a from the Groups collection based on the it is passed. The following code will remove the first group in the collection.

UltraListBar1.Groups.RemoveAt(0)

 Inserts the group into the collection Method that returns a null string. Method that adds a group to the end of the collection.

The Add method is an overloaded method. This version of the Add method receives no parameters and will add a group to the end of the collection with the default of "New Group". The Add method can be passed parameters to allow the developer more control over the Groups collection.

UltraListBar1.Groups.Add()

 The newly added group Method that adds a group to the end of the collection passing in a string as the key.

The Add method is an overloaded method. This Add method of the Groups collection receives a Key passed as a string. The group will be added to the end of the Groups collection and have the default of "New Group". You should be careful not to add a group that has the same key as a group that already exists.

UltraListBar1.Groups.Add(myKey)

 The key to assign the new group The newly added group Method that adds a group to the end of the collection passing in a string variable as the key and another string variable as the text of the new group.

The Add method is an overloaded method. This Add method of the Groups collection receives a Key and the of the new group both passed as strings. The text and the key may be assigned the same string. The group will be added to the end of the Groups collection. You should be careful not to add a group that has the same key as a group that already exists.

UltraListBar1.Groups.Add("myKey", "myText")

 The key to assign the new group The caption text for the new group The newly added group Should not be called outside of collection or streamer classes Method that inserts a group into the collection at a specific index.

The Insert method is an overloaded method. The method inserts a at the it is passed. All groups within the collection residing at the index or later in the collection will have their indexes increased by one. The index passed in must be an integer.

UltraListBar1.Groups.Insert(0)

 Where to insert the new group The newly added group Method that inserts a group into the collection at a specific index with a given key.

The Insert method is an overloaded method. This method inserts a at the it is passed and supplies a Key to the group. All groups within the collection residing at the index or later in the collection will have their indexes increased by one. The index passed in must be an integer and the key that is passed must be a string.

UltraListBar1.Groups.Insert(0, "myKey")

 Where to insert the new group The key to assign the new group The newly added group Method that inserts a group into the collection at a specific index with a given key and text.

The Insert method is an overloaded method. This method inserts a at the it is passed and supplies a Key and to the group. All groups within the collection residing at the index or later in the collection will have their indexes increased by one. The index passed in must be an integer and the key and text that are passed must be strings.

UltraListBar1.Groups.Insert(0, "myKey", "myText")

 Where to insert the new group The key to assign the new group The caption text for the new group The newly added group Should not be called outside of collection or streamer classes Method that clears all the groups from the collection.

The Clear method removes every from the collection.

UltraListBar1.Groups.Clear()

 Method that removes a group from the Groups collection.

The Remove method clears a specified from the collection. The value passed into the method must be a group.

UltraListBar4.Groups.Remove(myGroup)

 IEnumerable Interface Implementation returns a type safe enumerator. A type safe enumerator Called when a property has changed on a sub object PropChangeInfo contains information on which subobject changed and which property of the subobject changed. A collection of objects. The Group object is the container object for every housed at a single level within the UltraListBar. The Groups collection allows you to manipulate all the groups within the collection at a common parent level.

Before adding any items to the UltraListBar, you must first have a Group object. When a group is added and the text of the group has not been specified, the default text is New Group. The following code adds a group to the end of the collection:

UltraListBar1.Groups.Add()

You may also add a group and pass it a unique key as well as determine the text of the group.

 Generic indexer Read-only property that returns false if the Groups collection can be sized.

The IsFixedSize property reflects whether the Groups collection can be sized.

If UltraListBar4.Groups.IsFixedSize = False Then UltraListBar4.Groups.Add()

 The indexer of the groups within the collection. The indexer is an integer. String indexer of the groups within the collection.

The string serves as the group's unique Key within the collection.

 Abstract property that returns the initial capacity of the groups's collection. Read-only property that returns the UltraListBar control that owns the Groups collection.

The Control property returns the UltraListBar control that contains the Groups collection. After retrieving the control, you are free to manipulate the many properties associated with the control. The following code sample uses the Control property of the Groups collection to change the of the control.

UltraListBar1.Groups.Control.Appearance = myAppearance

 Read-only property that returns true if this collection is read-only.

The IsReadOnly property is used to determine if the groups collection is read-only. The property will return a Boolean value.

If UltraListBar4.Groups.IsReadOnly = False Then UltraListBar4.Groups.Insert(0)

 Enumerator for the GroupsCollection. Type-safe version of Current The GroupUIElement is the graphical interface that is visible to the user that contains both the GroupHeaderUIElement (the Group button) and the GroupItemAreaUIElement (the items section).

The group header and the item icons behave as buttons.

 Constructor for the GroupUIElement. The parent element The group Does nothing The used to provide rendering information. Does nothing The used to provide rendering information. Does nothing The used to provide rendering information. Positions the child elements for this group. Called when the mouse down message is received over the GroupUIElement. Mouse event arguments True if left clicked over adjustable area of element. If not null on return will capture the mouse and forward all mouse messages to this element. If true then bypass default processing Returns the group context of the GroupUIElement. Returns true to clip the child elements of the GroupUIElement. ItemScrollButton Constructor The parent element The Item object is the individual sub object contained within a group. The Item object behaves like a button and the icon can be pressed. The appearance of the item object can be customized as well. There can be several items per group.

Before adding any items to the UltraListBar control, you must first add a object. You can access all the items within a group through the group's Items Collection. When an item is added to the end of the collection and the has not been specified, the default text is "New ListItem". The following code adds an item to the end of a group.

UltraListBar1.Groups(0).Items.Add()

 Default constructor for creating a new Item object. Constructor used for de-serialization of an Item object. The parameters needed are SerializationInfo and StreamingContext. The used to obtain the serialized properties of the object Context for the deserialization Serialize the collection Called when the item is disposed.

OnDispose sets the object to null when the Disposed method has been called.

 Read-only property that returns the key of the item as a string.

The ToString property returns the Key of the item as a string. The key of the item is the unique identifier of tht item within the Items Collection. The ToString property will return an empty string if a key has not been assigned to the item.

myString = UltraListBar4.Groups(0).Items(0).ToString

 Displays a textbox control over the group header so that the user can rename the group.

The Rename method is used to allow the user to change the associated with an item. The text of the item is used for display purposes only and shouldn't be confused with the item's Key value.

UltraListBar1.Groups(0).Items(0).Rename()

 Called when a property is changed on a sub object of the item. PropChangeInfo contains information on which subobject changed and which property of the subobject changed. Method used to scroll the item into view (if necessary).

The EnsureVisible method is used to make an item visible to the user.

UltraListBar4.Groups(0).Items(0).EnsureVisible()

 Read-only property that returns true if the current text is not the default text.

The ShouldSerializeText property gives the developer the ability to determine if the property has been changed from its default value. If this property returns 'true' then use the ResetText method to restore the default value. There are several other 'Serialize' properties as well.

 Method that sets the text back to its default value.

The ResetText method sets the of the item back to its original default value.

 Read-only property that returns true if the current SmallImageIndex value is not the same as the default value for this property.

The ShouldSerializeSmallImageIndex property gives the developer the ability to determine if the property has been changed from its default value. If this property returns 'true' then use the ResetSmallImageIndex method to restore the default value. There are several other 'Serialize' properties as well.

 Method that sets the SmallImageIndex back to its default value.

The ResetSmallImageIndex method sets the integer of the property back to its original default value.

 Read-only property that returns true if the current LargeImageIndex value is not the same as the default value for this property.

The ShouldSerializeLargeImageIndex property gives the developer the ability to determine if the property has been changed from its default value. If this property returns true then use the ResetLargeImageIndex method to restore the default value.

Method used to set the LargeImageIndex back to its default value.

The ResetLargeImageIndex method sets the integer of the property back to its original default value.

 Returns the Item's Appearance.Image. If Item.Appearance.Image is not set, returns null System.Drawing.Image Read-only property that returns true if the appearance has any non-default property values set.

The current property values for will be compared to the default values of the Appearance object. If any of the properties have changed then true will be returned by this property.

 Method used to reset all appearance property values to their default values.

The ResetAppearance method will revert the properties of the to their default values. This method allows the developer to roll back all changes made to the Appearance object.

 Returns the resolved property settings used to render this item. The structure to contain the resolved apperance. Bit flags indictaing which properties to resolve. Invoked during the serialization of the object. The used to obtain the serialized properties of the object Context for the deserialization Invoked after the entire object graph has been deserialized. The object that initiated the callback. The functionality for the this parameter is not currently implemented. Read-only property that returns the index of the item within the Items collection.

The Index property returns an integer value which reflects the index of the item within the collection. The index allows you to gain a reference to the item within the collection. Keep in mind that indexes can change when adding or deleting items. It is recommended that you assign items a Key value and use the key to access items within the collection. The following code returns the index of the item that has the key value "myKey".

myInt = UltraListBar1.Groups(0).Items("myKey").Index()

 Read-only property that returns the group that is associated with the item.

The Group property will return a reference to the that contains the item. After obtaining a reference to the group, the group's properties and methods can be manipulated. This property is particularly useful within the ItemSelected event. The following code sample determines if the item that has been clicked on was within the first group and displays a message box if that condition is met.

If e.Item.Group.Index = 0 Then MsgBox("Clicked Within Group Zero!")

This code must be placed within the ItemSelected event or another event where the 'e As Infragistics.Win.UltraWinListBar.ItemEventArgs' has been passed.

 Read-only property that returns true if the item is currently scrolled into view.

The IsVisible property is used to determine if the item is visible.

If UltraListBar1.Groups(0).Items(0).IsVisible Then UltraListBar1.Groups(0).Items(0).Text = "Visible!"

 Property that gets/sets the text of the item.

The Text property is used to set the text associated with an item. The property also returns the text of an item. The value must be a string variable.

UltraListBar4.Groups(0).Items(0).Text = "Item Text"

 Property that gets/sets the index used for the small images. The index must be an integer. Property that gets/sets the index used for the large images. The index must be an integer. Property that gets/sets the Appearance object assigned to this item.

The Appearance property of the item will return a reference to the Appearance object that has been assigned to this item. Once you have retrieved the Appearance object, you will be able to modify its formatting properties. You are also able to assign a previously created Appearance object to the item.

UltraListBar1.Groups(0).Items("myItem").Appearance = myAppearance

 Read-only property that returns true if an Appearance object has been created and assigned to the item.

The HasAppearance property allows you to determine if the property has been set for the item.

 TypeConverter for an UltraWinListBar ListItem. Indicates which types the class can be cast to. ITypeDescriptorContext Type A boolean indicating if the class can be converted to the specified type. Converts the object to the specified type. ITypeDescriptorContext CultureInfo Object to convert. Type to which the object is to be converted. The converted object. The ItemImageUIElement is the graphical area that represents the items' icons.

The ItemImageUIElement represents the visible graphic portion of an and functions as a button. The image will be automatically scaled to look perfect whether you use small or large icons in your UltraListBar. The background of the image can also be drawn in a flat style to emulate the look and feel of the XP operating system. The borders of the image can also be changed to suit your preference.

 Constructor used to create the ItemImageUIElement. The parameters needed are the UIElement and an image. The parent element The image Allows the background of the item's image to emulate the XP flat style look.

The DrawBackColor method will draw the backcolor of the in a manner consistent with the look and feel of Microsoft's XP operating system. This will be determined by the property of the UltraListBar control being set to Flat.

 The used to provide rendering information. Does nothing. No child elements. Adjusts the image's rectangle during the drawing of the ItemImageUIElement.

AdjustImageDisplayRect may be needed when the image resides on a button that is pressed. In this case, the image may be offset 1 pixel right and down.

 The display rect to adjust. Draws the borders for the item image. The used to provide rendering information. Initializes the Appearance for the ItemImageUIElement. Read-only property that returns the associated item of the ItemImageUIElement.

The Item property of the ItemImageUIElement will return the associated with the image. You can then fully manipulate the appearance of the item and access any of its properties or methods as needed.

 A collection of Item objects.

The Items Collection contains every housed within a certain level. You can add and remove items at the collection level. Also, you can gain access to the individual items and their properties through the corresponding collection. The following code shows two different ways to retrieve the Key for the item housed at the first position within the Items collection.

MsgBox(UltraListBar1.Groups(0).Items.Item(0).Key)

MsgBox(UltraListBar1.Groups(0).Items(0).Key)

 Constructor used for de-serialization of the Items Collection. Parameters used are SerializationInfo and StreamingContext. The used to obtain the serialized properties of the object Context for the deserialization Serialize the collection Overloaded method used to add an item to the Items collection.

The Add method will add an to the collection. You have four options on how you would like to add this item. You can pass a specific item you would like to add to the collection or simply add a new item to the collection without passing any arguments. This method will add a specific existing item to the end of the collection.

UltraListBar1.Groups(0).Items.Add(myItem)

The parameter passed must be dimmed as an

Must be an Item Removes an item from the collection. Must be a Item Method used to remove the item at a specific index from the collection.

The RemoveAt method must be passed an integer. The item at the specified will be removed from the collection. The following code will remove the item that resides at the first position within the collection.

UltraListBar1.Groups(0).Items.RemoveAt(0)

 Inserts the item into the collection at a specific index. Returns a null string. Overloaded method used to add an item to the end of the Items collection.

The Add method will add an to the Items collection. You have four options on how you would like to add this item. You can pass a specific item you would like to add to the collection or simply add a new item to the collection without passing any arguments. This method will add an item and assign it the default values for the Key and the properties.

 The newly added item Overloaded method used to add an item to the end of the Items collection.

The Add method will add an to the Items collection. You have four options on how you would like to add this item. You can pass a specific item to add to the collection or simply add a new item to the collection without passing any arguments. This method will add an item and assign it the specific Key passed to the method. The key must be a string and it must be unique.

UltraListBar4.Groups(0).Items.Add("myKey")

 The key to assign the new item The newly added item Overloaded method used to add an item to the end of the Items collection.

The Add method will add an to the Items collection. You have four options on how you would like to add this item. This code will add an item to the collection with the specified Key and . The key and the text must be string variables.

UltraListBar1.Groups(0).Items.Add(myKey, myText)

 The key to assign the new item The text for the new item The newly added item Overloaded method used to insert an item into the Items collection at the specified index.

The Insert method will add an to the Items collection and assign it a specific position within the collection. The parameter passed must be an integer and since the collection is zero-based the index cannot exceed one less than the number of items within the collection (Count - 1). There are three different options on how you would like to insert an item. This method will insert an item at a specific position within the collection and assign it the default values for the Key and properties.

UltraListBar1.Groups(0).Items.Insert(3)

 Where to insert the new item The newly added item Overloaded method used to insert an item into the Items collection at the specified index with a predetermined key value.

The Insert method will add an to the Items collection and assign it a specific position within the collection. The parameter passed must be an integer and not exceed one less than the number of items within the collection (zero-based). There are three different options on how you would like to insert an item. This method will insert an item at a specific position within the collection and assign it the predetermined value for the Key and the default value.

UltraListBar1.Groups(0).Items.Insert(3, "myKey")

 Where to insert the new item The key to assign the new item The newly added item Overloaded method used to insert an item into the Items collection at the specified index with a predetermined key and text values.

The Insert method will add an to the Items collection and assign it a specific position within the collection. The parameter passed must be an integer and not exceed one less than the number of items within the collection (zero-based). There are three different options on how you would like to insert an item. This method will insert an item at a specific position within the collection and assign it the predetermined values for the Key and properties. The key and text values must be strings.

UltraListBar1.Groups(0).Items.Insert(3, "myKey", "myText")

 Where to insert the new item The key to assign the new item The text for the new item The newly added item Method used to clear the Items collection of all items.

The Clear method will empty the Items collection of every .

UltraListBar1.Groups(0).Items.Clear()

 Method used to remove a specific item from the Items collection.

The Remove method will extract a specified from the Items collection. The method must be passed an Item parameter.

 IEnumerable Interface Implementation that returns a type safe enumerator. A type safe enumerator Called when a property on a sub object has been changed. PropChangeInfo contains information on which subobject changed and which property of the subobject changed. A collection of Item objects.

The Items Collection contains every housed within a certain level. You can add and remove items at the collection level. Also, you can gain access to the individual items and their properties through the corresponding collection. The following code shows two different ways to retrieve the Key for the item housed at the first position within the Items collection.

MsgBox(UltraListBar1.Groups(0).Items.Item(0).Key)

MsgBox(UltraListBar1.Groups(0).Items(0).Key)

 Generic indexer Read-only property that returns false if the collection can be increased or decreased in size.

The ISFixedSize property will return true if you are not able to add or remove an from the collection.

MsgBox(UltraListBar1.Groups(0).Items.IsFixedSize)

 Integer indexer.

The Integer indexer reflects the position of the within the collection. The is zero-based.

 String indexer.

The String indexer references the items by their key value. The Key value must be a string and it must be unique.

 Abstract property that specifies the initial capacity of the Items collection. Read-only property that returns true if the Items collection is read-only.

The IsReadOnly property allows you to determine if the collection is read-only.

MsgBox(UltraListBar4.Groups(0).Items.IsReadOnly())

 Enumerator for the ItemsCollection. Type-safe version of Current. Class that encapsulates the graphical interface that houses the text of an item.

This UIElement is the sub object of the that houses the text area of an element.

 Default constructor that creates a new ItemTextUIElement. Parameters needed are UIElement and a text string. The parent element The text Does nothing. No child elements. Returns true to indicate that the text should be wrapped to the next line. The ItemUIElement class encapsulates the graphical interface of an item and its behavior as a button.

The ItemUIElement class is composed of two UIElements: the and the . These UIElements deal with the appearance of the item and the ItemImageUIElement also functions as a button for selecting the .

 Constructor for the ItemUIElement class. The constructor will create the child UIElements when passed a parent UIElement and an . The parent element The item Method that initializes the for an . The appearance structure to initialize The properties that are needed Positions the child elements within the ItemUIElement.

The child elements for the ItemUIElement are the and the

Does nothing. No background is drawn The used to provide rendering information. Does nothing The used to provide rendering information. Gets the size and postion of this element Adjusts the size and postion of this element Called when the mouse down message is received over the ItemUIElement.

If the mouse is left clicked over the adjustable area of the ItemUIElement, true will be returned. The mouse messages will be forwarded to the UIElement that it has been passed by reference.

 Mouse event arguments True if left clicked over adjustable area of element. If not null on return will capture the mouse and forward all mouse messages to this element. If true then bypass default processing Called when the mouse is released over an element Mouse event arguments Returning true will ignore the next click event. Returns true if the point is over the ItemUIElement. In client coordinates Returns true if the point is over the element. Read-only property that returns the associated item.

The Item property gives you access to the associated with the ItemUIElement. This would allow you access to the properties of that item and greater flexibility in controlling the of the item.

 Returns true to clip the child elements. Returns the cursor related to the AppearanceData for the ItemUIElement. Gets the button style for the element. Indicates if the button style requires invalidation of the element on the MouseEnter and MouseExit Returns 'true'. Values that uniquely identify each control property. The property. The property. The property. The property. The property. The property. The property. The property. The property. The property. The property. The property. The property. The collection. The property. The property. The used when groups are added. The is used when the property is set to use small icons. The is used when the property is set to use large icons. The button style used to display the . The state of the . determines if default context menus are shown. Determines whether or not group headers are shown. Exposes a instance for this assembly. Returns the resource string using the specified name and default culture. Name of the string resource to return. Arguments supplied to the string.Format method when formatting the string. Returns the resource string using the specified resource name and default culture. The string is then formatted using the arguments specified. Name of the string resource to return. Returns the resource object using the specified name. Name of the resource item An object containing the specified resource Returns the for this assembly. Infragistics' UltraListBar control Default constructor for the UltraListBar class. Required method for Designer support - do not modify the contents of this method with the code editor. Exits edit mode and cleans up any resources being used.

Passed a boolean value called 'disposing' to determine if the resources should be cleaned up.

 Called when a property or sub object's property value has changed. An that contains the event data. Called when a property has changed on a sub object.

OnPropertyChanged will also be called.

 PropChangeInfo contains information on which subobject changed and which property of the subobject changed. Read-only property that determines if the collection needs to be serialized.

The ShouldSerializeGroups property returns true if the number of groups is greater than one or if there is one that needs to be serialized.

 Always returns false. Method used to clear the Groups collection of all groups.

The ResetGroups method will rid the collection of every . You can use the Clear method to clear all the groups from the collection as well.

UltraListBar1.Groups.Clear()

 Determines if the Appearance collection needs to be serialized. Method used to clear the Appearances collection.

The ResetAppearances method rids the collection of all appearances. The Clear method can also be used to clear the Appearances collection.

UltraListBar4.Appearances.Clear()

 Called when the control is first created. Read-only property that returns true if the property is not set to its default value. Read-only property that returns true if the GroupHeadersVisible property is not set to its default value. Resets the property back to its default value. Resets the GroupHeadersVisible property back to its default value. Returns true if the property is not set to its default value. Resets the property back to its default value. Called when the control is resized. Called when a is . An that contains the event data. Called when an is selected. An that contains the event data. Called after a default context menu item was clicked. The default implementation raises the event, Called before a default context menu item was clicked. The default implementation raises the event, Read-only property that returns true if the property is not null. Method that sets the SmallImageList property to null. Read-only property that returns true if the property is not null. Method used to set the LargeImageList property to null. Read-only property that returns true if the has any non-default property values set. Method used to reset all property values to their default values. Read-only property that returns true if the has any non-default property values set. Method used to reset all the property values to their default values. Read-only property that returns true if the has any non-default property values set. Method used to reset all property values to their default values. Exits edit mode and applies any changes to the . Edit mode was entered by calling the method of a or . Exits edit mode and applies any changes to the . Edit mode was entered by calling the method of a or . True if changes are to be discarded, false otherwise Read-only property that returns true if the property is not set to its default value. Method used to reset the property to its default value. // BF 7.3.01 Initialize private member variables here. Most useful for our object properties; Some of the System classes don't have overloads that enable the setting of certain properties when the object is contructed, so we'll do that here Indicates if the point should be handled by the control at design time. Point in client coordinates. True if notifications about the specified point should be handled by the control. Event that is fired when a group is selected.

The GroupSelected event returns a reference to the that has been . You can retreive the of the selected group to enable you to perform multiple tasks. The following code will set an integer variable to the selected group's index.

Dim selectedGroup As Integer

selectedGroup = e.Group.Index

 Event that is fired when a key is pressed and released.

The KeyPress event returns a reference (the KeyChar) of the key that has been pressed. The KeyPress will fire after the KeyUp event.

 Event that is fired when a key is pressed.

The KeyDown event returns a reference (the KeyChar) of the key that has been pressed. This event is fired before the KeyUp and KeyPress events.

 Event that is fired when a key is released.

The KeyUp event returns a reference (the KeyChar) of the key that has been pressed. This event is fired before the KeyPress event and after the KeyDown event.

 Event that fires when an item is selected.

The ItemSelected event returns a reference to the that has been selected. You can retreive the of the selected item to enable you to perform several different tasks. The following code will set a variable to the selected item's index.

When more than one group is contained within the control, it is necessary to check the index of the group as well before performing any processing.

Dim selectedItem As Integer

selectedItem = e.Item.Index

If e.Item.Group.Index = 0 Then ' checks to be sure that this occurs only when the first group's first item is clicked

UltraListBar1.Groups(0).Text = "Item Selected!"

End If

 Event that fires before item is selected on default context menu. Event that fires after item is selected on default context menu. Returns the event handler that is notified when a property on a sub object has changed. Returns the if it has images. Otherwise, it returns . Read-only property that returns the main UIElement of the UltraListBar control.

Returns the ControlUIElement that contains all the visible graphics of the control. Other UIElements that are contained by the main element include: , , , , , and .

 Read-only property that returns the main UIElement of the UltraListBar.

Returns the UIElement that contains all the visible graphics of the control. Other UIElements that are contained by the main element include: , , , , , and .

 Control Text - not used Control Tabstop - not used Control Tabindex - not used BackColor property - not supported ForeColor property - not supported Property that gets/sets the Groups collection assigned to the UltraListBar.

The Groups property gets/sets the Groups collection that is associated with the control. Obtaining a reference to the Groups collection enables you to access each within the collection as well. When setting this property, be sure to set it to a variable defined as Infragistics.Win.UltraWinListBar.GroupsCollection. The following code will create a Groups collection and add a group to the collection.

Dim myGroupCollection As Infragistics.Win.UltraWinListBar.GroupsCollection

Dim myGroup As Infragistics.Win.UltraWinListBar.Group

myGroupCollection.Add(myGroup)

UltraListBar1.Groups = myGroupCollection

 Used to serialize the groups collection. Read-only property that returns the Appearances collection.

The Appearances property allows you to determine the Appearance objects that have been assigned to different graphical elements within the application. You can add and remove appearances to the collection as well as manipulate individual properties of each .

Dim myAppearances As Infragistics.Win.AppearancesCollection

myAppearances = UltraListBar4.Appearances()

 Read-only property that returns the currently selected Group object.

The SelectedGroup property returns the that is the group. If there is currently no group that is selected, the property will return a -1. The following code will return the index of the selected group.

MsgBox(UltraListBar4.SelectedGroup.Index)

This code will return the text of the selected group.

MsgBox(UltraListBar4.SelectedGroup.Text)

 Property that gets/sets the orientation of the control.

The Orientation property determines whether the UltraListBar control is positioned horizontally or vertically.

UltraListBar1.Orientation = Infragistics.Win.UltraWinListBar.Orientation.Vertical

 Property that gets/sets whether the control shows group headers.

The GroupHeadersVisible property determines whether the Group headers are visible.

 Property that gets/sets whether the context menu will automatically be shown at runtime when the user right clicks on the control. Property that gets/sets the imagelist used to supply images when the is set to SmallIcons.

The SmallImageList property must be set to a variable dimmed as an ImageList.

Dim myImageList As ImageList

UltraListBar1.SmallImageList = myImageList

 Property that gets/sets the imagelist used to supply images for when the property is set to LargeIcons.

The LargeImageList property must be set to a variable dimmed as an ImageList.

Dim myImageList As ImageList

UltraListBar1.LargeImageList = myImageList

 Property that gets/sets the default appearance for items within the entire control.

The ItemAppearance property must be set to a variable dimmed as an Appearance object. The property will also return an Appearance type.

Dim myAppearance As Infragistics.Win.Appearance

UltraListBar1.ItemAppearance = myAppearance

 Read-only property that returns true if an object has been created. Property that gets/sets the default appearance for group headers.

The HeaderAppearance property is used to assign an Appearance object to the header of a group. It can also be used to retrieve the Appearance object that has been previously assigned.

Dim myAppearance As Infragistics.Win.Appearance

UltraListBar1.HeaderAppearance = myAppearance

 Read-only property that returns true if a object has been created and assigned to the object. Property that gets/sets the default for the control.

The Appearance object encapsulates the behaviors of the properties related to visual formatting. After you create an Appearance object, you can manipulate its properties and reuse the object as ofte as you wish within your project.

Dim myAppearance As Infragistics.Win.Appearance

myAppearance.BackColor = System.Drawing.Color.Aquamarine

 Read-only property that returns true if an object has been assigned to the control. Property that gets/sets the default icon used to display items. Property that gets/sets the default style (large or small icons) for items in newly created Groups. Property that gets/sets the style for the borders for the entire control.

The BorderStyle property has ten settings. The BorderStyle can be dashed, dotted, raised, solid, etched, inset or have none of these qualities.

UltraListBar1.BorderStyle = Infragistics.Win.UIElementBorderStyle.InsetSoft

 Display the about dialog Return the license we cached inside the constructor Read-only property that returns the default height and width of the control. Overrides the control's background and hides the image so that the appearance can be used instead. Adds verbs to the right click menu at design time Adds a group Allow user to remove group provided one group always exists. Adds an item to an existing group Adds verbs to the collection Gets the for this designer's control/component. Provides DesignerActionItems for the SmartTag associated with the UltraListBar. Constructor The UltraListBar Overrides CreateActionItems. The list to populate. Used by SmartTag Panel. Used by SmartTag Panel. Used by SmartTag Panel. Used by SmartTag Panel. The main UIElement for an UltraListBar.

The UltraListBarUIElement occupies the entire area of the control.

 Called when a mouse down message is received.

When the OnPreMouseDown is passed 'true', normal mouse down processing will be skipped.

 True will cause normal mouse down processing to be skipped. Draws the control's back color.

The background will only be draw here if the property is set to dotted or dashed. Otherwise, the drawing of the background is handled by the child elements.

 The used to provide rendering information. Does nothing. Background image is not drawn. The used to provide rendering information. Initializes the for the control. The appearance structure to initialize The properties that are needed Sizes and positions the child UIElements for the control. Read-only property that returns a of InsetSoft if that property ise set to its default value. Read-only property that returns all borders. Read-only property that returns an integer that reflects the number of child elements expected to be created. Read-only property that returns the related UltraListBar control.