clipPoint Method

Summary

Clips the specified point.

Syntax
TypeScript
JavaScript
AnnDesigner.prototype.clipPoint = function( 
   point, 
   clipRect 
) 
clipPoint( 
   point: LeadPointD, 
   clipRect: LeadRectD 
): LeadPointD; // protected 

Parameters

point

Point to clip.

clipRect

Clipping rectangle to use.

Return Value

point clipped to the boundaries of the rectangle.

Remarks

This method is only used when the value of RestrictDesigners is true. The framework supports restricting the object inside its container when it is being drawn or edited. When the mouse cursor or touch pointer is used to draw or edit an object, the designer will call ClipPoint to restrict the position of the cursor or touch pointer to a point inside the rectangle set in ClipRectangle.

By default, the value of ClipRectangle is set to the location and boundary of the Container. In such cases the designer restricts the user from drawing or moving (editing) an object or any of its points outside the container.

Override this behavior by implementing a custom clipping area in ClipRectangle or overriding the ClipPoint method.

Neither the ClipRectangle nor the ClipPoint are used when the value of RestrictDesigners is false.

Requirements

Target Platforms

Help Version 20.0.2019.3.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations.Designers Assembly