[This is preliminary documentation and subject to change.]

Allows a plugin to show a custom configuration window to set custom string value options.


Namespace: MediaMallTechnologies.Plugin
Assembly: Util (in Util.dll)

Syntax

Visual Basic (Declaration)
Function ConfigureOptions( _ 
   ByVal options As NameValueCollection,  _ 
   ByVal changeHandler As EventHandler _ 
) As Control
C#
Control ConfigureOptions(
   NameValueCollection options,
   EventHandler changeHandler
)
C++
Control ConfigureOptions(
   NameValueCollection options,
   EventHandler changeHandler
) abstract 
J#
Control ConfigureOptions(
   NameValueCollection options,
   EventHandler changeHandler
)
JScript
function ConfigureOptions(
   options : NameValueCollection,
   changeHandler : EventHandler
) : Control

Parameters

options
A NameValueCollection of options as cached by PlayOn, and that can be modified through the custom Control. Any changes made by the user on the custom Control must be applied to this collection, so that PlayOn can cache the values.
changeHandler
An EventHandler that should be invoked whenever changes are made by the user on the custom Control. This EventHandler is used to indicate to PlayOn Settings that changes have occurred, so that an Apply/Save button can be appropriately enabled.

Return Value

A Control that has configurable options that the user can adjust.

Remarks

Allows a plugin to show its own separate configuration window, and make changes to a NameValueCollection of keys and values, which will be cached and can be queried later through IPlayOnHost.Properties.

When HasOptions returns true, an "Options" button will be available for this plugin in PlayOn Settings. When pressed, the button will invoke this function to retrieve a custom Control that will be displayed in a modal dialog for the user. This custom Control can initialize based on the arbitrary values in the options parameter. Any changes that the user makes through the user interface must then be reflected directly in the options reference, such that they can then be cached by PlayOn.

It is critical that the supplied System.EventHandler be invoked whenever the user makes any relevant changes in the custom Control, so that an Apply/Save button can be appropriately enabled.

IMPORTANT: The key names "username" and "password" are reserved and must not be used or modified through this method. Instead, these login parameters are used in the TestLogin method.

See Also

Syntax based on .NET Framework version 2.0.
Documentation version 2.59.3434.20.