WizardForm.TaskProgressGradientSpeed Property

Reference

Definition

Namespace:: Microsoft.Web.Management.Client.Win32

Assembly:: Microsoft.Web.Management.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the number of color-gradient cycles that the progress bar will display at any one time.

public:
 property int TaskProgressGradientSpeed { int get(); void set(int value); };

public int TaskProgressGradientSpeed { get; set; }

member this.TaskProgressGradientSpeed : int with get, set

Public Property TaskProgressGradientSpeed As Integer

Property Value

Int32

The number of color-gradient cycles displayed in the progress bar. The default is 1.

Exceptions

ArgumentOutOfRangeException

The value of the TaskProgressGradientSpeed property is less than 1.

Examples

The following example demonstrates the TaskProgressGradientSpeed property. This example sets the value of the TaskProgressGradientSpeed property to 3 to provide three color-gradient cycles. This code example is part of a larger example provided for the WizardForm class.

// Customize the StartTaskProgressMethod.
protected override void StartTaskProgress()
{
    TaskProgressStartColor = Color.Red;
    TaskProgressEndColor = Color.Yellow;
    // Default TaskProgressScrollSpeed is a value of 6.
    TaskProgressScrollSpeed = 2;
    // Default TaskProgressGradientSpeed is a value of 1;
    TaskProgressGradientSpeed = 3;
    //Set the task Glyph.
    TaskGlyph = Icon.FromHandle(Cursors.Arrow.Handle).ToBitmap();
    TaskGlyph.RotateFlip(RotateFlipType.Rotate90FlipNone);
    // Implement the StartTaskProgress from the base class.
    base.StartTaskProgress();
}

// Customize the StartTaskProgressMethod.
protected override void StartTaskProgress()
{
    TaskProgressStartColor = Color.Red;
    TaskProgressEndColor = Color.Yellow;
    // Default TaskProgressScrollSpeed is a value of 6.
    TaskProgressScrollSpeed = 2;
    // Default TaskProgressGradientSpeed is a value of 1;
    TaskProgressGradientSpeed = 3;
    //Set the task Glyph.
    TaskGlyph = Icon.FromHandle(Cursors.Arrow.Handle).ToBitmap();
    TaskGlyph.RotateFlip(RotateFlipType.Rotate90FlipNone);
    // Implement the StartTaskProgress from the base class.
    base.StartTaskProgress();
}

Remarks

The TaskProgressGradientSpeed property defines how many color-gradient cycles, from the value of the TaskProgressStartColor property to the value of the TaskProgressEndColor property, are displayed in the progress bar at any one time.

Applies to

Share via