The progress bar cell offers features similar to the .NET Framework's ProgressBar control (System.Windows.Forms.ProgressBar). You can use the progress bar cell to visually show a percentage in the cell.
Features
In addition to the Base Cell features, the following features can also be used in the progress bar cell.
- Fill color based on the percentage value
- Display text value
For more details on each feature, refer to the ProgressBarCell class.
Data Types
The progress bar cell uses the Object type value and this type can be checked with the ProgressBarCell.ValueType property. The value cast into an Integer type is used for input and display. This type can be checked with the ProgressBarCell.FormattedValueType property. You can override the ProgressBarCell.OnCellFormatting method to modify the behavior when values are read in a cell. Override the ProgressBarCell.OnCellParsing method to modify behavior when the value is written back from the cell.
Cell Edit Control
The progress bar cell does not provide a cell edit control. The ProgressBarCell.EditType property always returns a null reference (Nothing in Visual Basic).
Styles
The progress bar cell supports the following CellStyle class members. You can set the cell style using the ProgressBarCell.Style property.
| CellStyle Members | Enabled or Disabled |
|---|---|
| BackColor | Enabled only when ProgressBarCell.UseVisualProgressBarStyle is False |
| BackgroundGradientEffect | Enabled only when ProgressBarCell.UseVisualProgressBarStyle is False |
| Border | Enabled |
| DataSourceNullValue | Enabled |
| DisabledBackColor | Enabled only when ProgressBarCell.UseVisualProgressBarStyle is False |
| DisabledForeColor | Enabled |
| DisabledGradientEffect | Enabled only when ProgressBarCell.UseVisualProgressBarStyle is False |
| EditingBackColor | - |
| EditingForeColor | - |
| Font | Enabled |
| ForeColor | Enabled |
| Format | Enabled |
| FormatProvider | Enabled |
| Image | Enabled |
| ImageAlign | Enabled |
| ImeMode | - |
| ImeSentenceMode | - |
| InputScope | - |
| LineAdjustment | Enabled only for GDI+ Compatible Mode |
| Margin | Enabled |
| MouseOverBackColor | Enabled only when ProgressBarCell.UseVisualProgressBarStyle is False |
| MouseOverForeColor | - |
| MouseOverGradientEffect | Enabled only when ProgressBarCell.UseVisualProgressBarStyle is False |
| Multiline | Enabled |
| NullValue | Enabled |
| Padding | Enabled |
| PatternColor | Enabled |
| PatternStyle | Enabled |
| SelectionBackColor | Enabled only when ProgressBarCell.UseVisualProgressBarStyle is False |
| SelectionForeColor | Enabled |
| SelectionGradientEffect | Enabled only when ProgressBarCell.UseVisualProgressBarStyle is False |
| Tag | Enabled |
| TextAdjustment | Enabled only for GDI+ Compatible Mode |
| TextAlign | Enabled |
| TextAngle | Enabled only for GDI+ Compatible Mode |
| TextEffect | Enabled |
| TextImageRelation | Enabled |
| TextIndent | Enabled |
| TextVertical | Enabled only for GDI+ Compatible Mode |
| UseCompatibleTextRendering | Enabled |
| WordWrap | Enabled |
To enable GDI+ Compatibility Mode, set the ProgressBarCell.Style.UseCompatibleTextRendering to True.
Shortcut Keys
The progress bar cell does not process shortcut keys.
Events
You can use the GcMultiRow.CellContentClick event to implement processing when clicking in the cell content area. Use the GcMultiRow.CellContentDoubleClick event for a double-click.
Comparison with Standard Control
The following table shows a comparison between major properties of the progress bar cell and the System.Windows.Forms.ProgressBar control.
| ProgressBarCell | ProgressBar |
|---|---|
| MarqueeAnimationSpeed | None |
| Maximum | Maximum |
| Minimum | Minimum |
| None | RightToLeft |
| None | RightToLeftLayout |
| Step | Step |
| ProgressBarStyle | Style |
| Value | Value |
| FillColor | None |
| FillDirection | None |
| ShowText | None |
| TextFormat | None |