Skip to main content

MoveCursorToPos

Moves a cursor to the specified position within the current range.

Syntax​

expression.MoveCursorToPos(pos);

expression - A variable that represents an ApiTextRange class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
posOptionalnumber0The desired cursor position.

Returns​

boolean

Example​

Move the cursor inside the text covered by a range in a shape on a worksheet.

// Places the cursor precisely before further editing.

// Move the cursor between the two words.

let worksheet = Api.GetActiveSheet();
let fill = Api.CreateSolidFill(Api.RGB(255, 111, 61));
let stroke = Api.CreateStroke(0, Api.CreateNoFill());
let shape = worksheet.AddShape("rect", 200 * 36000, 80 * 36000, fill, stroke, 3, 0, 1, 0);

let docContent = shape.GetContent();
let paragraph = docContent.GetElement(0);
paragraph.AddText("Hello World");

let range = shape.GetTextRange();

range.MoveCursorToPos(6);