VP Get table theme
History
| Release | Changes |
|---|---|
| 19 R8 | Added |
VP Get table theme ( vpAreaName : Text ; tableName : Text {; sheet : Integer } ) : cs.ViewPro.TableTheme
| Parameter | Type | Description | |
|---|---|---|---|
| vpAreaName | Text | -> | 4D View Pro area form object name |
| tableName | Text | -> | Table name |
| sheet | Integer | -> | Sheet index (current sheet if omitted) |
| Result | cs.ViewPro.TableTheme | <- | Current table theme property values |
Description
The VP Get table theme command returns the current theme propertie values of the tableName. A table theme can be set using the VP CREATE TABLE or VP SET TABLE THEME commands, or through the interface.
In vpAreaName, pass the name of the 4D View Pro area and in tableName, the name of the table.
In sheet, pass the index of the target sheet. If no index is specified or if you pass -1, the command applies to the current sheet.
The command returns an object of the cs.ViewPro.TableTheme class with properties and values that describe the current table theme.
Example
The command returns a full theme object even if a native SpreadJS theme name was used to define the theme.
var $param : cs.ViewPro.TableTheme
$param:=cs.ViewPro.TableTheme.new()
$param.theme:="dark10" //use of a native theme name
VP SET TABLE THEME("ViewProArea"; "ContextTable"; $param)
$vTheme:=VP Get table theme("ViewProArea"; "ContextTable")
$result:=Asserted(Value type($vTheme.theme)=Is object) //true