ProgressBarRenderer.DrawVerticalChunks(Graphics, Rectangle) Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ProgressBarRenderer.cs

Draws a set of progress bar pieces that fill a vertical progress bar.

public:
 static void DrawVerticalChunks(System::Drawing::Graphics ^ g, System::Drawing::Rectangle bounds);

public static void DrawVerticalChunks (System.Drawing.Graphics g, System.Drawing.Rectangle bounds);

static member DrawVerticalChunks : System.Drawing.Graphics * System.Drawing.Rectangle -> unit

Public Shared Sub DrawVerticalChunks (g As Graphics, bounds As Rectangle)

Parameters

g

Graphics

The Graphics used to draw the progress bar.

bounds

Rectangle

The Rectangle that specifies the bounds to be filled by progress bar pieces.

Exceptions

InvalidOperationException

The operating system does not support visual styles.

-or-

Visual styles are disabled by the user in the operating system.

-or-

Visual styles are not applied to the client area of application windows.

Examples

The following code example uses the DrawVerticalChunks method in a Timer.Tick event handler to draw each increment of a progress bar. This code example is part of a larger example provided for the ProgressBarRenderer class.

    // Handle the timer tick; draw each progressively larger rectangle.
private:
    void progressTimer_Tick(Object^ myObject, EventArgs^ e)
    {
        if (ticks < NumberChunks)
        {
            Graphics^ g = this->CreateGraphics();
            ProgressBarRenderer::DrawVerticalChunks(g,
                progressBarRectangles[ticks]);
            ticks++;
        }
        else
        {
            progressTimer->Enabled = false;
        }
    }

// Handle the timer tick; draw each progressively larger rectangle.
private void progressTimer_Tick(Object myObject, EventArgs e)
{
    if (ticks < NumberChunks)
    {
        using (Graphics g = this.CreateGraphics())
        {
            ProgressBarRenderer.DrawVerticalChunks(g,
                progressBarRectangles[ticks]);
            ticks++;
        }
    }
    else
    {
        progressTimer.Enabled = false;
    }
}

' Handle the timer tick; draw each progressively larger rectangle.
Private Sub progressTimer_Tick(ByVal myObject As [Object], ByVal e As EventArgs) 
    If ticks < NumberChunks Then
        Dim g As Graphics = Me.CreateGraphics()
        Try
            ProgressBarRenderer.DrawVerticalChunks(g, progressBarRectangles(ticks))
            ticks += 1
        Finally
            g.Dispose()
        End Try
    Else
        progressTimer.Enabled = False
    End If

End Sub

Remarks

Each progress bar piece drawn by this method spans the width of the bounds parameter. The number of progress bar pieces drawn is determined by the height of bounds and the values returned by ChunkSpaceThickness and ChunkThickness.

Before using this method, you should verify that the IsSupported property returns true.