Table of Contents

Namespace Npp.DotNet.Plugin

Most of the types defined here were extracted from https://github.com/kbilsted/NotepadPlusPlusPluginPack.Net.

Classes

ClikeStringArray
NotepadPPGateway

Helpers for sending messages defined in NppMsg.

PluginData

A container of static, globally visible data.

PluginFuncArray

Encapsulates a plugin's functions as a managed collection of FuncItem items.

ScintillaGateway

Primary interface to Notepad++/Scintilla.

See https://www.scintilla.org/ScintillaDoc.html for further details.

TextRange
TextRangeFull
TextToFind
TextToFindFull
Utils
Win32

Structs

Cells

Each byte in a Scintilla document is associated with a byte of styling information. The combination of a character byte and a style byte is called a cell.

CharacterRange
CharacterRangeFull
Colour
CommunicationInfo
FuncItem
KeyModifier

Class containing key and modifiers.

NppData
Position
ScNotification
ScNotificationHeader

Compatible with Windows' Win32.TagNMHDR.

SessionInfo
ShortcutKey
ToolbarIcon
ToolbarIconDarkMode
Win32.MenuItemInfo

Contains information about a menu item.

Win32.ScrollInfo

Contains the scroll information of a scroll bar, or a window with a scroll bar.

Win32.TagNMHDR

Holds message data sent with WM_NOTIFY.

Interfaces

IDotNetPlugin

Provides managed wrappers around the core Notepad++ plugin APIs. Plugins can implement external lexers by extending this interface.

INotepadPPGateway
IScintillaGateway

Primary interface to Notepad++/Scintilla.

See https://www.scintilla.org/ScintillaDoc.html for further details.

Enums

Accessibility

Possible options for SetAccessibility(Accessibility). (Scintilla feature SC_ACCESSIBILITY_)

Alpha

Possible options for SetSelAlpha(Alpha). (Scintilla feature SC_ALPHA_)

AnnotationVisible

Possible options for AnnotationSetVisible(AnnotationVisible). (Scintilla feature ANNOTATION_)

AutomaticFold

Get automatic folding behaviours. (Scintilla feature SC_AUTOMATICFOLD_)

CaretPolicy

Possible options for SetXCaretPolicy(CaretPolicy, int) and SetYCaretPolicy(CaretPolicy, int). (Scintilla feature CARET_)

CaretSticky

Possible options for SetCaretSticky(CaretSticky). (Scintilla feature SC_CARETSTICKY_)

CaretStyle

Possible options for SetCaretStyle(CaretStyle). (Scintilla feature CARETSTYLE_)

CaseInsensitiveBehaviour

Possible options for AutoCSetCaseInsensitiveBehaviour(CaseInsensitiveBehaviour). (Scintilla feature SC_CASEINSENSITIVEBEHAVIOUR_)

CaseVisible

Possible options for StyleSetCase(int, CaseVisible). (Scintilla feature SC_CASE_)

ChangeHistoryIndicators

Range of indicators reserved for change history.

CharacterSet

Character set identifiers are used in StyleSetCharacterSet(int, CharacterSet). The values are the same as the Windows *CHARSET values. (Scintilla feature SC_CHARSET_)

CharacterSource

The value passed in CharacterSource when SCN_CHARADDED is emitted.

CompletionMethods

The value passed in ListCompletionMethod indicating the way in which the completion occurred.

CursorShape

Possible options for SetCursor(CursorShape). (Scintilla feature SC_CURSOR)

DocumentOption

Possible options for CreateDocument(int, DocumentOption). (Scintilla feature SC_DOCUMENTOPTION_)

EdgeVisualStyle

Possible options for SetEdgeMode(EdgeVisualStyle). (Scintilla feature EDGE_)

EndOfLine

Return value of GetEOLMode(). (Scintilla feature SC_EOL_)

ExternalLexerAutoIndentMode

Used with NPPM_GETEXTERNALLEXERAUTOINDENTMODE and NPPM_SETEXTERNALLEXERAUTOINDENTMODE.

FindOption

Possible options for FindText(FindOption, TextToFindFull). (Scintilla feature SCFIND_)

FoldAction

Expand or contract a fold header. (Scintilla feature SC_FOLDACTION_)

FoldDisplayTextStyle

Possible options for FoldDisplayTextSetStyle(FoldDisplayTextStyle). (Scintilla feature SC_FOLDDISPLAYTEXT_)

FoldFlag

Set some style options for folding. (Scintilla feature SC_FOLDFLAG_)

FoldLevel

Possible options for SetFoldLevel(Position, FoldLevel). (Scintilla feature SC_FOLDLEVEL)

FontQuality

Control font anti-aliasing. (Scintilla feature SC_EFF_)

FontWeight

Get the size of characters of a style in points multiplied by 100 (Scintilla feature SC_WEIGHT_)

IMEInteraction

Choose to display the the IME in a window or inline. (Scintilla feature SC_IME_)

IdleStyling

Possible options for SetIdleStyling(IdleStyling). (Scintilla feature SC_IDLESTYLING_)

IndentView

NONE turns the feature off but the other 3 states determine how far the guides appear on empty lines. (Scintilla feature SC_IV_)

IndicFlag

Possible options for IndicSetFlags(int, IndicFlag). (Scintilla feature SC_INDICFLAG_)

IndicValue

Retrieve the foreground hover colour of an indicator. (Scintilla feature SC_INDICVALUE)

IndicatorNumbers

Indicator numbers. (Scintilla feature INDICATOR_)

IndicatorStyle

Indicator style enumeration and some constants (Scintilla feature INDIC_)

KeyMod

Symbolic key codes and modifier flags. ASCII and other printable characters below 256. Extended keys above 300. (Scintilla feature SCMOD_)

LangType
Lexer
LineCache

Possible options for SetLayoutCache(LineCache). (Scintilla feature SC_CACHE_)

LineCharacterIndexType

Return value of GetLineCharacterIndex(). (Scintilla feature SC_LINECHARACTERINDEX_)

LineEndType

Line end types which may be used in addition to LF, CR, and CRLF. (Scintilla feature SC_LINE_END_TYPE_)

MacroStatus

Return value of NPPM_GETCURRENTMACROSTATUS.

MarginOption

Possible options for SetMarginOptions(MarginOption). (Scintilla feature SC_MARGINOPTION_)

MarginType

Set a margin to be either numeric or symbolic. (Scintilla feature SC_MARGIN_)

MarkerOutline

Markers used for outlining and change history columns. (Scintilla feature SC_MARKNUM_)

MarkerSymbol

Symbols used for a particular marker number. (Scintilla feature SC_MARK_)

MenuCmdId
ModificationFlags

The ModificationType field of a ScNotification. These are defined as a bit mask to make it easy to specify which notifications are wanted. One bit is set from each of SC_MOD_* and SC_PERFORMED_*. (Scintilla feature SC_MOD_)

MultiAutoComplete

Possible options for AutoCSetMulti(MultiAutoComplete). (Scintilla feature SC_MULTIAUTOC_)

MultiPaste

Possible options for SetMultiPaste(MultiPaste). (Scintilla feature SC_MULTIPASTE_)

NativeBool
NppMsg
Ordering

Possible options for AutoCSetOrder(Ordering). (Scintilla feature SC_ORDER_)

PhasesDraw

Possible options for SetPhasesDraw(PhasesDraw). (Scintilla feature SC_PHASES_)

PopUp

Possible options for UsePopUp(PopUp). (Scintilla feature SC_POPUP_)

Preference
PrintOption

Print colour mode. (Scintilla feature SC_PRINT_)

Resource
ScKeyCode

A visible or control character. The lower 16-bits are used to form a key definition.

SciMsg

Definitions for Scintilla 5.5.6

SelectionMode

Possible options for SetSelectionMode(SelectionMode). (Scintilla feature SC_SEL_)

Status

Return value of GetStatus(). (Scintilla feature SC_STATUS_)

StatusBarSection

Enumerates the allowed values of the whichPart parameter of NPPM_SETSTATUSBAR

StylesCommon

Styles in range 32..39 are predefined for parts of the UI and are not used as normal styles. (Scintilla feature STYLE_)

TabDrawMode

Possible options for SetTabDrawMode(TabDrawMode). (Scintilla feature SCTD_)

Technology

Possible options for SetTechnology(Technology). (Scintilla feature SC_TECHNOLOGY_)

TypeProperty

Return value of PropertyType(string). (Scintilla feature SC_TYPE_)

UndoFlags

Possible options for AddUndoAction(int, UndoFlags). (Scintilla feature UNDO_)

Update

Type of modification and the action which caused the modification. These are defined as a bit mask to make it easy to specify which notifications are wanted. One bit is set from each of SC_MOD_* and SC_PERFORMED_*. (Scintilla feature SC_UPDATE_)

VirtualSpace

Possible options for SetVirtualSpaceOptions(VirtualSpace). (Scintilla feature SCVS_)

VisiblePolicy

Possible options for SetVisiblePolicy(VisiblePolicy, int). (Scintilla feature VISIBLE_)

WhiteSpace

Make white space characters invisible, always visible or visible outside indentation. (Scintilla feature SCWS_)

Win32.DlgResult

Possible return values of MsgBoxDialog(IntPtr, string, string, uint).

Win32.MsgBox

Possible values of the uType parameter of MsgBoxDialog(IntPtr, string, string, uint).

Win32.ScrollInfoBar

Possible values of the nBar parameter when calling GetScrollInfo(IntPtr, int, ref ScrollInfo).

Win32.ScrollInfoMask

Possible values of fMask.

WinVer
Wrap

Possible options for SetWrapMode(Wrap). (Scintilla feature SC_WRAP_)

WrapIndentMode

Possible options for SetWrapIndentMode(WrapIndentMode). (Scintilla feature SC_WRAPINDENT_)

WrapVisualFlag

Possible options for SetWrapVisualFlags(WrapVisualFlag). (Scintilla feature SC_WRAPVISUALFLAG_)

WrapVisualLocation

Possible options for SetWrapVisualFlagsLocation(WrapVisualLocation). (Scintilla feature SC_WRAPVISUALFLAGLOC_)

Delegates

PluginFunc

The general type of a function defined by the plugin and callable by the host application. Delegates of this type are associated with a menu item by assigning them to the PFunc member of a FuncItem structure.

Win32.WindowLongGetter
Win32.WindowLongSetter