<     > 

Help (SIObject)

Introduced

4.0

Description

Specifies the help file for an object as a String (an empty string is returned if an object has no help file).

The Help property is read-only for all objects except PluginItem and PluginRegistrar.

A plug-in help file can be an HTML page or a compiled help (.chm) file.

By default, Softimage looks for a plug-in help file in the "doc" subfolder of the plug-in installation folder. Softimage assumes the help file has the same name as the plug-in. For example, if the plug-in MyPlugin.js is located in the folder "C:\MyWorkgroup\Application\Plugins" then Softimage looks in the folder "C:\MyWorkgroup\Application\Plugins\Doc" for a help file named MyPlugin.chm, MyPlugin.html, or MyPlugin.htm.

If a plug-in help file has a different name or location, you can set this property on the PluginItem or PluginRegistrar object to specify the names of help files and, optionally, their locations.

Notes:

To specify the help file for a dynamic custom property (a property created with SceneItem.AddCustomProperty) use PPGLayout.SetAttribute to set the siUIHelpFile attribute.

The help file string for SPDL objects contains the location of the help file and an index separated by a semicolon. For example, "HelpFile;HelpID", where HelpFile is the object help file and HelpID is an identifier for indexing the help file.

C# Syntax

// get accessor
String rtn = SIObject.Help;

// set accessor
SIObject.Help = String;

See Also

Examples

• See SIObject.Help.1.js

• See SIObject.Help.2.vbs

• See SIObject.Help.3.js

Autodesk Softimage 2011     <     >