Uniconta | Develop a user plugin

Introduction

User Plugins allow easy modification, customization and enhancement of Uniconta. It lets you easily add new functionalities without changing the core application code.

Plugin Interface

Plugin Interface is a part of Uniconta’s Windows API. It can be found under Uniconta.WindowsAPI > API > IPluginBase.cs

Create a new plugin by implementing this interface.

    //Summary
    //Interface IpluginBase to be implemented for creating plugin dll
    //Summary
    public interface IPluginBase
    {
        //summary
        // The Name method to get the name
        //summary
        string Name { get; }

        //summary
        // The GetDescription method to get the error description
        //summary
        //Returns string
        string GetErrorDescription();

        ////summary
        //// The Execute method to execute on the basis of parameter passed
        ////summary
        ////Params UnicontaBaseEntity master :- To pass the master table
        ////Params UnicontaBaseEntity currentRow :- To pass the current row
        ////Params IEnumerable source :- To pass List of UnicontaBaseEntity
        ////Params String Command :- pass the command
        ////Params String args :- pass the argument
        ////Returns ErrorCodes
        ErrorCodes Execute(UnicontaBaseEntity master, UnicontaBaseEntity currentRow, IEnumerable source, string command, string args);

        //summary
        // The SetMaster method for setting the master for the entity
        //summary
        //Params List<UnicontaBaseEntity> masters :- pass the master
        void SetMaster(List<UnicontaBaseEntity> masters);

        //summary
        // The SetAPI method to set the api for query database
        //summary
        //Params BaseAPI api :- pass the api
        void SetAPI(BaseAPI api);

        //summary
        // The OnExecute Event to perform some event
        //summary
        //returns event
        event EventHandler OnExecute;

        //summary
        // The Initialize Event to initialize values
        //summary
        void Intialize();
    }

//Summary

//Interface IpluginBase to be implemented for creating plugin dll

//Summary

public interface IPluginBase

{

//summary

// The Name method to get the name

//summary

string Name { get; }

//summary

// The GetDescription method to get the error description

//summary

//Returns string

string GetErrorDescription();

////summary

//// The Execute method to execute on the basis of parameter passed

////summary

////Params UnicontaBaseEntity master :- To pass the master table

////Params UnicontaBaseEntity currentRow :- To pass the current row

////Params IEnumerable source :- To pass List of UnicontaBaseEntity

////Params String Command :- pass the command

////Params String args :- pass the argument

////Returns ErrorCodes

ErrorCodes Execute(UnicontaBaseEntity master, UnicontaBaseEntity currentRow, IEnumerable source, string command, string args);

//summary

// The SetMaster method for setting the master for the entity

//summary

//Params List<UnicontaBaseEntity> masters :- pass the master

void SetMaster(List<UnicontaBaseEntity> masters);

//summary

// The SetAPI method to set the api for query database

//summary

//Params BaseAPI api :- pass the api

void SetAPI(BaseAPI api);

//summary

// The OnExecute Event to perform some event

//summary

//returns event

event EventHandler OnExecute;

//summary

// The Initialize Event to initialize values

//summary

void Intialize();

}

Sample Plugin

You can download our sample plugin for Uniconta from here

Creating a Plugin

Plugin Name / Prompt

Define a appropriate name for your plugin that will suit on what exactly your plugin will do.

Control

Specify the Control Name (Page Name) that your plugin will be displayed on.

Class

You can make your own class to extend the functionality of your plugin

Command & Argument

You can specify two parameters (Command and it’s argument) that will be executed when your plugin is running.

Saving your Plugin

Building your plugin project will generate a dll. It can be added on a default Uniconta Plugin directory C:\Uniconta\PluginPath or on any custom path defined by user. To change the plugin path in registry, please follow the instructions from here

Event Handling

Please go to this page to find a detailed description on how to handle an event.