VP Object to font

Home

4D v19

VP Object to font


VP Object to font ( fontObj ) -> Function result

Parameter	Type	Description
fontObj	Object	Font object
Function result	Text	Font shorthand

Description

The VP Object to font command returns a font shorthand string from fontObj.

In fontObj, pass an object containing the font properties. The following properties are supported:

Property	Type	Description	Possible values	Mandatory
family	text	Specifies the font.	any standard or generic font family. Ex. "Arial", "Helvetica", "serif", "arial,sans-serif"	Yes
size	text	Defines the size of the font. The line-height can be added to the font-size: font-size/line-height: Ex: "15pt/20pt"	a number with one of the following units: "em", "ex", "%", "px", "cm", "mm", "in", "pt", "pc", "ch", "rem", "vh", "vw", "vmin", "vmax" or one of the following: vk font size large, vk font size larger, vk font size x large, vk font size xx large, vk font size small, vk font size smaller, vk font size x small, vk font size xx small	Yes
style	text	The style of the font.	vk font style italic,vk font style oblique	No
variant	text	Specifies font in small capital letters.	vk font variant small caps	No
weight	text	Defines the thickness of the font.	vk font weight 100, vk font weight 200, vk font weight 300, vk font weight 400, vk font weight 500, vk font weight 600, vk font weight 700, vk font weight 800, vk font weight 900, vk font weight bold, vk font weight bolder, vk font weight lighter	No

This object can be created with the VP Font to object command.

The returned shorthand string can be assigned to the "font" property of a cell with the VP SET CELL STYLE, for example.

Example

 $cellStyle:=VP Get cell style($range)

 

 $font:=VP Font to object($cellStyle.font)

 $font.style:=vk font style oblique

 $font.variant:=vk font variant small caps

 $font.weight:=vk font weight bolder

 

 $cellStyle.font:=VP Object to font($font)

  //$cellStyle.font contains "bolder oblique small-caps 16pt arial"