Applies To
SIObject.Help property
Description
This example demonstrates how to use the SIObject.Help property.
Code
/*
This example shows how to specify the help
for a plug-in and for a custom property.
*/
function XSILoadPlugin( in_reg )
{
in_reg.Author = "sblair";
in_reg.Name = "MyPlugin";
// Help file is in the same folder as the plug-in
var sChm = "MyPluginHelp.chm";
in_reg.Help = XSIUtils.BuildPath( in_reg.OriginPath, sChm );
var oPluginItem = in_reg.RegisterProperty("MyProperty");
// Open a specific help topic for the property
sChm = "MyPluginHelp.chm::/MyProperty.htm";
oPluginItem.Help = XSIUtils.BuildPath( in_reg.OriginPath, sChm );
//RegistrationInsertionPoint - do not remove this line
return true;
}Related Examples
Keywords
SIObject Help
Autodesk Softimage 2011