Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples
Videos
New in version: 9.0   9.1   9.2   9.3   9.4   9.5   10.0   10.1   10.2   10.3    Statistic  

Preferences.SetValue

Sets preferences value.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
Preferences 2.7 Yes Yes Yes No Yes
MBS( "Preferences.SetValue"; Domain; Key { ; Value; Type } )   More

Parameters

Parameter Description Example value
Domain The domain name for your preferences. Leave empty for default one. "de.mbsplugins.MyApp"
Key The key for the value lookup. "Username"
Value Optional
The new value text.
"Christian"
Type Optional
The data type to use. (Mac only)
Can be integer, double, boolean or text.
"text"

Result

Returns OK or error message.

Description

Sets preferences value.
Domain should be an unique name for your app, like with reverse domain name notation. An example: "de.monkeybreadsoftware.filemaker.runtimes.MyApp". If you use no domain, the default one is used.
Values are stored in registry on Windows and preference files on Mac.
Key must not be an empty string.

This is the location where you can store global settings like the last used username for login.
Changing preferences of FileMaker only works, if you restart FileMaker for changes take effect. Going to the preferences dialog (even with cancel on exit), can cause FileMaker to write it's settings over what you just changed.

To change windows preferences for Windows, you may better go with Registry functions.

Examples

Sets preferences:

MBS( "Preferences.SetValue"; "de.mbsplugins.MyApp"; "Username"; $username )

Set flag to not allow plugins to update:

MBS( "Preferences.SetValue"; "com.filemaker.client.advanced12"; "Preferences:AllowToUpdatePlugins"; 0; "integer")

Set file cache to 1 GB:

MBS( "Preferences.SetValue"; "com.filemaker.client.advanced12"; "Preferences:FileCacheSize"; 1048576; "integer")

Set user name in FileMaker preferences:

MBS( "Preferences.SetValue"; "com.filemaker.client.advanced12"; "Preferences:UserName"; "Chris" )

Switch off update checks:

Let(
[
oldValue = MBS( "Preferences.GetValue"; "com.filemaker.client.pro12"; "Preferences:AppGenOptions");
newValue = MBS("Math.BitwiseOR"; oldValue; 32 + 32768);
R = MBS( "Preferences.SetValue"; "com.filemaker.client.pro12"; "Preferences:AppGenOptions"; newValue; "integer")
];r )

Set initial file for FileMaker 19 or newer on MacOS:

MBS( "Preferences.SetValue"; "com.filemaker.client.pro12"; "Preferences:UseInitialfile"; 1; "integer") &
MBS( "Preferences.SetValue"; "com.filemaker.client.pro12"; "Preferences:Initialfile"; "filemac:/Mac/Users/cs/Documents/Test.fmp12"; "text")

See also

Example Databases

Blog Entries

Created 18th August 2014, last changed 16th June 2020


Preferences.SetTextSelectionWithDragAndDrop   -   PrintDialog.ClearOption

Feedback: Report problem or ask question.




Links
MBS Xojo PDF Plugins