endDesigner Method (AnnAutomation)

Summary

Ends (and commits) the operation currently being performed in this AnnAutomation.

Syntax

JavaScript Syntax

AnnAutomation.prototype.endDesigner = function()

TypeScript Syntax

endDesigner(): void;

Remarks

Ends (and commits) any operation currently being performed in this AnnAutomation. An operation can be:

(Design user mode) An AnnDrawDesigner drawing a new object.
(Design user mode) An AnnEditDesigner editing an existing object.
(Design user mode) The user selecting a group of objects.
(Run user mode) An AnnRunDesigner running an object.

EndDesigner works like Cancel, except that the current designer is ended. If it is a multi-draw designer such as Polyline, the object is added. If it is an edit designer, editing is stopped (for example, if it is a text designer, the text editor goes away).

To abort the current operation without committing, use Cancel.

Use the following code snippet to determine the type of operation currently being performed by this automation:

// Get the current designer 
var designer = annAutomation.currentDesigner; 
if(lt.Annotations.Automation.AnnDrawDesigner.isInstanceOfType(designer)) 
{ 
// Drawing. You can cast further to get the specific draw designer or check the object ID using designer.TargetObject.Id 
// You can also use designer.hasStarted to check whether the designer has started working (is actually drawing an object) 
} 
else if(lt.Annotations.Automation.AnnEditDesigener.isInstanceOfType(designer)) 
{ 
// Edit. You can cast further to get the specific draw designer or check the object ID using designer.TargetObject.Id 
// You can also use designer.hasStarted to check whether the designer has started working (is actually editing an object) 
} 
else if(lt.Annotations.Automation.AnnRunDesigener.isInstanceOfType(designer)) 
{ 
// Run. You can cast further to get the specific draw designer or check the object ID using designer.TargetObject.Id 
} 
else 
{ 
// No operation 
}