Version

WinCarousel Properties

Introduction

This topic provides list of properties of the UltraCarousel control and its commonly used objects.

WinCarousel (property) reference chart

The following table summarizes the purpose and functionality of the UltraCarousel control’s featured properties.

Property name Type Description

CarouselItem

A single selected item. This can be any visible CarouselItem in the Items collection.

CarouselItemsCollection

This is a collection of CarouselItem objects that can be rendered by the control. When used with data binding, the collection is automatically populated and cannot be manually modified.

Size

Specifies the dimensions of the item.

object

Used for data binding that can be a collection, list or an array.

Path

Specifies the pathway on a 2-dimensional plane on which the carousel items are rendered.

Boolean

Inherited from System.WindowsForms.Control indicates if the carousel control can be rendered or hidden when the application runs.

CarouselItem (property) reference chart

The following table summarizes the purpose and functionality of the CarouselItem object’s featured properties.

Property name Type Description

Boolean

Used to determine if the item is currently the carousel’s ActiveItem.

Boolean

Used to determine if the item is selected through user interaction.

ItemSettings

Contains various item related settings that affect this specific carousel item.

Boolean

System.WindowsForms.Control indicates if the item can be rendered on the path.

CarouselPath (property) reference chart

The following table summarizes the purpose and functionality of the CarouselPath object’s featured properties.

Property name Type Description

int

Specifies how many frames of animation is allocated to move from one position on the path to another. As the number of frames increase, the speed of the items moving between positions will decrease.

int

Specifies the number of slots allocated for items ( Default=5 ).

float

This is a collection of PathOpacityStop objects used to define how opaque items are rendered based on their position on the path.

float

This is a collection of PathScalingStop objects used to define how items are scaled based on their position on the path.

ItemRenderingOrder

Indicates items rendering order based on the following factors:

Linear – Items are rendered based on the order in the items collection.

Opacity – Items are sorted based on the resolved opacity prior to rendering.

Scaling – Items are sorted based on the resolved scaling prior to rendering.

ItemWrappingMode

Indicates items wrapping based on the following factors:

Standard – Indicates that Items will wrap to fill available item slots.

If there are more item slots than carousel items, the remaining items will not be filled.

RepeatItems – Indicates that Items will wrap to fill available item slots.

If there are more item slots than carousel items, items will be repeated along the path.

None – Indicates that Items will not wrap to fill available item slots.

int

Specifies the space margin on four sides of the path, between the edge of the path and the border across ( Left, Top, Right and Bottom ).

Boolean

Indicates whether the items will snap to the fixed item slots after the animation occurs. Default=True

ItemSettings (property) reference chart

The following table summarizes the purpose and functionality of the ItemSettings object’s featured properties.

Property name Type Description

AppearanceBase

Specifies the item styling in its Normal state.

AppearanceBase

Specifies the item styling when it is the active item.

AppearanceBase

Specifies the item styling when the mouse moves over the item.

UIElementBorderStyle

Specifies the border appearance of the item when rendered.

AppearanceBase

Exposes various Appearance properties for carousel items in pressed state.

AppearanceBase

Exposes various Appearance properties for carousel items in selected state.

Size

Specifies the size of the item image.