4D v17

WP Table get cells

Home

 
4D v17
WP Table get cells

WP Table get cells 


 

WP Table get cells ( tableRef ; startCol ; startRow {; numCols {; numRows}} ) -> Function result 
Parameter Type   Description
tableRef  Object in Table reference
startCol  Longint in Position of first cell column
startRow  Longint in Position of first column row
numCols  Longint in Number of columns to get
numRows  Longint in Number of rows to get
Function result  Object in New range containing cells

The WP Table get cells command returns a new cell range object containing the selection of tableRef cells defined by startCol, startRow, numCols, and numRows.

The startCol and startRow parameters define the left top coordinates of the first cell to get. Optionally, you can pass the optional numCols and numRows parameters to specify respectively the number of columns and the number of rows to get for the cell range. If numRows is omitted, a single row is returned. If both numCols and numRows are omitted, the returned range contains a single cell.

If startCol plus numCols or startRow plus numRows exceed the number of columns/rows in tableRef, or if startCol or startRow is greater than the number of columns/rows in tableRef, the returned range contains the maximum possible columns/rows.

You want to modifiy the attributes of a range of cells:

 C_OBJECT($wpTable;$wpRange;$wpRow1;$wpRow2;$wpRow3;$wpRow4;$wpRow5;$cells)
 $wpRange:=WP Create range(WParea;wk start text;wk end text)
 
 $wpTable:=WP Insert table($wpRange;wk append)
 $wpRow1:=WP Table append row($wpTable;"Paul";"Smith";25)
 $wpRow2:=WP Table append row($wpTable;"John";"Richmond";40)
 $wpRow3:=WP Table append row($wpTable;"Mary";"Trenton";18)
 $wpRow4:=WP Table append row($wpTable;"Christopher";"Lee";53)
 $wpRow5:=WP Table append row($wpTable;"Henry";"Cartier";42)
 
 $cells:=WP Table get cells($wpTable;2;2;2;2)
 WP SET ATTRIBUTES($cells;wk background color;0x00E0E0E0)
 WP SET ATTRIBUTES($cells;wk text color;"blue")
 WP SET ATTRIBUTES($cells;wk border color;0x00E000E0)
 WP SET ATTRIBUTES($cells;wk text align;wk center)

 

Result:

To get a range of cells starting from the cell "5x7" to the end of the row:

 $cellRange:=WP Table get cells(tableRef;5;7;MAXLONG;1)

To get a range of cells starting from the cell "5x7" to the end of the column:

 $cellRange:=WP Table get cells(tableRef;5;7;1;MAXLONG)

To get a range of cells starting from the cell "5x7" to the end of the table:

 $cellRange:=WP Table get cells(tableRef;5;7;MAXLONG;MAXLONG)



See also 

WP Table get columns
WP Table get rows

 
PROPERTIES 

Product: 4D
Theme: 4D Write Pro Language
Number: 1477

This command can be run in preemptive processes

 
HISTORY 

New
Created: 4D v16 R4
Modified: 4D v17

 
ARTICLE USAGE

4D Write Pro Reference ( 4D v17)