logo

PluginBase class. More...

+ Inheritance diagram for IPlugin.PluginBase:

Public Member Functions

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

Properties

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

Private Attributes

string file
 The filename of this plugin. More...
 
IPluginHost host
 Access to NoteFly More...
 

Detailed Description

Member Function Documentation

virtual bool IPlugin.PluginBase.ExportNoteContent ( RichTextBox  rtb)
virtual
Parameters
rtbThe richTextBox with note content
Returns

Implements IPlugin.IPlugin.

virtual string IPlugin.PluginBase.ExportNoteContentDlgFilter ( )
virtual

Implements IPlugin.IPlugin.

virtual string IPlugin.PluginBase.ExportNotesDlgFilter ( )
virtual
Returns

Implements IPlugin.IPlugin.

virtual bool IPlugin.PluginBase.ExportNotesFile ( string  filtername)
virtual
Parameters
filtername
Returns
True if handled

Implements IPlugin.IPlugin.

virtual void IPlugin.PluginBase.HidingNote ( string  content,
string  title 
)
virtual
Parameters
contentThe note content.
titleThe note title.

Implements IPlugin.IPlugin.

virtual string IPlugin.PluginBase.ImportNotesDlgFilter ( )
virtual
Returns

Implements IPlugin.IPlugin.

virtual bool IPlugin.PluginBase.ImportNotesFile ( string  filtername,
string  file 
)
virtual
Parameters
filtername
file
Returns

Implements IPlugin.IPlugin.

virtual Button [] IPlugin.PluginBase.InitFrmManageNotesBtns ( )
virtual
Returns
Array with the button or buttons to create.

Implements IPlugin.IPlugin.

virtual ToolStripItem IPlugin.PluginBase.InitFrmNewNoteMenu ( )
virtual
Returns
A ToolStripItem to be add to the contextmenu on FrmNewNote.

Implements IPlugin.IPlugin.

virtual ToolStripItem IPlugin.PluginBase.InitFrmNoteMenu ( )
virtual
Returns
A ToolStripItem item to add to FrmNote contextmenustrip

Implements IPlugin.IPlugin.

virtual ToolStripMenuItem IPlugin.PluginBase.InitFrmNoteShareMenu ( )
virtual
Returns
The ToolStripMenuItem to add to the Share submenu

Implements IPlugin.IPlugin.

virtual string [] IPlugin.PluginBase.InitHighlightLanguage ( )
virtual
virtual void IPlugin.PluginBase.InitLoadNote ( string  title,
int  width,
int  height,
int  locx,
int  locy 
)
virtual

Implements IPlugin.IPlugin.

virtual Button [] IPlugin.PluginBase.InitNoteFormatBtns ( )
virtual
Returns
Array with buttons, return null by default

Implements IPlugin.IPlugin.

virtual TabPage IPlugin.PluginBase.InitShareSettingsTab ( )
virtual
Returns
A tabpage with all components to draw.

Implements IPlugin.IPlugin.

virtual TabPage IPlugin.PluginBase.InitTabFrmSettings ( )
virtual
Returns

Implements IPlugin.IPlugin.

virtual ToolStripItem IPlugin.PluginBase.InitTrayIconMenu ( )
virtual
Returns
A ToolStripItem to be add to the trayicon menu.

Implements IPlugin.IPlugin.

virtual void IPlugin.PluginBase.ManageNotesSearch ( string  keyword)
virtual
Parameters
keyword

Implements IPlugin.IPlugin.

virtual string IPlugin.PluginBase.MenuFrmNewNoteClicked ( System.Windows.Forms.RichTextBox  rtbnote,
ToolStripItem  menuitem 
)
virtual
Parameters
rtbnoteThe RichTextbox.
menuitemThe button is clicked.
Returns
The new rtf note content

Implements IPlugin.IPlugin.

virtual string IPlugin.PluginBase.NoteFormatBtnClicked ( System.Windows.Forms.RichTextBox  rtbnote,
Button  btn 
)
virtual
Parameters
rtbnoteThe richtextbox
btnThe button that is clicked
Returns
The rtf text of the note, stays the same.

Implements IPlugin.IPlugin.

virtual void IPlugin.PluginBase.ProgramUpgraded ( )
virtual

Implements IPlugin.IPlugin.

void IPlugin.PluginBase.Register ( string  file,
IPluginHost  host 
)
Parameters
fileThe plugin file.
hostReference to the IPluginHost interface.

Implements IPlugin.IPlugin.

virtual bool IPlugin.PluginBase.SaveSettingsTab ( )
virtual
Returns
true if allowed to close FrmSettings

Implements IPlugin.IPlugin.

virtual void IPlugin.PluginBase.SavingNote ( string  content,
string  title 
)
virtual
Parameters
contentA note object with details.
titleThe note title.

Implements IPlugin.IPlugin.

virtual void IPlugin.PluginBase.ShareMenuClicked ( System.Windows.Forms.RichTextBox  rtbnote,
string  title 
)
virtual
Parameters
rtbnoteThe richedit component with the note content in memory.
titleThe title of the note

Implements IPlugin.IPlugin.

virtual void IPlugin.PluginBase.ShowingNote ( string  content,
string  title 
)
virtual
Parameters
contentThe note content.
titleThe note title.

Implements IPlugin.IPlugin.

void IPlugin.PluginBase.Unregister ( )

Implements IPlugin.IPlugin.

virtual string IPlugin.PluginBase.ValidateSyntaxPart ( string  part,
RichTextBox  rtb,
string  rtf,
int  lastpos 
)
virtual
Parameters
part
rtb
rtf
lastpos
Returns

Implements IPlugin.IPlugin.

Member Data Documentation

string IPlugin.PluginBase.file
private
IPluginHost IPlugin.PluginBase.host
private

Property Documentation

string IPlugin.PluginBase.Filename
get
IPluginHost IPlugin.PluginBase.Host
get