siAddonItemType
This enumeration type specifies the type of item supported by add-ons. Depending on which type you use with the Addon.AddItem method, you need to supply only a name, or a path and file name, or you may be able to use either as indicated below.
siAddonItemType.siLayoutAddonItemType // 1 siAddonItemType.siToolbarAddonItemType // 2 siAddonItemType.siKeyMapAddonItemType // 3 siAddonItemType.siScriptCmdAddonItemType // 4 siAddonItemType.siPresetAddonItemType // 5 siAddonItemType.siSpdlAddonItemType // 6 siAddonItemType.siLibraryAddonItemType // 7 siAddonItemType.siOtherAddonItemType // 8 siAddonItemType.siEventAddonItemType // 9 siAddonItemType.siDeviceAddonItemType // 10 siAddonItemType.siShelfAddonItemType // 11 siAddonItemType.siPluginAddonItemType // 12 siAddonItemType.siHelpAddonItemType // 13 siAddonItemType.siViewAddonItemType // 14 |
| Constant | Value | Description |
|---|---|---|
| siLayoutAddonItemType | 1 | Layout. To specify a layout, use either the name of the layout
or the full path and file name. The name appears in the File > Addons > Package dialog (eg., "myLayout"). The full path and file name is similar to this: InstallationPath( siUserPath ) & "\Data\Layouts\myLayout.xsily" |
| siToolbarAddonItemType | 2 | Toolbar created before version 4.0 (with the .DSToolbar file
extension). To specify such a toolbar, use either the name of the
toolbar or the full path and file name. The name appears in the File > Addons > Package dialog (eg., "myToolbar"). The full path and file name is similar to this: InstallationPath( siUserPath ) & "\Data\Preferences\Toolbars\MyToolbar{FB913D3E-F14E-11D3-9F04-009027318C6F}.DSToolbar" |
| siKeyMapAddonItemType | 3 | Key Map. To specify a keymap, use either the name of the keymap
or the full path and file name. The name appears in the File > Addons > Package dialog (eg., "myKeyMap"). The full path and file name is similar to this: InstallationPath( siUserPath ) & "\Data\Preferences\KeyMaps\myKeyMap.DSKeymap" |
| siScriptCmdAddonItemType | 4 | Custom Command (script based or compiled). To specify a custom command, use the name of the command as it appears in the history pane of the Script Editor (eg., "myCustomCommand"). If the command is part of a self-installed plug-in use siPluginAddonItemType (12) instead. |
| siPresetAddonItemType | 5 | Preset. To specify a preset, use the full path and file name
(eg., InstallationPath( siUserPath ) &
"\Data\DSPresets\Properties\MyCustomPreset.Preset"). When the Preset refers to a SPDL based custom property then the SPDL will automatically be packaged as well. When the Preset refers to a custom compiled operator or real-time shader then both the SPDL file and binary (.dll or .so) will automatically be packaged. |
| siSpdlAddonItemType | 6 | SPDL. To specify a SPDL, use the full path and file name (eg., InstallationPath( siUserPath ) & "\Data\DSPresets\spdl\MyCustomDialog.spdl"). |
| siLibraryAddonItemType | 7 | Library file, (.dll or .so). (NOT CURRENTLY SUPPORTED) You can use siPluginAddonItemType (12) instead to package any libraries in an .xsiaddon file. |
| siOtherAddonItemType | 8 | Other kind of file The 'Other' category includes HTML or CHM files containing help pages for your application, an image file used by your application, etc. To specify an additional file, use the full path and file name (eg., InstallationPath( siUserPath ) & "\Data\VCCProject\HelpPages\MyHTMLHelp.html"). |
| siEventAddonItemType | 9 | Event. To specify an event, use the name of the event as it appears in the File > Addons > Package dialog (eg., "myCustomEvent"). |
| siDeviceAddonItemType | 10 | Device Driver. (NOT CURRENTLY SUPPORTED) You can use siPluginAddonItemType (12) instead to package any .xsidevice and .dll/.so files in an .xsiaddon file. |
| siShelfAddonItemType | 11 | New format toolbar or shelf. Toolbars created starting with version 4.0 are .xsitb files found in the \Application\toolbars directory. All Presets and Custom Commands referenced by the toolbar will also be packaged in the add-on automatically. |
| siPluginAddonItemType | 12 | A self-installed Plugin. This is a single script file or dll which can contain one or more Commands, Custom Properties or other items. You can specify this type of add-on item either by plug-in name or by its full path. |
| siHelpAddonItemType | 13 | A Windows Help (.hlp) file. (NOT CURRENTLY SUPPORTED) You can use siPluginAddonItemType (12) instead to package any .hlp files in an .xsiaddon file. |
| siViewAddonItemType | 14 | A custom relational view. |