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 объекта при копировании файла. В этом примере требуется ProgressBar созданный элемент управления с именем pBar1 , созданный в Form, и созданный метод с именем CopyFile (который возвращает логическое значение, указывающее, что операция копирования файла была успешно завершена), который выполняет операцию копирования файла. Код также требует, чтобы массив строк, содержащий файлы для копирования, был создан и передан 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 свойства можно указать, насколько каждая завершенная задача в операции изменяет значение индикатора выполнения. Например, при копировании группы файлов может потребоваться задать для свойства значение Step 1, а для свойства Maximum — общее количество копируемых файлов. При копировании каждого файла можно вызвать PerformStep метод , чтобы увеличить индикатор выполнения на значение Step свойства . Если требуется более гибкий контроль над значением индикатора выполнения, можно использовать Increment метод или задать значение Value свойства напрямую.

См. также раздел

• PerformStep()
• Value
• Increment(Int32)