ProgressBar.PerformStep Метод

Определение

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

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

Увеличивает текущую позицию индикатора хода выполнения на значение свойства 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 ] ) == true )
         {
            // 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]) == true)
        {
            // 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