4D v20
WP Get formulas
- 4D Write Pro Reference
-
- 4D Write Pro Language
-
- About 4D Write Pro objects
- Using commands from the Objects (Forms) theme
- Using commands from the Styled Text theme
- Accessing document contents by programming
- 4D Write Pro Constants
- WP Add picture
- WP Bookmark range
- WP COMPUTE FORMULAS
- WP DELETE BOOKMARK
- WP DELETE FOOTER
- WP DELETE HEADER
- WP DELETE PICTURE
- WP DELETE STYLE SHEET
- WP DELETE SUBSECTION
- WP DELETE TEXT BOX
- WP EXPORT DOCUMENTUpd
- WP EXPORT VARIABLEUpd
- WP Find all
- WP Find next
- WP Find previous
- WP FREEZE FORMULAS
- WP GET ATTRIBUTES
- WP Get body
- WP GET BOOKMARKS
- WP Get breaks
- WP Get data context
- WP Get element by ID
- WP Get elements
- WP Get footer
- WP Get formulas
- WP Get frame
- WP Get header
- WP Get links
- WP Get page count
- WP Get position
- WP Get section
- WP Get sections
- WP Get style sheet
- WP Get style sheets
- WP Get subsection
- WP Get text
- WP Get view properties
- WP Import document
- WP IMPORT STYLE SHEETS
- WP INSERT BREAK
- WP INSERT DOCUMENT
- WP INSERT FORMULA
- WP INSERT PICTURE
- WP Insert table
- WP Is font style supported
- WP New
- WP NEW BOOKMARK
- WP New footer
- WP New header
- WP New style sheet
- WP New subsection
- WP New text box
- WP Paragraph range
- WP Picture range
- WP PRINT
- WP RESET ATTRIBUTES
- WP SELECT
- WP Selection range
- WP SET ATTRIBUTES
- WP SET DATA CONTEXT
- WP SET FRAME
- WP SET LINK
- WP SET TEXT
- WP SET VIEW PROPERTIES
- WP Table append row
- WP TABLE DELETE COLUMNS
- WP TABLE DELETE ROWS
- WP Table get cells
- WP Table get columns
- WP Table get rows
- WP Table insert columns
- WP Table insert rows
- WP Table range
- WP Text range
- WP USE PAGE SETUP
- 4D Write Pro Attributes
WP Get formulas
| WP Get formulas ( targetObj ) -> Function result | ||||||||
| Parameter | Type | Description | ||||||
| targetObj | Object |
|
Range or element or 4D Write Pro document | |||||
| Function result | Collection |
|
Collection of formulas | |||||
The WP Get formulas command returns a collection of all formulas defined in targetObj.
In the targetObj parameter, you can pass:
- a range, or
- an element (table / row / cell(s) / paragraph / body / header / footer / section / subsection / inline or anchored picture / text box), or
- a 4D Write Pro document.
Note: When you pass a section in targetObj, only image formulas or formulas in text boxes anchored to this section or all sections are returned. If anchored to a page or to the embedded view, their formulas are not returned. Pass the document in targetObj to get all anchored element formulas.
Returned value
WP Get formulas returns a collection of formula objects, each of them containing one or more of the following properties:
| Property | Type | Description |
| [ ].formula | Object | The formula string is available through [ ].formula.source. The formula is a copy of the formula found in the target. If you want to modify the formula, it must be re-inserted in the document to be taken into account |
| [ ].range | Object | Range of the formula (not returned for anchored picture formulas) |
| [ ].anchoredID | Text | ID of anchored picture (returned for anchored picture formulas only) |
| [ ].owner | Object | 4D Write Pro document |
Notes:
- If you passed a subsection as target, formulas of the parent section are returned.
- If several formulas are returned, the collection is ordered with respect to the formula order in the target, except for targets of type document and section (any order in this case).
To get all formulas in a document:
C_COLLECTION($formulas)
$formulas:=WP Get formulas(WriteProArea)
To get all formulas in the first section of a document:
C_COLLECTION($formulas)
$formulas:=WP Get formulas(WP Get section(WriteProArea;1))
To get the formulas of all anchored pictures in a document:
C_COLLECTION($formulas)
$formulas:=WP Get formulas(WriteProArea).query("anchoredID # null")
Managing formulas
WP COMPUTE FORMULAS
WP FREEZE FORMULAS
WP Get links
WP INSERT FORMULA
Product: 4D
Theme: 4D Write Pro Language
Number:
1702
Created: 4D v18 R2
4D Write Pro Reference ( 4D v20)
