IPlugin.IPlugin Interface Reference

Plugin interface status: DRAFT (Subject to change) revision: 9 More...

Inheritance diagram for IPlugin.IPlugin:

Public Member Functions
void	Register (string file, IPluginHost host)
	Register plugin More...
void	Unregister ()
	Plugin is being disabled. More...
ToolStripMenuItem	InitFrmNoteShareMenu ()
	Adds ToolStripItem to the right click submenu share on FrmNote. More...
void	ShareMenuClicked (System.Windows.Forms.RichTextBox rtbnote, string title)
	Executed if share menu clicked. More...
TabPage	InitShareSettingsTab ()
	Executed if settings tab loaded. More...
Button[]	InitNoteFormatBtns ()
	Create a button in the bottom in FrmNewNote. More...
ToolStripItem	InitFrmNewNoteMenu ()
	Adds ToolStripItem to the right click menu on FrmNewNote. More...
ToolStripItem	InitFrmNoteMenu ()
	Adds ToolStripItem to the right click menu on FrmNote. More...
ToolStripItem	InitTrayIconMenu ()
	Adds ToolStripItem to the right click menu of the trayicon. More...
Button[]	InitFrmManageNotesBtns ()
	Create button(s) in the top FrmManageNotes window. More...
string	NoteFormatBtnClicked (System.Windows.Forms.RichTextBox rtbnote, Button btn)
	A plugin format button is cliked. More...
string	MenuFrmNewNoteClicked (System.Windows.Forms.RichTextBox rtbnote, ToolStripItem menuitem)
	Menu item in right click menu FrmNewNote is clicked. More...
bool	SaveSettingsTab ()
	Executed if Ok on FrmSettings is pressed. More...
void	SavingNote (string content, string title)
	Executed if a note is saved More...
void	ShowingNote (string content, string title)
	Executed if a note is made visible. More...
void	HidingNote (string content, string title)
	Executed if a note is being hiden. More...
void	ProgramUpgraded ()
	Executed if NoteFly is first runned with a newer version. More...
string	ExportNotesDlgFilter ()
	Get a additional filters for the save all notes to file in the manage notes window. More...
bool	ExportNotesFile (string filtername)
	Export all notes to a signle file. More...
string	ImportNotesDlgFilter ()
	Add open dialog filters to the import notes window More...
bool	ImportNotesFile (string filtername, string file)
	Import notes backup/archive file. More...
string	ValidateSyntaxPart (string part, RichTextBox rtb, string rtf, int lastpos)
	Validate syntax part More...
void	InitLoadNote (string title, int width, int height, int locx, int locy)
	Initizilazting loading of a note. More...
TabPage	InitTabFrmSettings ()
	Add a tab on initizilazting form settings More...
string	ExportNoteContentDlgFilter ()
	Export the note content save file dialog filter More...
bool	ExportNoteContent (RichTextBox rtb)
	Export the note content via save note as file options with send to.menu. More...
void	ManageNotesSearch (string keyword)
	Start plugin actions on search in Manage notes window. More...

Properties
string	Filename [get]
	Gets the filename of this plugin. More...
IPluginHost	Host [get]
	Gets the interface to let a plugin talk to NoteFly. More...

Detailed Description

Member Function Documentation

bool IPlugin.IPlugin.ExportNoteContent

(

RichTextBox

rtb

)

Parameters

rtb	The richTextBox with note content

Returns

Implemented in IPlugin.PluginBase.

string IPlugin.IPlugin.ExportNoteContentDlgFilter

(

)

Implemented in IPlugin.PluginBase.

string IPlugin.IPlugin.ExportNotesDlgFilter

(

)

Returns

Implemented in IPlugin.PluginBase.

bool IPlugin.IPlugin.ExportNotesFile

(

string

filtername

)

Parameters

filtername

Returns

True if handled by plugin

Implemented in IPlugin.PluginBase.

void IPlugin.IPlugin.HidingNote	(	string	content,
		string	title
	)

Parameters

content	The note content.
title	The note title.

Implemented in IPlugin.PluginBase.

string IPlugin.IPlugin.ImportNotesDlgFilter

(

)

Returns

Implemented in IPlugin.PluginBase.

bool IPlugin.IPlugin.ImportNotesFile	(	string	filtername,
		string	file
	)

Parameters

filtername
file

Returns

Implemented in IPlugin.PluginBase.

Button [] IPlugin.IPlugin.InitFrmManageNotesBtns

(

)

Returns

Array with the button or buttons to create.

Implemented in IPlugin.PluginBase.

ToolStripItem IPlugin.IPlugin.InitFrmNewNoteMenu

(

)

Returns

A ToolStripItem for the contextmenu of FrmNewNote.

Implemented in IPlugin.PluginBase.

ToolStripItem IPlugin.IPlugin.InitFrmNoteMenu

(

)

Returns

A ToolStripItem to add to the contextmenu of FrmNote.

Implemented in IPlugin.PluginBase.

ToolStripMenuItem IPlugin.IPlugin.InitFrmNoteShareMenu

(

)

Returns

A ToolStripMenuItem

Implemented in IPlugin.PluginBase.

void IPlugin.IPlugin.InitLoadNote	(	string	title,
		int	width,
		int	height,
		int	locx,
		int	locy
	)

Parameters

title
width
height
locx
locy

Implemented in IPlugin.PluginBase.

Button [] IPlugin.IPlugin.InitNoteFormatBtns

(

)

Returns

The buttons created in FrmNewNote.

Implemented in IPlugin.PluginBase.

TabPage IPlugin.IPlugin.InitShareSettingsTab

(

)

Returns

A Tabpage with all components to draw.

Implemented in IPlugin.PluginBase.

TabPage IPlugin.IPlugin.InitTabFrmSettings

(

)

Returns

Implemented in IPlugin.PluginBase.

ToolStripItem IPlugin.IPlugin.InitTrayIconMenu

(

)

Returns

A ToolStripItem to the rightclick menu of the trayicon.

Implemented in IPlugin.PluginBase.

void IPlugin.IPlugin.ManageNotesSearch

(

string

keyword

)

Parameters

keyword

Implemented in IPlugin.PluginBase.

string IPlugin.IPlugin.MenuFrmNewNoteClicked	(	System.Windows.Forms.RichTextBox	rtbnote,
		ToolStripItem	menuitem
	)

Parameters

rtbnote	The RichTextbox.
menuitem	The button is clicked.

Returns

The new rtf note content

Implemented in IPlugin.PluginBase.

string IPlugin.IPlugin.NoteFormatBtnClicked	(	System.Windows.Forms.RichTextBox	rtbnote,
		Button	btn
	)

Parameters

rtbnote	The RichTextbox.
btn	The button is clicked.

Returns

The new rtf note content

Implemented in IPlugin.PluginBase.

void IPlugin.IPlugin.ProgramUpgraded

(

)

Implemented in IPlugin.PluginBase.

void IPlugin.IPlugin.Register	(	string	file,
		IPluginHost	host
	)

Parameters

file	The plugin file.
host	Interface to notefly core.

Implemented in IPlugin.PluginBase.

bool IPlugin.IPlugin.SaveSettingsTab

(

)

Returns

True if allowed to close FrmSettings.

Implemented in IPlugin.PluginBase.

void IPlugin.IPlugin.SavingNote	(	string	content,
		string	title
	)

Parameters

content	The note content.
title	The note title.

Implemented in IPlugin.PluginBase.

void IPlugin.IPlugin.ShareMenuClicked	(	System.Windows.Forms.RichTextBox	rtbnote,
		string	title
	)

Parameters

rtbnote	The richedit component with the note content in memory.
title	The note title

Implemented in IPlugin.PluginBase.

void IPlugin.IPlugin.ShowingNote	(	string	content,
		string	title
	)

Parameters

content	The note content.
title	The note title.

Implemented in IPlugin.PluginBase.

void IPlugin.IPlugin.Unregister

(

)

Implemented in IPlugin.PluginBase.

string IPlugin.IPlugin.ValidateSyntaxPart	(	string	part,
		RichTextBox	rtb,
		string	rtf,
		int	lastpos
	)

Parameters

part
rtb
rtf
lastpos

Implemented in IPlugin.PluginBase.

Property Documentation

string IPlugin.IPlugin.Filename

get

IPluginHost IPlugin.IPlugin.Host

get