Back to Devexpress

StepProgressBarItem Members

windowsforms-devexpress-dot-xtraeditors-dot-stepprogressbaritem-dot-underscore-members.md

latest11.2 KB
Original Source

StepProgressBarItem Members

An item that visualizes a progress milestone or step. A StepProgressBar control stores progress items in the StepProgressBar.Items collection.

Constructors

NameDescription
StepProgressBarItem()Initializes a new instance of the StepProgressBarItem class.
StepProgressBarItem(String)Initializes a new instance of the StepProgressBarItem class with specified settings.

Properties

NameDescription
AllowUserInteractionGets or sets whether a user can move focus to the StepProgressBar item using the keyboard and select the item on click.
AppearanceProvides access to appearance settings for this item.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContentBlock1Provides access to the first content block of this item.
ContentBlock2Provides access to the second content block of this item.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
EnabledGets or sets whether the step item is enabled. Users cannot select disabled step items.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
IsActiveReturns the current item state.
IsFirstItemIndicates whether the item is the first item in the step progress bar items collection.
IsLastItemIndicates whether the item is the last item in the step progress bar items collection.
NameGets or sets the item name.
OptionsProvides access to properties that allow you to override global item settings specified in the StepProgressBar.ItemOptions section.
ProgressGets or sets the current progress towards this item.
SiteGets or sets the ISite of the Component. Inherited from Component.
StateGets or sets whether this item is active (selected). To activate an item, you can also use StepProgressBar.SelectedItemIndex, StepProgressBar.SelectItem(StepProgressBarItem), and StepProgressBar.SelectNext() / StepProgressBar.SelectPrevious() properties and methods.
TagGets or sets a custom object associated with the current item.

Methods

NameDescription
CreateObjRef(Type)Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose()Releases all resources used by the Component. Inherited from Component.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetLifetimeService()Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetNextItem()Returns the next item.
GetPreviousItem()Returns the previous item.
GetService(Type) protectedReturns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType()Gets the Type of the current instance. Inherited from Object.
InitializeLifetimeService()Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
ToString()Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

NameDescription
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
ProgressChangedOccurs when a specific item’s Progress property is changed.
StateChangedOccurs when the item state changes from Active to Inactive, or vice versa.

See Also

StepProgressBarItem Class

DevExpress.XtraEditors Namespace