ProgressBar.PerformStep Méthode

Définition

Fait avancer la position actuelle de la barre de progression de la quantité de la propriété Step.Advances the current position of the progress bar by the amount of the Step property.

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

Exceptions

Exemples

L’exemple de code suivant utilise un contrôle ProgressBar pour afficher la progression d’une opération de copie de fichier.The following code example uses a ProgressBar control to display the progress of a file copy operation. L’exemple utilise les propriétés Minimum et Maximum pour spécifier une plage pour le ProgressBar qui est équivalent au nombre de fichiers à copier.The example uses the Minimum and Maximum properties to specify a range for the ProgressBar that is equivalent to the number of files to copy. Le code utilise également la propriété Step avec la méthode PerformStep pour incrémenter la valeur de la ProgressBar lorsqu’un fichier est copié.The code also uses the Step property with the PerformStep method to increment the value of the ProgressBar as a file is copied. Cet exemple nécessite que vous ayez un contrôle ProgressBar créé nommé pBar1 qui est créé dans un Form, et qu’il existe une méthode appelée CopyFile (qui retourne une valeur booléenne indiquant que l’opération de copie de fichier a été effectuée avec succès). effectue l’opération de copie de fichiers.This example requires that you have a ProgressBar control created called pBar1 that is created within a Form, and that there is a method created called CopyFile (that returns a Boolean value indicating the file copy operation was completed successfully) that performs the file copy operation. Le code requiert également qu’un tableau de chaînes contenant les fichiers à copier soit créé et passé à la méthode CopyWithProgress définie dans l’exemple, et que la méthode soit appelée à partir d’une autre méthode ou d’un autre événement dans le Form.The code also requires that an array of strings containing the files to copy is created and passed to the CopyWithProgress method defined in the example, and that the method is called from another method or event in the 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 méthode PerformStep incrémente la valeur de la barre de progression de la quantité spécifiée par la propriété Step.The PerformStep method increments the value of the progress bar by the amount specified by the Step property. Vous pouvez utiliser la propriété Step pour spécifier la quantité que chaque tâche terminée dans une opération modifie la valeur de la barre de progression.You can use the Step property to specify the amount that each completed task in an operation changes the value of the progress bar. Par exemple, si vous copiez un groupe de fichiers, vous souhaiterez peut-être affecter la valeur 1 à la propriété Step et la valeur de la propriété Maximum au nombre total de fichiers à copier.For example, if you are copying a group of files, you might want to set the value of the Step property to 1 and the value of the Maximum property to the total number of files to copy. Quand chaque fichier est copié, vous pouvez appeler la méthode PerformStep pour incrémenter la barre de progression de la valeur de la propriété Step.When each file is copied, you can call the PerformStep method to increment the progress bar by the value of the Step property. Si vous souhaitez avoir un contrôle plus flexible de la valeur de la barre de progression, vous pouvez utiliser la méthode Increment ou définir la valeur de la propriété Value directement.If you want to have more flexible control of the value of the progress bar, you can use the Increment method or set the value of the Value property directly.

La propriété Value spécifie la position actuelle du ProgressBar.The Value property specifies the current position of the ProgressBar. Si, après avoir appelé la méthode PerformStep, la propriété Value est supérieure à la valeur de la propriété Maximum, la propriété Value reste à la valeur de la propriété Maximum.If, after calling the PerformStep method, the Value property is greater than the value of the Maximum property, the Value property remains at the value of the Maximum property. Si, après avoir appelé la méthode PerformStep avec une valeur négative spécifiée dans Step, la propriété Value est inférieure à la valeur de la propriété Minimum, la propriété Value reste à la valeur de la propriété Minimum.If, after calling the PerformStep method with a negative value specified in Step, the Value property is less than the value of the Minimum property, the Value property remains at the value of the Minimum property.

Étant donné qu’un objet ProgressBar dont le style est défini sur Marquee affiche une barre de défilement continue au lieu de son Value, l’appel de PerformStep n’est pas nécessaire et lève une InvalidOperationException.Because a ProgressBar object whose style is set to Marquee displays a continuously scrolling bar instead of its Value, calling PerformStep is unnecessary and will raise an InvalidOperationException.

S’applique à

Voir aussi