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

Contains the hit-test information of a DragDropService.

Definition

Namespace:Telerik.WinControls.UI.Docking

Assembly:Telerik.WinControls.RadDock.dll

Syntax:

C#
public struct DockingGuideHitTest

Constructors

Initializes new instances of the DockingGuideHitTest class, using the provided parameters.

C#
public DockingGuideHitTest(DockPosition? dockPos, DockingGuidesPosition? guidePos, bool? dockAsDocument)
Parameters:dockPosDockPosition?

The docking direction under the pointer, or null when no direction is hit.

guidePosDockingGuidesPosition?

The guide position under the pointer, or null when no guide is hit.

dockAsDocumentbool?

Whether the hit position selects a document docking target; null means no document/tool distinction was hit.

Initializes new instances of the DockingGuideHitTest class, using the provided parameters.

C#
public DockingGuideHitTest(DockPosition? dockPos, DockingGuidesPosition? guidePos)
Parameters:dockPosDockPosition?

The docking direction under the pointer, or null when no direction is hit.

guidePosDockingGuidesPosition?

The guide position under the pointer, or null when no guide is hit.

Fields

Gets or sets whether the hit selects a document docking target; null is treated as false by the drag-drop service.

C#
public bool? DockAsDocument

A nullable member that defines the current DockPosition of the hit-test operation.

C#
public DockPosition? DockPosition

The default empty instance.

C#
public static readonly DockingGuideHitTest Empty

A nullable member that defines the current DockingGuidesPosition of the hit-test operation.

C#
public DockingGuidesPosition? GuidePosition

Methods

Determines whether the specified object is a hit-test value with the same docking direction, guide position, and document-target flag.

C#
public override bool Equals(object obj)
Parameters:objobject

The object to compare with this value.

Returns:

bool

true if obj is an equal DockingGuideHitTest; otherwise, false.

Overrides: ValueType.Equals(object)

Combines the hash codes of the docking direction, guide position, and document-target flag.

C#
public override int GetHashCode()
Returns:

int

The hash code for this hit-test value.

Overrides: ValueType.GetHashCode()

Determines whether this instance has no docking direction or guide position.

C#
public bool IsEmpty()
Returns:

bool

true when both DockPosition and GuidePosition are null.

The DockAsDocument flag does not affect this check.

Operators

Determines whether the specified two DockingGuideHitTest instances are not equal.

C#
public static bool operator !=(DockingGuideHitTest ht1, DockingGuideHitTest ht2)
Parameters:ht1DockingGuideHitTest

The first hit-test value to compare.

ht2DockingGuideHitTest

The second hit-test value to compare.

Returns:

bool

true when any hit-test value differs; otherwise, false.

Determines whether the specified two DockingGuideHitTest instances are equal.

C#
public static bool operator ==(DockingGuideHitTest ht1, DockingGuideHitTest ht2)
Parameters:ht1DockingGuideHitTest

The first hit-test value to compare.

ht2DockingGuideHitTest

The second hit-test value to compare.

Returns:

bool

true when all three hit-test values are equal; otherwise, false.