Documentation

Class FieldPayload

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

Inheritance
System.Object
ViewModelBase
FieldPayload
Inherited Members
Namespace: Telerik.Windows.Controls.FieldList
Assembly: Telerik.Windows.Controls.PivotFieldList.dll

Syntax

public sealed class FieldPayload : ViewModelBase, INotifyPropertyChanged, IDisposable

Constructors

FieldPayload(IField)

Initializes a new instance of the FieldPayload class.

Declaration
public FieldPayload(IField field)
Parameters
IField field

Properties

AllowedEffects

Gets the allowed System.Windows.DragDropEffects.

Declaration
public DragDropEffects AllowedEffects { get; }
Property Value
System.Windows.DragDropEffects

DragAction

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

Declaration
public FieldDragAction DragAction { get; }
Property Value
FieldDragAction

DraggedField

Gets the IField this payload carries.

Declaration
public IField DraggedField { get; }
Property Value
IField

RemoveFromSource

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

Declaration
public bool RemoveFromSource { get; set; }
Property Value
System.Boolean

Methods

OnDrop()

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

Declaration
public void OnDrop()

OnDropComplete()

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

Declaration
public void OnDropComplete()

SetDestination(FieldCollection)

Set the potential destination for the DraggedField.

Declaration
public void SetDestination(FieldCollection destinationCollection)
Parameters
FieldCollection destinationCollection

The destination FieldCollection.

SetDestination(FieldCollection, Int32)

Set the potential destination for the DraggedField.

Declaration
public void SetDestination(FieldCollection destinationCollection, int index)
Parameters
FieldCollection destinationCollection

The destination FieldCollection.
System.Int32 index

The destination index.

Extension Methods