4D v17
WP Insert table
- 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 CREATE BOOKMARK
- WP Create paragraph range
- WP Create picture range
- WP Create range
- WP Create table rangeNew
- WP DELETE BOOKMARK
- WP EXPORT DOCUMENT
- WP EXPORT VARIABLE
- WP GET ATTRIBUTES
- WP Get body
- WP Get bookmark range
- WP GET BOOKMARKS
- WP Get element by IDNew
- WP Get elementsNew
- WP Get footer
- WP Get frame
- WP Get header
- WP Get page count
- WP Get positionNew
- WP Get selection
- WP Get textNew
- WP Import document
- WP INSERT BREAKUpd
- WP INSERT DOCUMENT
- WP INSERT PICTURE
- WP Insert table
- WP Is font style supported
- WP New
- WP PRINT
- WP RESET ATTRIBUTES
- WP SELECT
- WP SET ATTRIBUTES
- WP SET FRAME
- WP SET TEXTNew
- WP Table append row
- WP Table get cellsUpd
- WP Table get columnsUpd
- WP Table get rowsUpd
- WP USE PAGE SETUP
- 4D Write Pro Attributes
WP Insert table
| WP Insert table ( rangeObj ; mode {; rangeUpdate {; nbCols {; nbRows}}} ) -> Function result | ||||||||
| Parameter | Type | Description | ||||||
| rangeObj | Object |
|
Range | |||||
| mode | Longint |
|
Insertion mode | |||||
| rangeUpdate | Longint |
|
Range update mode | |||||
| nbCols | Longint |
|
Number of columns to set in the table | |||||
| nbRows | Longint |
|
Number of rows to set in the table | |||||
| Function result | Object |
|
Table reference object | |||||
The WP Insert table command inserts a new table in the rangeObj according to the specified insertion mode and returns the corresponding new table object. Optionally, you can pass a rangeUpdate parameter as well as a predefined number of columns and rows in nbCols and nbRows.
In rangeObj, pass a range.
Note: Inserting a table within another table is not possible (an error is returned).
In the mode parameter, pass one of the following constants to indicate the insertion mode to be used for the table in the document:
| 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 |
In the optional rangeUpdate parameter, you can pass one of the following constants to specify whether or not the inserted table is included in the 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 table is included in the range.
You can pass in nbCols and nbRows the number of columns and rows to define in the table. By default, if nbCols and nbRows are omitted, a new table with 0 column and 0 row is created. You will then be able to add these elements using the WP Table append row command.
The command returns the new table as a table object, that you can pass thereafter to the other WP table commands. The table is created with default font, border, and color attributes that you can customize using the WP SET ATTRIBUTES command.
In a blank document, you want to add a new table with 3 columns and 2 rows:
C_OBJECT($WPRange;$WPTable)
$WPRange:=WP Create range(WParea;wk start text;wk end text)
$WPTable:=WP Insert table($WPRange;wk append;wk exclude from range;3;2)Result:
Product: 4D
Theme: 4D Write Pro Language
Number:
1473
Created: 4D v16 R4
4D Write Pro Reference ( 4D v17)
