In This Topic ▼

snapObjectToGrid Method

Summary

Snaps the specified AnnObject to the container grid based on AnnSnapToGridOptions.

Syntax

TypeScript

JavaScript

AnnEditDesigner.prototype.snapObjectToGrid = function( 
   targetObject, 
   clipToContainer 
)

snapObjectToGrid( 
   targetObject: AnnObject, 
   clipToContainer: boolean 
): void;

targetObject

An AnnObject to snap.

clipToContainer

A Boolean value to specify if we want to clip the point to container bounds after snap or no.

Remarks

This is a generic method which snaps all the points of the object without changing the object's shape.

Some objects need special handling to keep their shape when snapping. You can override this behavior by overriding this method.

Requirements

Help Version 22.0.2022.12.14

Leadtools.Annotations.Designers Assembly