ScrollingScrollCompletedEventArgs.CorrelationId プロパティ

定義

名前空間:

Microsoft.UI.Xaml.Controls

オフセットの変更に関連付けられた関連付け ID を取得します。以前は 、ScrollBy、または AddScrollVelocityによってScrollTo返されます。

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

int CorrelationId();

public int CorrelationId { get; }

var int32 = scrollingScrollCompletedEventArgs.correlationId;

Public ReadOnly Property CorrelationId As Integer

プロパティ値

Int32

int

オフセットに関連付けられている関連付け ID が変更されます。

注釈

プログラムによるスクロールまたはズームの各変更は、特定の関連付け ID 番号に関連付けられます。 この数値は、、または を戻り値として使用してAddScrollVelocityZoomToScrollByScrollToZoomByビューの変更を要求するときに指定されます。AddZoomVelocity 関連付け ID は、ビューへの取り込み要求参加の開始時に発生する BringIntoView イベントでも提供されます。 これにより、関連付け ID の有効期間の始まりが示されます。

その後、 ScrollAnimationStarting と ScrollCompleted、 ZoomAnimationStarting 、 ZoomCompleted などの後続のイベントで、同じ番号が公開されます。 これにより、イベントをトリガーメソッドの呼び出しまたは要求と照合できます。

関連付け ID の有効期間は、常に完了イベント (ScrollCompleted または ZoomCompleted) で終了します。

関連付け ID の有効期間は重複する可能性があります。 たとえば、2 回のバックツーバック ScrollTo 呼び出しでは、有効期間が重複する 2 つの関連付け ID が生成されます。

古いビューがまだ進行中に新しいビューの変更が要求されると、古いビューは取り消されます。 この取り消しにより、古い CorrelationIdをScrollCompleted持つ または ZoomCompleted イベントがトリガーされます。