ScrollingScrollCompletedEventArgs.CorrelationId Propriété

Définition

Espace de noms:

Microsoft.UI.Xaml.Controls

Obtient l’ID de corrélation associé au changement de décalages, précédemment retourné par ScrollTo, ScrollByou AddScrollVelocity.

public:
 property int CorrelationId { int get(); };

int CorrelationId();

public int CorrelationId { get; }

var int32 = scrollingScrollCompletedEventArgs.correlationId;

Public ReadOnly Property CorrelationId As Integer

Valeur de propriété

Int32

int

L’ID de corrélation associé aux décalages change.

Remarques

Chaque modification de défilement ou de zoom par programmation est associée à un numéro d’ID de corrélation particulier. Ce nombre est fourni lors de la demande d’une modification d’affichage avec ScrollTo, ScrollBy, AddScrollVelocity, ZoomToou ZoomByAddZoomVelocity en tant que valeur de retour. Un ID de corrélation est également fourni dans l’événement BringIntoView déclenché au début d’une participation à une demande de mise en vue. Cela marque le début de la durée de vie d’un ID de corrélation.

Ce même nombre est ensuite exposé dans les événements suivants tels que ScrollAnimationStarting et ScrollCompleted, ou ZoomAnimationStarting et ZoomCompleted. Cela vous permet de faire correspondre des événements avec leur appel ou demande de méthode de déclenchement.

La durée de vie d’un ID de corrélation se termine toujours par un événement d’achèvement : ScrollCompleted ou ZoomCompleted.

Les durées de vie des ID de corrélation peuvent se chevaucher. Par exemple, deux appels dos à dos ScrollTo génèrent deux ID de corrélation avec des durées de vie qui se chevauchent.

Lorsqu’une nouvelle modification d’affichage est demandée alors qu’une ancienne est toujours en cours, l’ancienne est annulée. Cette annulation déclenche un ScrollCompleted événement ou ZoomCompleted avec l’ancien CorrelationId.