ProgressBar.Step プロパティ

定義

名前空間:

System.Windows.Forms

アセンブリ:

System.Windows.Forms.dll

ソース:

ProgressBar.cs

PerformStep() メソッドを呼び出したときに、プログレス バーの現在の位置を進める量を取得または設定します。

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

public int Step { get; set; }

member this.Step : int with get, set

Public Property Step As Integer

プロパティ値

Int32

PerformStep() メソッドを呼び出すごとに、プログレス バーをインクリメントする量。 既定値は 10 です。

例

次のコード例では、 コントロールを ProgressBar 使用して、ファイル コピー操作の進行状況を表示します。 この例では、 Minimum プロパティと Maximum プロパティを使用して、コピーするファイルの数に相当する の範囲 ProgressBar を指定します。 また、このコードでは、 Step プロパティと メソッドを PerformStep 使用して、 の値 ProgressBar をファイルのコピー時にインクリメントします。 この例では、 内で Form作成される という名前pBar1のコントロールを作成し、ファイル コピー操作を実行する という名前のメソッド (ファイル コピー操作が正常に完了したことを示すブール値を返します) が作成CopyFileされている必要ProgressBarがあります。 また、このコードでは、コピーするファイルを含む文字列の配列を作成し、例で定義されているメソッドに CopyWithProgress 渡し、 内の別のメソッドまたはイベント Formからメソッドを呼び出す必要もあります。

private:
   void CopyWithProgress( array<String^>^filenames )
   {
      // Display the ProgressBar control.
      pBar1->Visible = true;

      // Set Minimum to 1 to represent the first file being copied.
      pBar1->Minimum = 1;

      // Set Maximum to the total number of files to copy.
      pBar1->Maximum = filenames->Length;

      // Set the initial value of the ProgressBar.
      pBar1->Value = 1;

      // Set the Step property to a value of 1 to represent each file being copied.
      pBar1->Step = 1;

      // Loop through all files to copy.
      for ( int x = 1; x <= filenames->Length; x++ )
      {
         // Copy the file and increment the ProgressBar if successful.
         if ( CopyFile( filenames[ x - 1 ] ))
         {
            // Perform the increment on the ProgressBar.
            pBar1->PerformStep();
         }
      }
   }

private void CopyWithProgress(string[] filenames)
{
    // Display the ProgressBar control.
    pBar1.Visible = true;
    // Set Minimum to 1 to represent the first file being copied.
    pBar1.Minimum = 1;
    // Set Maximum to the total number of files to copy.
    pBar1.Maximum = filenames.Length;
    // Set the initial value of the ProgressBar.
    pBar1.Value = 1;
    // Set the Step property to a value of 1 to represent each file being copied.
    pBar1.Step = 1;
    
    // Loop through all files to copy.
    for (int x = 1; x <= filenames.Length; x++)
    {
        // Copy the file and increment the ProgressBar if successful.
        if (CopyFile(filenames[x-1]))
        {
            // Perform the increment on the ProgressBar.
            pBar1.PerformStep();
        }
    }
}

Private Sub CopyWithProgress(ByVal ParamArray filenames As String())
    ' Display the ProgressBar control.
    pBar1.Visible = True
    ' Set Minimum to 1 to represent the first file being copied.
    pBar1.Minimum = 1
    ' Set Maximum to the total number of files to copy.
    pBar1.Maximum = filenames.Length
    ' Set the initial value of the ProgressBar.
    pBar1.Value = 1
    ' Set the Step property to a value of 1 to represent each file being copied.
    pBar1.Step = 1

    ' Loop through all files to copy.
    Dim x As Integer
    for x = 1 To filenames.Length - 1
        ' Copy the file and increment the ProgressBar if successful.
        If CopyFile(filenames(x - 1)) = True Then
            ' Perform the increment on the ProgressBar.
            pBar1.PerformStep()
        End If
    Next x
End Sub

注釈

プロパティを Step 使用すると、操作で完了した各タスクが進行状況バーの値を変更する量を指定できます。 たとえば、ファイルのグループをコピーする場合は、プロパティの値を 1 に設定し、プロパティのStepMaximum値をコピーするファイルの合計数に設定できます。 各ファイルがコピーされたら、 メソッドを PerformStep 呼び出して、 プロパティの値だけ進行状況バーを Step インクリメントできます。 進行状況バーの値をより柔軟に制御する場合は、 メソッドを Increment 使用するか、プロパティの値を Value 直接設定します。

こちらもご覧ください

• PerformStep()
• Value
• Increment(Int32)