Table of Contents

Class PluginDialogBase

Namespace
Npp.DotNet.Plugin.Winforms
Assembly
Npp.DotNet.Plugin.dll

Extends NotepadPPGateway with methods to simplify working with forms.

public class PluginDialogBase : NotepadPPGateway, INotepadPPGateway
Inheritance
PluginDialogBase
Implements
Inherited Members

Methods

AddModelessDialog(IntPtr)

Register a modeless form (i.e., a form that doesn't block the parent application until closed)
with Notepad++ using NPPM_MODELESSDIALOG
If you don't do this, Notepad++ may intercept some keystrokes in uIntPtrended ways.

public void AddModelessDialog(IntPtr formHandle)

Parameters

formHandle IntPtr

the Handle attribute of a Windows form

AllocateIndicators(uint, out int[])

Introduced in Notepad++ 8.5.6.
NPPM_ALLOCATEINDICATOR: allocate one or more unused indicator IDs, which can then be assigned styles and used to style regions of text.
returns false and sets indicators to null if numberOfIndicators is less than 1, or if the requested number of indicators could not be allocated.
Otherwise, returns true, and sets indicators to an array of numberOfIndicators indicator IDs.
See https://www.scintilla.org/ScintillaDoc.html#Indicators for more info on the indicator API.

public bool AllocateIndicators(uint numberOfIndicators, out int[] indicators)

Parameters

numberOfIndicators uint

number of consecutive indicator IDs to allocate

indicators int[]

Returns

bool

GetDefaultBackgroundColor() 

public Color GetDefaultBackgroundColor()

Returns

Color

GetDefaultForegroundColor() 

public Color GetDefaultForegroundColor()

Returns

Color

HideDockingForm(Form) 

public void HideDockingForm(Form form)

Parameters

form Form

RemoveModelessDialog(IntPtr)

unregister a modelesss form that was registered with AddModelessDialog.
This MUST be called in the Dispose method of the form, BEFORE the components of the form are disposed.

public void RemoveModelessDialog(IntPtr formHandle)

Parameters

formHandle IntPtr

the Handle attribute of a Windows form

ShowDockingForm(Form) 

public void ShowDockingForm(Form form)

Parameters

form Form