GetConfigFormInstance XML document?

[bgowland]

Code:

public override Form GetConfigFormInstance(XmlDocument document)

So what's that document all about then? Does it contain anything interesting?

Cheers,
Brian

[sub]

The document is the config.xml file, which can be used to query or save settings.

[bgowland]

The document is the config.xml file, which can be used to query or save settings.

OK, I get it. Thanks.

[fluffykeith]

Not sure I do!

Is that different to the helper function GetConfiguration()?

Also on a marginally near topic - is there an example of how a plugin is configured in the config tool?

cheers

Keith

[JavaWiz]

In your plugin code, populate a method as follows:

Code:

public Form GetConfigFormInstance(System.Xml.XmlDocument document)
{
    return new MyPluginConfigForm(document);
}

MyPluginConfigForm (name should reflect your plugin) is a normal windows form with a constructor as follows:

Code:

public MyPluginConfigForm(XmlDocument document)

The document is the config.xml in a XmlDocument object.

Use this document object to read and write settings into the Plugins section for your specific plugin.

When in the gbpvr config program plugin tab, if the user selects the plugin to manage, the plugin's getConfigFormsInstance() method is called. If it returns a Windows form object, that object is loaded and displayed.

The WizTools provides an example (WizUiHelperDemoPlugin) that shows how this works.

[fluffykeith]

Thanks for the info