Notepad++ JavaScript API Documentation

Index

Cursor functions

Functions

Cursor functions

void lineUp ( count : int, extend : boolean )

Move the cursor 'count' lines up.

Parameters

count: The number of lines to move up.
extend: Boolean if the selection must be extended.

void lineDown ( count : int, extend : boolean )

Parameters

count
extend

void charLeft ( count : int, extend : boolean )

Parameters

count
extend

void charRight ( count : int, extend : boolean )

Parameters

count
extend

void wordLeft ( count : int, extend : boolean )

Parameters

count
extend

void wordRight ( count : int, extend : boolean )

Parameters

count
extend

void home ( count : int, extend : boolean )

Parameters

count
extend

void lineStart ( count : int, extend : boolean )

Parameters

count
extend

void lineEnd ( count : int, extend : boolean )

Parameters

count
extend

void pageUp ( count : int, extend : boolean )

Parameters

count
extend

void pageDown ( count : int, extend : boolean )

Parameters

count
extend

void paraUp ( count : int, extend : boolean )

Parameters

count
extend

void paraDown ( count : int, extend : boolean )

Parameters

count
extend

void documentStart ( count : int, extend : boolean )

Parameters

count
extend

void documentEnd ( count : int, extend : boolean )

Parameters

count
extend

void lineScrollUp ( count : int )

Parameters

count

void lineScrollDown ( count : int )

Parameters

count

int getLineNumber ( )

Return value

The current line number of the cursor.

int getColumnNumber ( )

Return value

The current column number of the cursor.

Clipboard functions

void cut ( )

void copy ( )

void paste ( )

void lineCut ( )

void lineCopy ( )

void copyAllowLine ( )

boolean canCut ( )

boolean canCopy ( )

boolean canPaste ( )

Is there something on the clipboard to paste?

Return value

Is there something on the clipboard to paste?

void deleteChar ( )

void backspaceChar ( )

Delete text functions

void deleteWordLeft ( )

void deleteWordRight ( )

void deleteWordRightEnd ( )

void deleteLine ( )

void deleteLineLeft ( )

void deleteLineRight ( )

void deleteLine ( )

Undo functions

void undo ( )

void redo ( )

void canUndo ( )

void canRedo ( )

void emptyUndoBuffer ( )

void beginUndoAction ( )

void endUndoAction ( )

Various functions

void lineTranspose ( )

void lineDuplicate ( )

void selectionDuplicate ( )

void insertText ( text : string )

Insert a text at the current cursor location. If there is any text selected, this old text is replaced.

Parameters

text: The text to insert.

void alert ( text : string )

Show a simple message box with the text.

Parameters

text: The text to show in the message box.

void console ( text : string )

Show a text on the JavaScript console.

Parameters

text: The text to show on the JavaScript console.

Comment

When the JavaScript console is not initialized this function does nothing. Once it is initialized but not visible it does put text on the JavaScript console.