File

projects/wms-framework/src/lib/models/events/ItemDragEventArgs.ts

Description

Information describing a drag event on a UIElement.

Index

Properties

Constructor

constructor(AllowedEffects?: DragDropEffects, Cancel?: boolean, Data?: unknown, DataRemovedFromDragSource?: boolean, DragDecoratorContent?: unknown, DragDecoratorContentMouseOffset?: PointModel, DragSource?: DependencyObject, Effects?: DragDropEffects, Handled?: boolean, KeyStates?: unknown)

Creates an instance of ItemDragEventArgs.

Parameters :
Name Type Optional Description
AllowedEffects DragDropEffects Yes

Gets or sets the allowed effects.

Cancel boolean Yes

Gets or sets a value indicating whether to cancel the action.

Data unknown Yes

Gets or sets the data associated with the item container being dragged.

DataRemovedFromDragSource boolean Yes

Gets a value indicating whether removing data from the source is handled by the target.

DragDecoratorContent unknown Yes

Gets or sets the content to insert into the DragDecorator.

DragDecoratorContentMouseOffset PointModel Yes

Gets or sets the mouse offset from the item being dragged at the beginning of the drag operation.

DragSource DependencyObject Yes

Gets or sets the control that is the source of the drag.

Effects DragDropEffects Yes

Gets or sets the effects of the completed drag operation.

Handled boolean Yes

Gets or sets a value indicating whether an item drag operation was handled.

KeyStates unknown Yes

Gets the key states.

Properties

Public Optional AllowedEffects
Type : DragDropEffects
Gets or sets the allowed effects.
Public Optional Cancel
Type : boolean
Gets or sets a value indicating whether to cancel the action.
Public Optional Data
Type : unknown
Gets or sets the data associated with the item container being dragged.
Public Optional DataRemovedFromDragSource
Type : boolean
Gets a value indicating whether removing data from the source is handled by the target.
Public Optional DragDecoratorContent
Type : unknown
Gets or sets the content to insert into the DragDecorator.
Public Optional DragDecoratorContentMouseOffset
Type : PointModel
Gets or sets the mouse offset from the item being dragged at the beginning of the drag operation.
Public Optional DragSource
Type : DependencyObject
Gets or sets the control that is the source of the drag.
Public Optional Effects
Type : DragDropEffects
Gets or sets the effects of the completed drag operation.
Public Optional Handled
Type : boolean
Gets or sets a value indicating whether an item drag operation was handled.
Public Optional KeyStates
Type : unknown
Gets the key states.
import { DragDropEffects } from '../enums/DragDropEffects';
import { PointModel } from '../controls/PointModel';
import { DependencyObject } from '../../basecomponentmodel/DependencyObject';

/**
 *  Information describing a drag event on a UIElement.
 *
 * @export
 * @class ItemDragEventArgs
 * @wType System.Windows.Controls.ItemDragEventArgs
 */
export class ItemDragEventArgs {
  /**
   * Creates an instance of ItemDragEventArgs.
   *
   * @param {DragDropEffects} AllowedEffects Gets or sets the allowed effects.
   * @param {boolean} Cancel Gets or sets a value indicating whether to cancel the action.
   * @param {unknown} Data Gets or sets the data associated with the item container being dragged.
   * @param {boolean} DataRemovedFromDragSource Gets a value indicating whether removing data from the source is handled by the target.
   * @param {unknown} DragDecoratorContent Gets or sets the content to insert into the DragDecorator.
   * @param {DependencyObject} DragSource Gets or sets the control that is the source of the drag.
   * @param {PointModel} DragDecoratorContentMouseOffset Gets or sets the mouse offset from the item being dragged at the beginning of the drag operation.
   * @param {DragDropEffects} Effects Gets or sets the effects of the completed drag operation.
   * @param {boolean} Handled Gets or sets a value indicating whether an item drag operation was handled.
   * @param {unknown} KeyStates Gets the key states.
   * @memberof ItemDragEventArgs
   */
  constructor(
    public AllowedEffects?: DragDropEffects,
    public Cancel?: boolean,
    public Data?: unknown,
    public DataRemovedFromDragSource?: boolean,
    public DragDecoratorContent?: unknown,
    public DragDecoratorContentMouseOffset?: PointModel,
    public DragSource?: DependencyObject,
    public Effects?: DragDropEffects,
    public Handled?: boolean,
    public KeyStates?: unknown
  ) {}
}

result-matching ""

    No results matching ""