ProgressPanel Class
Represents a control showing an await message to a user.
Namespace: DevExpress.XtraWaitForm
Assembly: DevExpress.XtraEditors.v23.2.dll
NuGet Package: DevExpress.Win.Navigation
Declaration
public class ProgressPanel :
BaseStyleControl,
ITransparentBackgroundManager,
ISupportLookAndFeelRemarks
The ProgressPanel is a control intended to show an await message to a user. It contains a wait indicator, a message caption and description.
Tip
If you need to display an await message in a separate window, use the WaitForm control.
The following properties affect the layout and appearance of the control’s caption, description and image:
- ProgressPanel.Caption and ProgressPanel.Description — specify the message caption and description, respectively (changing these properties does not automatically resize the control horizontally, you need to resize it manually). You can also localize the default caption (‘Please Wait’) and description (‘Loading…’) using the StringId.ProgressPanelDefaultCaption and StringId.ProgressPanelDefaultDescription values;
- ProgressPanel.ShowCaption and ProgressPanel.ShowDescription — allow you to hide the message caption and description;
- ProgressPanel.AppearanceCaption and ProgressPanel.AppearanceDescription — allow you to customize the appearance (font settings and the foreground color) of the message caption and description;
- ProgressPanel.CaptionToDescriptionDistance — specifies the vertical distance between the caption and description;
- ProgressPanel.AnimationToTextDistance — specifies the horizontal distance between the wait indicator and the message caption and description;
- ProgressPanel.ImageHorzOffset — specifies the horizontal distance between the control’s left edge and the wait indicator;
- ProgressPanel.ContentAlignment — specifies the alignment of the caption, description and wait indicator relative to the control;
- Visible — use this inherited property to specify the control visibility.
The ProgressPanel.WaitAnimationType property specifies the wait indicator type:
Default (depends on a skin)
Line
Ring
Bar
In the Default mode, the wait indicator is an animated image determined by the currently applied skin. See the Look And Feel and Skinning article to learn how to apply a skin to forms and controls.
In the Line, Ring and Bar modes, the wait indicator behavior and appearance can be specified using the following options:
- ProgressPanel.AnimationSpeed and ProgressPanel.AnimationAcceleration — specifies the speed and acceleration of wait indicators;
- ProgressPanel.AnimationElementCount — specifies the number of wait indicator visual elements;
- ProgressPanel.RingAnimationDiameter — specifies the diameter, in pixels, of the ring wait indicator;
- ProgressPanel.LineAnimationElementType and ProgressPanel.LineAnimationElementHeight — specifies the shape and height of the line indicator visual elements;
- ProgressPanel.BarAnimationElementLength, ProgressPanel.BarAnimationElementThickness and ProgressPanel.BarAnimationMotionType — specifies the length, thickness and motion type of the bar indicator.
Tooltips
DevExpress controls support regular and super tooltips. If the ShowToolTips option is enabled, tooltips are shown when the mouse pointer hovers over the control.
Use the following properties to specify a regular tooltip’s content:
- ToolTip — A regular tooltip’s text. If the text is not specified, the tooltip is not displayed even if the title is specified. You can use line breaks in regular tooltips. Use the AllowHtmlTextInToolTip property to specify whether to parse HTML tags in the text. HTML tags allow you to format the text: size, style, hyperlinks, etc.
- ToolTipTitle — A regular tooltip’s title. If the title is not specified, it is not displayed.
ToolTipIconType — A regular tooltip’s predefined icon. Use the controller’s IconSize property to specify the image size.
To display a custom image in all regular tooltips, use the controller’s ImageList and ImageIndex properties.
To display a custom image in a specific regular tooltip, handle the BeforeShow event. Use the ImageOptions event argument to assign a raster or vector image to the processed tooltip.
Use the SuperTip property to assign a super tooltip to a control. Enable the AllowHtmlText property to use HTML tags in the super tooltip.
To replace regular tooltips with super tooltips, set the ToolTipController.ToolTipType property to SuperTip. The controller automatically converts regular tooltips to super tooltips. To access this property, you can use the DefaultToolTipController component or a custom controller assigned to the ToolTipController property. See the following topic for more information: Hints and Tooltips.