WinStudio

GetUserPreferenceValue Method

Applies To

IWSApplication interface

Definition

Retrieves the value of a WinStudio user preference setting.

Syntax

Application.GetUserPreferenceValue( string )

  Part

  Description
string Required. Name of the user preference setting for which you want to retrieve the value.

Remarks

The return value is a string containing the value of the designated user preference setting or a Boolean value indicating the user preference setting.

The following table lists the user preference values for which you can request the value, along with the possible return values:

 User Preference Value Names  Possible Values
BaseFormForeColorDescriptor String using RGB format (rrR,ggG,bbB)
BaseFormBackColorDescriptor String using RGB format (rrR,ggG,bbB)
NormalForegroundColorDescriptor String using RGB format (rrR,ggG,bbB)
NormalBackgroundColorDescriptor String using RGB format (rrR,ggG,bbB)
ProtectedForegroundColorDescriptor String using RGB format (rrR,ggG,bbB)
ProtectedBackgroundColorDescriptor String using RGB format (rrR,ggG,bbB)
RequiredForegroundColorDescriptor String using RGB format (rrR,ggG,bbB)
RequiredBackgroundColorDescriptor String using RGB format (rrR,ggG,bbB)
TBDForegroundColorDescriptor String using RGB format (rrR,ggG,bbB)
TBDBackgroundColorDescriptor String using RGB format (rrR,ggG,bbB)
InboxNewMessagesUseBoldFont Boolean:

  1. 1 = TRUE (New messages use bold font face.)

    0 = FALSE (New messages do not use bold font face.)
InboxNewMessagesUseBGColor Boolean:

  1. 1 = TRUE (New messages use the normal background color.)

    0 = FALSE (New messages do not use the normal background color.)
InboxNewMessagesBGColorDescriptor String using RGB format (rrR,ggG,bbB)

For more information about these user preferences, see the WinStudio users' Help: From the Help menu, select Contents and Index. Then, in the Contents pane, select Basics > Getting Around in the System > Setting Preferences > Run Time Settings.

Example

Dim inboxNewMessagesUseBGColor As String
Dim inboxNewMessagesBGColorDescriptor As String
inboxNewMessagesUseBGColor = Application.GetUserPreferenceValue("InboxNewMessagesUseBGColor")
inboxNewMessagesUseBoldFont = Application.GetUserPreferenceValue("InboxNewMessagesUseBoldFont")
If (inboxNewMessagesUseBGColor = "1") Then
   inboxNewMessagesBGColorDescriptor = Application.GetUserPreferenceValue("InboxNewMessagesBGColorDescriptor")
End If