SetPropertyDouble(propertyName As String, propertyValue As Double) As Boolean

 

Set a Double value of a property, which exists in the properties manager.

 

If the property is not existing yet, it will be added.

 

Select New Properties Manager from menu Script to add or remove properties manually.

 

Properties are saved to the customproperties table in the database.

 

 

Parameters:

Name

Type

Description

propertyName

String

The name of the property, as it is used in Properties Manager

propertyValue

Double

Double value, to be assigned to the property propertyName

A double-precision floating-point number.

The default value of a Double is 0.0

 

Returns:

 

Type

Value

Description

Boolean

True or False

Returns True if the property has been set.

Returns False upon failure

 

Available in:

WindowMain

WindowLink

YES

YES

 

Hint: You can find references to XojoScripts which make use of this function by sending the following SQL statement to the database:

Select id,GUID, ScriptName,ScriptCode from im_scripts where ScriptCode Like '%SetPropertyDouble%'

 

Example XojoScript:

 

Hint:         Use properties in order to hold a value at a single location, which then can be reused in various scripts.

                  For instance in this example we have the property cLetterLocationDateY which holds the vertical position value

of the city and date information on invoices and letters.

 

// Set position of date to be printed on invoice

Call SetPropertyDouble("cLetterLocationDateY",230.0)

 

// Display property to user

MsgBox(Str(GetPropertyDouble("cLetterLocationDateY")))