ProgressBar.PerformStep Метод

Определение

Пространство имен:

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

Исходный код:

ProgressBar.cs

Перемещает текущую позицию индикатора Step хода выполнения по количеству свойства.

public:
 void PerformStep();

public void PerformStep();

member this.PerformStep : unit -> unit

Public Sub PerformStep ()

Исключения

InvalidOperationException

Style задан как Marquee.

Примеры

В следующем примере кода используется 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

Комментарии

Метод PerformStep увеличивает значение индикатора хода выполнения по сумме, указанной свойством Step . Свойство можно использовать Step для указания суммы, которую каждая завершенная задача в операции изменяет значение индикатора выполнения. Например, если вы копируете группу файлов, может потребоваться задать для свойства значение Step 1, а значение Maximum свойства — общее количество файлов для копирования. При копировании каждого файла можно вызвать PerformStep метод, чтобы увеличить индикатор хода выполнения по значению Step свойства. Если требуется более гибкий контроль над значением индикатора выполнения, можно использовать Increment метод или задать значение Value свойства напрямую.

Свойство Value указывает текущую позицию ProgressBarобъекта . Если после вызова PerformStep метода Value свойство больше значения Maximum свойства, Value свойство остается в значении Maximum свойства. Если после вызова PerformStep метода с отрицательным значением, указанным в Step, Value свойство меньше значения Minimum свойства, Value свойство остается в значении Minimum свойства.

ProgressBar Так как объект, стиль которого установлен для Marquee отображения непрерывной прокрутки, а не егоValue, вызов PerformStep не является ненужным и приведет к возникновениюInvalidOperationException.

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

• Maximum
• Minimum
• Step
• PerformStep()
• Value