Activates the given bufferID:
bufferID = notepad.getCurrentBufferID() ... notepad.activateBufferID(bufferID)
Activates the document with the given filename
Activates the document with the given view and index. view is 0 or 1.
Registers a callback function for a notification. notifications is a list of messages to call the function for.:
def my_callback(args): console.write("Buffer Activated %d\n" % args["bufferID"] notepad.callback(my_callback, [NOTIFICATION.BUFFERACTIVATED])
The NOTIFICATION enum corresponds to the NPPN_* plugin notifications. The function arguments is a map, and the contents vary dependant on the notification.
Note that the callback will live on past the life of the script, so you can use this to perform operations whenever a document is opened, saved, changed etc.
Also note that it is good practice to put the function in another module (file), and then import that module in the script that calls notepad.callback(). This way you can unregister the callback easily.
For Scintilla notifications, see editor.callback()
Unregisters all callbacks
Unregisters all callbacks for the given function. Note that this uses the actual function object, so if the function has been redefined since it was registered, this will fail. If this has happened, use one of the other clearCallbacks() functions.
Unregisters all callbacks for the given list of events.:
Unregisters the callback for the given callback function for the list of events.
Closes the currently active document
Closes all open documents
Closes all but the currently active document
Create a new Scintilla handle. Returns an Editor object
Destroy a Scintilla handle created with createScintilla
Gets the command line used to start Notepad++
Gets the bufferID of the currently active buffer
Gets the current active index for the given view (0 or 1)
Gets the filename of the active document
Get the current language type
Get the currently active view (0 or 1)
Gets the encoding of the given bufferID. If no bufferID is given, then the encoding of the currently active buffer is returned.
Gets a list of the open filenames.
Gets the format type (i.e. Windows, Unix or Mac) of the given bufferID. If no bufferID is given, then the format of the currently active buffer is returned.
Gets the language type of the given bufferID. If no bufferID is given, then the language of the currently active buffer is returned.
Gets the directory Notepad++ is running in (i.e. the location of notepad++.exe)
Gets the plugin config directory.
Gets the handle for the Plugins menu.
Gets the Notepad++ version as a tuple - e.g. 5.6.8 becomes (5,6,8)
Gets the PythonScript plugin version as a string. There is always four parts to it. e.g. ‘0.9.2.0’
Hides the Tab bar
Runs a Notepad++ menu command. Use the MENUCOMMAND enum, or integers directly from the nativeLang.xml file.
Displays a message box with the given message and title.
Flags can be 0 for a standard ‘OK’ message box, or a combination of MESSAGEBOXFLAGS. title is “Python Script for Notepad++” by default, and flags is 0 by default.
Create a new document.
Opens the given file.
Prompts the user for some text. Optionally provide the default text to initialise the entry field.
The string entered.
None if cancel was pressed (note that is different to an empty string, which means that no input was given)
Reloads the given bufferID
Reloads the current document
Reloads a filename.
Runs a command from the menus. For built-in menus use notepad.menuCommand(), for non built-in menus (e.g. TextFX and macros you’ve defined), use notepad.runMenuCommand(menuName, menuOption). For other plugin commands (in the plugin menu), use Notepad.runPluginCommand(pluginName, menuOption)_
Menus are searched for the text, and when found, the internal ID of the menu command is cached. When runMenuCommand is called, the cache is first checked if it holds the internal ID for the given menuName and menuOption. If it does, it simply uses the value from the cache. If the ID could have been updated (for example, you’re calling the name of macro that has been removed and added again), set refreshCache to True. This is False by default.
notepad.runMenuCommand('TextFX Edit', 'Delete Blank Lines')
Runs a command from the plugin menu. Use to run direct commands from the Plugins menu. To call TextFX or other menu functions, either use notepad.menuCommand(menuCommand)_ (for Notepad++ menu commands), or notepad.runMenuCommand(menuName, menuOption)_ for TextFX or non standard menus (such as macro names).
Note that menuOption can be a submenu in a plugin’s menu. So:
notepad.runPluginCommand('Python Script', 'demo script')
Could run a script called “demo script” from the Scripts submenu of Python Script.
Menus are searched for the text, and when found, the internal ID of the menu command is cached. When runPluginCommand is called, the cache is first checked if it holds the internal ID for the given menuName and menuOption. If it does, it simply uses the value from the cache. If the ID could have been updated (for example, you’re calling the name of macro that has been removed and added again), set refreshCache to True. This is False by default.
Save the current file
Saves all currently unsaved files
Save the current file as the specified filename
Only works in Notepad++ 5.7 onwards
Save the current file as the specified filename, but don’t change the filename for the buffer in Notepad++
Only works in Notepad++ 5.7 onwards
Save the current session (list of open files) to a file.
Saves a session file with the list of filenames.
Set the language type of the currently active buffer (see LANGTYPE)
Sets the format type (i.e. Windows, Unix or Mac) of the specified buffer ID. If not bufferID is passed, then the format type of the currently active buffer is set.
Sets the language type of the given bufferID. If not bufferID is given, sets the language for the currently active buffer.
Sets the status bar text. For statusBarSection, use one of the STATUSBARSECTION constants.
Shows the Tab bar