Plugin settings in the Config application

[Khurram]

I am trying to develop a plugin. Can someone please help me out in the following:


1) how do you get the window (what event to hadle) after clicking on the settings buttons in the Config application Plugin tab?

2) Can you display a .net windows form after clicking on the settings button?


Thanks,
Khurram.

[whurlston]

Add a regular form to the plugin. Here are the basic parts needed (C#).

Code:

public partial class ConfigForm : Form
    {
        private XmlDocument settings;
        
        // Constructor. Add an XML document as a parameter.
        public ConfigForm(XmlDocument document)
        {
            InitializeComponent();
            settings = document;
        }

        public XmlDocument ConfigDocument
        {
            get { return this.settings; }
            set { this.settings = value; }
        }
    }

Also check the wiki. There are some plugin source codes available that should have config form instances.

[bgowland]

Although it's not yet implemented, I took the easy route using Visual Studio for a config form in the DVB-T Radio plugin...

Right-click the solution / project and select Add... to add a Windows Form. In the plugin, use the overridden GetConfigFormInstance as follows...

Code:

public override Form GetConfigFormInstance(XmlDocument document)
{
        DvbtrConfigForm ConfigForm = new DvbtrConfigForm();
        return ConfigForm;
}

The Settings button in the Config app. is automatically enabled for any plugin which returns an object derived from a Form class.

The XmlDocument that's passed as a parameter to GetConfigFormInstance is the GB-PVR config.xml file - you can use this if you want to add settings for your plugin to the <PluginSettings> area or you can choose to ignore it and use your own private xml or plain text ini file etc. for your settings.

Hope that helps.

Cheers,
Brian

[whurlston]

I forgot that override had to be in the plugin code. Sorry.

[bgowland]

I forgot that override had to be in the plugin code. Sorry.

Actually, I didn't do a full job of explaining it either.

@Khurram - If you want your form to use the default config.xml with whurlston's example constructor, then my example for the GetConfigFormInstance should have been...

Code:

public override Form GetConfigFormInstance(XmlDocument document)
{
        DvbtrConfigForm ConfigForm = new DvbtrConfigForm([B][color=Red]document[/color][/B]);
        return ConfigForm;
}

@whurlston - I think we got there in the end.

Cheers,
Brian

[whurlston]

See what brilliant minds can accomplish when they come together?

[Khurram]

Thanks for the information guys.

Khurram.