Loadset.setValueDescription


setValueDescription(name, desc, [persist])

specify a description to be used (in the report wizard) for a value previously added using createValue. Note that if this function is not called, the value will not appear in the report. It is an error to call this function for any value not previously added using createValue. By default, values that are added via createValue() are not persistent. That is, when the loadset is subsequently redefined using a call of the form db.create...(), all such data is lost, consistently with all other data. However, the persist flag may be set true to prevent this. This should only be done for data that cannot be logically invalidated by entering conflicting data in Modeller's user interface.

namestringname of the value
descstringnew description
persistoptional boolean persistence (default false)
Return valueIFDispatch

Back to Loadset

Back to Overview