@GetComponentViewPreference (Formula Language)

Returns the value of the specified component view preference.

Note: This @function is new with Release 8.0.1.

Syntax

@GetComponentViewPreference( PreferenceID )

Parameters

PreferenceID

Text. The name of the preference, set in the CAE Notes® component Advanced properties tab, whose value you would like to read.

Return value

preferenceValue

Text list. Value(s) of the specified preference.

Usage

This @function is only valid in the Notes® client.

If the PreferenceID cannot be found, @ERROR is returned. The Error string is "Specified view preference is unavailable".

The following are some common component view preference IDs.

com.ibm.portal.app.input.file

com.ibm.portal.app.input.name

com.ibm.rcp.extensionType

com.ibm.rcp.id

com.ibm.rcp.moveable

com.ibm.rcp.objectId

com.ibm.rcp.ratio

com.ibm.rcp.showTitle

com.ibm.rcp.standalone

com.ibm.rcp.title

com.ibm.rcp.viewId

com.ibm.rcp.visible

notesurl

portletname

portletwindowid

Examples

  1. This code returns the value ALL_CONTACTS:
    @GetComponentViewPreference(com.ibm.rcp.csiviews.viewpart.folderalias)
  2. This code returns the value false:
    @GetComponentViewPreference(com.ibm.rcp.closeable)
  3. This code returns the value true:
    @GetComponentViewPreference(com.ibm.rcp.visible)
  4. This code returns the value 0.5:
    @GetComponentViewPreference(com.ibm.rcp.ratio)