DatStat Illume 4.5 SDK Class Reference

IDatStatRuntimeContent.RuntimeContent_Hook Method 

This method will be called wherever a RuntimeContent object is placed in a survey.

string RuntimeContent_Hook(
   HookContext ctx
);

Parameters

ctx
A runtime context used for interacting with the running survey.

Return Value

XHTML markup to be included in the survey where a RuntimeContent object referencing a class which implements the IDatStatRuntimeContent interface is placed. If NULL is returned, no content will be displayed.

Remarks

The runtime content hook is the only hook that can be called at arbitrary points within the survey. To make this happen, there is a corresponding survey object called “Runtime Content” that can be placed within a survey just like Questions, Text/Html objects, Page-Breaks, etc. When a survey page is rendered, and a “Runtime Content” object is encountered, the registered “RuntimeContent” hook will be called and the string result of that call will be rendered on the survey page at that point in the survey. The hook developer must make sure that the content passed back by the RuntimeContent_Hook method is well formed XHTML or the survey may fail to operate properly.

Use the HookData property of the HookContext to access an optional custom string passed in by the call to the hook within the survey.

See Also

IDatStatRuntimeContent Interface | DatStat.Collector Namespace | HookContext