Class
FieldPayload

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

Definition

Namespace:Telerik.Windows.Controls.FieldList

Assembly:Telerik.Windows.Controls.PivotFieldList.dll

Syntax:

cs-api-definition
public sealed class FieldPayload : ViewModelBase, INotifyPropertyChanged, IDisposable

Inheritance: objectViewModelBaseFieldPayload

Implements: IDisposableINotifyPropertyChanged

Inherited Members ViewModelBase.InvokeOnUIThread(Action)ViewModelBase.Dispose()ViewModelBase.PropertyChanged

Constructors

FieldPayload(IField)

Initializes a new instance of the FieldPayload class.

Declaration

cs-api-definition
public FieldPayload(IField field)

Parameters

field

IField

Properties

AllowedEffects

Gets the allowed DragDropEffects.

Declaration

cs-api-definition
public DragDropEffects AllowedEffects { get; }

Property Value

DragDropEffects

DragAction

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

Declaration

cs-api-definition
public FieldDragAction DragAction { get; }

Property Value

FieldDragAction

DraggedField

Gets the IField this payload carries.

Declaration

cs-api-definition
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

cs-api-definition
public bool RemoveFromSource { get; set; }

Property Value

bool

Methods

OnDrop()

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

Declaration

cs-api-definition
public void OnDrop()

OnDropComplete()

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

Declaration

cs-api-definition
public void OnDropComplete()

SetDestination(FieldCollection)

Set the potential destination for the DraggedField.

Declaration

cs-api-definition
public void SetDestination(FieldCollection destinationCollection)

Parameters

destinationCollection

FieldCollection

The destination FieldCollection.

SetDestination(FieldCollection, int)

Set the potential destination for the DraggedField.

Declaration

cs-api-definition
public void SetDestination(FieldCollection destinationCollection, int index)

Parameters

destinationCollection

FieldCollection

The destination FieldCollection.

index

int

The destination index.