ProgressBar.PerformStep Méthode

  • Référence

Définition

Espace de noms:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Fait avancer la position actuelle de la barre de progression de la quantité de la propriété Step.

public:
 void PerformStep();
public void PerformStep ();
member this.PerformStep : unit -> unit
Public Sub PerformStep ()

Exceptions

InvalidOperationException

Style a la valeur Marquee.

Exemples

L’exemple de code suivant utilise un ProgressBar contrôle pour afficher la progression d’une opération de copie de fichier. L’exemple utilise les propriétés et Maximum les Minimum propriétés pour spécifier une plage correspondant ProgressBar au nombre de fichiers à copier. Le code utilise également la propriété avec la Step PerformStep méthode pour incrémenter la valeur du ProgressBar fichier en tant que fichier copié. Cet exemple nécessite que vous ayez un ProgressBar contrôle créé appelé pBar1 qui est créé dans un Form, et qu’il existe une méthode créée appelée CopyFile (qui retourne une valeur booléenne indiquant que l’opération de copie de fichier a été terminée avec succès) qui effectue l’opération de copie de fichier. Le code nécessite également qu’un tableau de chaînes contenant les fichiers à copier soit créé et transmis à la CopyWithProgress méthode définie dans l’exemple, et que la méthode soit appelée à partir d’une autre méthode ou d’un événement dans l’exemple 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

Remarques

La PerformStep méthode incrémente la valeur de la barre de progression par la quantité spécifiée par la Step propriété. Vous pouvez utiliser la Step propriété pour spécifier la quantité que chaque tâche terminée dans une opération modifie la valeur de la barre de progression. Par exemple, si vous copiez un groupe de fichiers, vous pouvez définir la valeur de la Step propriété sur 1 et la valeur de la Maximum propriété sur le nombre total de fichiers à copier. Lorsque chaque fichier est copié, vous pouvez appeler la PerformStep méthode pour incrémenter la barre de progression par la valeur de la Step propriété. Si vous souhaitez avoir un contrôle plus flexible de la valeur de la barre de progression, vous pouvez utiliser la Increment méthode ou définir la valeur de la Value propriété directement.

La Value propriété spécifie la position actuelle du ProgressBar. Si, après avoir appelé la PerformStep méthode, la Value propriété est supérieure à la valeur de la Maximum propriété, la Value propriété reste à la valeur de la Maximum propriété. Si, après avoir appelé la PerformStep méthode avec une valeur négative spécifiée dans Step, la Value propriété est inférieure à la valeur de la Minimum propriété, la Value propriété reste à la valeur de la Minimum propriété.

Étant donné qu’un objet dont le ProgressBar style est défini pour Marquee afficher une barre de défilement continue au lieu de son Value, l’appel PerformStep est inutile et déclenchera un InvalidOperationException.

S’applique à

Voir aussi