GrapeCity MultiRow Windows Forms Documentation
Maximum Property (ProgressBarCell)


Gets or sets the maximum value of the range of the ProgressBarCell.
Syntax
<SRCategoryAttribute("Behavior")>
<SRDescriptionAttribute("Indicates the upper range boundary the ProgressBarCell is working with.")>
<DefaultValueAttribute()>
<RefreshPropertiesAttribute(RefreshProperties.Repaint)>
Public Property Maximum As Integer
Dim instance As ProgressBarCell
Dim value As Integer
 
instance.Maximum = value
 
value = instance.Maximum
[SRCategory("Behavior")]
[SRDescription("Indicates the upper range boundary the ProgressBarCell is working with.")]
[DefaultValue()]
[RefreshProperties(RefreshProperties.Repaint)]
public int Maximum {get; set;}

Property Value

A System.Int32 value that represents the maximum value. The default is 100.
Exceptions
ExceptionDescription
System.ArgumentOutOfRangeException

The specified value is less than the Minimum value.

-or-

The specified value is greater than the System.Int32.MaxValue.

Remarks

This property specifies the upper limit of the Cell.Value property. When the value of the Cell.Value property is equal to the value of the Maximum property, the progress bar is completely filled.

You can use this property to specify a value to which the Cell.Value property must be set (by setting the Cell.Value property or using the Increment or PerformStep methods) to indicate that an operation is complete. For example, you can set the value of the Maximum property to the total number of files in a file copy operation. Each time a file is copied, the Cell.Value property can be increased by one until the total number of files is copied. At that point, the progress bar would be completely filled.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

ProgressBarCell Class
ProgressBarCell Members

 

 


Copyright © GrapeCity, inc. All rights reserved.