Class DropZone

A drop zone is a container that can be used to drop content into.

Inheritance
object
CallbackEventHandler
Focusable
VisualElement
DropZone
Implements
Inherited Members
VisualElement.disabledUssClassName
VisualElement.ExecuteDefaultAction(EventBase)
VisualElement.Focus()
VisualElement.SendEvent(EventBase)
VisualElement.SetEnabledFromHierarchy(bool)
VisualElement.Overlaps(Rect)
VisualElement.ToString()
VisualElement.GetFirstOfType<T>()
VisualElement.GetFirstAncestorOfType<T>()
VisualElement.canGrabFocus
VisualElement.focusController
VisualElement.cacheAsBitmap
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)
Namespace: Unity.AppUI.UI
Assembly: solution.dll
Syntax
public class DropZone : VisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle

Constructors

Name Description
DropZone()

Create a new DropZone.
DropZone(Action)

Create a new DropZone.

Fields

Name Description
backgroundUssClassName

The DropZone background styling class.
frameUssClassName

The DropZone frame styling class.
stateUssClassName

The DropZone state styling class.
ussClassName

The DropZone main styling class.
visibleIndicatorUssClassName

The DropZone visible indicator styling class.

Properties

Name Description
clickable

The Pressable used to handle click events.
contentContainer

The container used to display the content.
state

The state of the DropZone.
tryGetDroppableFromPath

Method invoked when a drag is started to find any droppable object(s) that can be dropped on the target using the current drag and drop path data.

See paths for more information.

tryGetDroppables

Method invoked when a drag is started to find any droppable object(s) that can be dropped on the target.
tryGetDroppablesFromUnityObjects

Method invoked when a drag is started to find any droppable object(s) that can be dropped on the target using the current drag and drop objects data.

See objectReferences for more information.

visibleIndicator

The visible indicator state of the DropZone.

Events

Name Description
dragEnded

Event fired when the user stops dragging droppable object(s).

Use this event to perform any cleanup after a drag and drop operation.

dragStarted

Event fired when the user starts dragging droppable object(s).

Use this event to perform validate the drag and drop operation via the state property.

dropped

Event fired when the user drops droppable object(s) on the target.

Extension Methods