Product Logo

MMColor

Create and enhance color elements

Functions

MMColor_Configure

NameMMColor_Configure
Description

Calling this function with no parameters will open the MMColor Configuration Dialog. You can optionally open to a specific tab by specifying the name of the tab as the “Option” parameter. This function also allows you to get or set any preference found in the Configuration Dialog.

Valid PrefNames:

“AddHelp” - If True, Function specific Help will be added to Calculations when inserting the Plug-in’s Functions.

Return TypeVaries
FormatMMColor_Configure ( Option ; PrefName ; PrefValue )
Optional Parameters
Option

Specify the name of a Tab in the Configuration Dialog to show it opened to that tab.
Specify “Get” with the PrefName parameter to get a preference value. (If not found, and PrefValue is defined, PrefValue will be returned.)
Specify “Set” with the PrefName and PrefValue parameters to set a preference value.

PrefName

The Name of the Preference to Get or Set. (See the Function Description for a list of valid PrefNames.)

PrefValue

The Value of the Preference to Set. (See the Function Description for some possible values.)

Examples
Example 1

Opens the MMColor Configuration Dialog. (Because the "Option" parameter is not used, the dialog will open to the "Basics" tab.)

MMColor_Configure
Example 2

Opens the MMColor Configuration Dialog to the "About" tab.

MMColor_Configure( "About" )
Example 3

Returns the value of the 'Add Help Comments to External Functions' setting from the Configuration Dialog.

MMColor_Configure( "Get" ; "AddHelp" )
Example 4

Sets the 'Add Help Comments to External Functions' setting in the Configuration Dialog to false.

MMColor_Configure( "Set" ; "AddHelp" ; "False" )