ShapeElement.GetCursor Method

Gets the pointer that appears when the mouse is over the shape.

Namespace:  Microsoft.VisualStudio.Modeling.Diagrams
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Diagrams.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.10.0.dll)

Syntax

'Declaration
Public Overridable Function GetCursor ( _
    currentCursor As Cursor, _
    diagramClientView As DiagramClientView, _
    mousePosition As PointD _
) As Cursor
public virtual Cursor GetCursor(
    Cursor currentCursor,
    DiagramClientView diagramClientView,
    PointD mousePosition
)
public:
virtual Cursor^ GetCursor(
    Cursor^ currentCursor, 
    DiagramClientView^ diagramClientView, 
    PointD mousePosition
)
abstract GetCursor : 
        currentCursor:Cursor * 
        diagramClientView:DiagramClientView * 
        mousePosition:PointD -> Cursor 
override GetCursor : 
        currentCursor:Cursor * 
        diagramClientView:DiagramClientView * 
        mousePosition:PointD -> Cursor 
public function GetCursor(
    currentCursor : Cursor, 
    diagramClientView : DiagramClientView, 
    mousePosition : PointD
) : Cursor

Parameters

Return Value

Type: System.Windows.Forms.Cursor
The pointer that appears when the mouse is over the shape.

Examples

public override global::System.Windows.Forms.Cursor GetCursor(global::System.Windows.Forms.Cursor currentCursor, DslDiagrams::DiagramClientView diagramClientView, DslDiagrams::PointD mousePosition)
{
if (this.MouseDownHitShape == null && currentCursor != global::System.Windows.Forms.Cursors.No)
{
DslDiagrams::DiagramHitTestInfo hitTestInfo = new DslDiagrams::DiagramHitTestInfo(diagramClientView);
this.Diagram.DoHitTest(mousePosition, hitTestInfo);
DslDiagrams::ShapeElement shape = hitTestInfo.HitDiagramItem.Shape;

DslDiagrams::ConnectionType connectionType = GetConnectionTypes(shape, null)[0];
string warningString = string.Empty;
if (!connectionType.CanCreateConnection(shape, null, ref warningString))
{
return global::System.Windows.Forms.Cursors.No;
}
}
return base.GetCursor(currentCursor, diagramClientView, mousePosition);
}

.NET Framework Security

See Also

Reference

ShapeElement Class

Microsoft.VisualStudio.Modeling.Diagrams Namespace