Difference between revisions of "CustomTextStyles"

From SAP Enable Now Wiki
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
  
 
==Scope==
 
==Scope==
Web Assistant parameter, specified either in the URL or in the Web Assistant parameters in the linked application.
+
SAP Companion parameter, specified either in the URL or in the SAP Companion parameters in the linked application.
  
 
==Purpose==
 
==Purpose==
If this parameter is set to '''true''' then the text styles used in the Web Assistant are taken from the relevant ''Text Styles'' resource in the Workarea, depending on the value of the '''[[theme]]''' parameter.
+
If this parameter is set to '''true''' then the text styles used in the SAP Companion are taken from the relevant ''Text Styles'' resource in the Workarea, depending on the value of the '''[[theme]]''' parameter.
  
 
==Usage==
 
==Usage==
Line 16: Line 16:
 
! <tt>theme</tt> !! Text Styles resource used
 
! <tt>theme</tt> !! Text Styles resource used
 
|-
 
|-
| <tt>default</tt> || ''Text Styles: Web Assistant - Default Theme''
+
| <tt>default</tt> || ''Text Styles: SAP Companion - Default Theme''
 
|-
 
|-
| <tt>hcb</tt> || ''Text Styles: Web Assistant - HCB Theme''
+
| <tt>hcb</tt> || ''Text Styles: SAP Companion - HCB Theme''
 
|-
 
|-
| <tt>hcw</tt> || ''Text Styles: Web Assistant - HCW Theme''
+
| <tt>hcw</tt> || ''Text Styles: SAP Companion - HCW Theme''
 
|-
 
|-
| <tt>light</tt> || ''Text Styles: Web Assistant - Light Theme''
+
| <tt>light</tt> || ''Text Styles: SAP Companion - Light Theme''
 
|-
 
|-
| <tt>quartz</tt> || ''Text Styles: Web Assistant - Quartz Theme''
+
| <tt>quartz</tt> || ''Text Styles: SAP Companion - Quartz Theme''
 
|-
 
|-
| <tt>quartzlight</tt> || ''Text Styles: Web Assistant - Quartz Light Theme''
+
| <tt>quartzlight</tt> || ''Text Styles: SAP Companion - Quartz Light Theme''
 
|-
 
|-
| <tt>sfsf</tt> || ''Text Styles: Web Assistant - SFSF Theme''
+
| <tt>sfsf</tt> || ''Text Styles: SAP Companion - SFSF Theme''
 
|}
 
|}
If any of these are missing (or the '''theme''' parameter is missing or specifies an invalid value), the ''...Default'; theme is used instead.
+
If any of these are missing (or the '''theme''' parameter is missing or specifies an invalid value), the ''...Default'' theme is used instead.
  
 
Note that in the documentation for the 20.05 release only <tt>default</tt> and <tt>light</tt> are listed as options for the '''[[themeBase]]''' property. so I wouldn't recommend planning on the long-term availability of the <tt>HCB</tt> and <tt>SFSF</tt> options.
 
Note that in the documentation for the 20.05 release only <tt>default</tt> and <tt>light</tt> are listed as options for the '''[[themeBase]]''' property. so I wouldn't recommend planning on the long-term availability of the <tt>HCB</tt> and <tt>SFSF</tt> options.
Line 39: Line 39:
 
* '''[[theme]]'''
 
* '''[[theme]]'''
  
[[Category: Web Assistant parameter]]
+
[[Category: SAP Companion parameter]]

Latest revision as of 13:41, 14 July 2023


Scope

SAP Companion parameter, specified either in the URL or in the SAP Companion parameters in the linked application.

Purpose

If this parameter is set to true then the text styles used in the SAP Companion are taken from the relevant Text Styles resource in the Workarea, depending on the value of the theme parameter.

Usage

Specified as:

customTextStyles=[false|true]

The Text Styles resource used is as follows:

theme Text Styles resource used
default Text Styles: SAP Companion - Default Theme
hcb Text Styles: SAP Companion - HCB Theme
hcw Text Styles: SAP Companion - HCW Theme
light Text Styles: SAP Companion - Light Theme
quartz Text Styles: SAP Companion - Quartz Theme
quartzlight Text Styles: SAP Companion - Quartz Light Theme
sfsf Text Styles: SAP Companion - SFSF Theme

If any of these are missing (or the theme parameter is missing or specifies an invalid value), the ...Default theme is used instead.

Note that in the documentation for the 20.05 release only default and light are listed as options for the themeBase property. so I wouldn't recommend planning on the long-term availability of the HCB and SFSF options.

These Text Styles can be found in the Workarea under Resources | Adaptable Resources and can be customized as required.

See Also