4D v20
WP INSERT FORMULA
- 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 INSERT FORMULA
| WP INSERT FORMULA ( targetObj ; formula ; mode {; rangeUpdate} ) | ||||||||
| Parameter | Type | Description | ||||||
| targetObj | Object |
|
Range or element or 4D Write Pro document | |||||
| formula | Object |
|
Formula object | |||||
| mode | Number |
|
Insertion mode | |||||
| rangeUpdate | Number |
|
Includes or excludes the inserted content within the range | |||||
The WP INSERT FORMULA command inserts a formula in targetObj according to the specified insertion mode.
In the targetObj parameter, you can pass:
- a range, or
- an element (table / row / cell(s) / paragraph / body / header / footer / section / subsection / inline picture), or
- a 4D Write Pro document.
In the formula parameter, pass the 4D formula to evaluate in an object created by the Formula or Formula from string command.
In the mode parameter, pass one of the following constants to indicate the insertion mode to be used:
| Constant | Type | Value | Comment |
| wk append | Longint | 2 | Insert contents at end of target |
| wk prepend | Longint | 1 | Insert contents at beginning of target |
| wk replace | Longint | 0 | Replace target contents |
- If targetObj is a range, you can use the optional rangeUpdate parameter to pass one of the following constants to specify whether or not the inserted formula is included in the resulting range:
Constant Type Value Comment wk exclude from range Longint 1 Inserted contents not included in updated range wk include in range Longint 0 Inserted contents included in updated range (default)
If you do not pass a rangeUpdate parameter, by default the inserted formula is included in the resulting range.
- If targetObj is not a range, rangeUpdate is ignored.
Note: Keep in mind that, when called, the formula object is evaluated within the context of the database or component that created it.
To replace all current date formulas with formatted strings:
C_COLLECTION($_formulas)
C_OBJECT($find;$newFormula)
// define the formula to find
$find:=Formula(Current date)
// define the replacement formula
$newFormula:=Formula(String(Current date;System date long))
// find all formulas in the document
$_formulas:=WP Get formulas(WriteProArea)
// query the collection from WP Get formulas
$_formulas:=$_formulas.query("formula.source =:1";$find.source)
// then replace each formula
For each($formula;$_formulas)
WP INSERT FORMULA($formula.range;$newFormula;wk replace)
End for each
Managing formulas
WP COMPUTE FORMULAS
WP FREEZE FORMULAS
WP Get formulas
Product: 4D
Theme: 4D Write Pro Language
Number:
1703
Created: 4D v18 R2
4D Write Pro Reference ( 4D v20)
