<xmod:plugin>

Related Topics

 

XMod's display plugins take flexibility to new heights. Once a plugin has been installed, it's easy to use. In fact, it's simply another tag, like the one's you've become familiar with using XMod. Below is an example of a sample tag you might use:

 

<xmod:plugin assembly="CompanyName.Product" class="CompanyName.XModPlugins.Polarizer" backcolor="black" forecolor="white" />

 

The tag has 2 required attributes: assembly and class. Other attributes may be required by the specific plugin that you're using. In the example above, the plugin is contained in the DLL "CompanyName.Product.dll" (note the dll extension isn't included in the tag). Within that DLL, the class that represents the plugin is "Polarizer" in the "CompanyName.XModPlugins" namespace. The developer should provide this information to you. The "backcolor" and "forecolor" are not required by XMod. Instead, they are attributes used by the plugin to customize its behavior. These attributes will be different for each plugin and may be required or optional.

 

So, to enable a plugin for a module, you simply include a plugin tag in your ListView template

 

ATTRIBUTES:

assembly

This is the name of the DLL that contains the plugin. Do not include the DLL extension or any filepath information. This will be added by XMod at runtime.

class

Fully-qualified name of the plugin class in the assembly.