FOM 参考 > Application > System Objects > fLibrary interface
fLibrary interface
This object represents an external library.
LibraryStates enumeration
The possible states for the library.
The LibraryStates enumeration has the following constants of type int.
STATE_NEW = 0
The library is present but not initialised.
STATE_DISABLED = 2
The library is disabled.
STATE_ENABLED = 3
The library is enabled.
STATE_LOADED = 4
The library is loaded.
STATE_UNLOADED = 5
The library is unloaded.
displayName attribute
The display name of the library.
displayName
Access
read-write
Returns
String
manualAlways attribute
This property sets the default value for fLibrary-manualEnable, used whenever the library is loaded.
manualAlways
Access
read-write
Returns
boolean
manualEnable attribute
If true, the user must manually enable the library.
manualEnable
Access
read-write
Returns
boolean
name attribute
The internal name of the library, generated from the name of the folder that the library was installed into.
name
Access
read-only
Returns
String
path attribute
The path of where the library was installed.
path
Access
read-only
Returns
fPath
startFile attribute
The external script to call when the library is loaded. This can either be a .js file, or a .3m macro file.
startFile
Access
read-write
Returns
fPath
startFunction attribute
The function to call when the library is loaded.
startFunction
Access
read-write
Returns
Object
state attribute
The current state of the library. Possible values are in fLibrary-libraryStates.
state
Access
read-only
Returns
int
stopFile attribute
The external script to call when the library is unloaded. This can either be a .js file, or a .3m macro file.
stopFile
Access
read-write
Returns
fPath
stopFunction attribute
The function to call when the library is unloaded.
stopFunction
Access
read-write
Returns
Object
submenuString attribute
The string used to generate the submenu for this library.
submenuString
Access
read-write
Returns
String
version attribute
The version string for the library, generated from the name of the folder that the library was installed into.
version
Access
read-only
Returns
String
load method
Load this library.
load
Parameters
None
Returns
void. None.
saveLE method
Save this library to a new folder, protecting any file with either a ".js" or ".3*" extension. If the destination folder already exists, it will be renamed with ".bak" appended before the library is saved.
saveLE folder
Parameters
fPath folder
The folder to save the library into.
Returns
void. None.
unload method
Unload this library.
unload
Parameters
None
Returns
void. None.
Parent topic 
System Objects
这对您有帮助吗?