New to Telerik UI for WinForms? Start a free 30-day trial

FieldPayload

Class

A IField payload used in drag operations between the RadPivotFieldList areas.

Definition

Assembly:Telerik.WinControls.PivotGrid.dll

Syntax:

public sealed class FieldPayload : ViewModelBase, INotifyPropertyChanged, IDisposable

Inheritance: objectViewModelBaseFieldPayload

Initializes a new instance of the FieldPayload class.

public FieldPayload(IField field)

Parameters:fieldIField

Gets the allowed DragDropEffects.

public DragDropEffects AllowedEffects { get; }

Gets the an FieldDragAction that identifies the expected outcome if drop occurs with the current settings.

public FieldDragAction DragAction { get; }

Gets the IField this payload carries.

public IField DraggedField { get; }

Gets or sets a value that indicates if the DraggedField should be removed upon drag completion.

public bool RemoveFromSource { get; set; }

Call to notify the drag and drop did drop. Call this method once to apply the DragAction.

public void OnDrop()

Call to notify the drag and drop did drop complete. Call this method once to apply the DragAction.

public void OnDropComplete()

Set the potential destination for the DraggedField.

public void SetDestination(FieldCollection destinationCollection, int index)

Parameters:destinationCollectionFieldCollection

The destination FieldCollection.

indexint

The destination index.

Set the potential destination for the DraggedField.

public void SetDestination(FieldCollection destinationCollection)

Parameters:destinationCollectionFieldCollection

The destination FieldCollection.