Methods of the WORD CLIENT Object - Prefix CEL

CEL_DELETE

Deletes the cell at the specified position in the first table of the current range and shifts the remaining cells as specified.

RowNumber	cell's row number,
ColumnNumber	cell's column number,
Shift	shifts or deletes any remaining cells,

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax

CALL_METHOD NameWordClientObject CEL_DELETE RowNumber ColumnNumber Shift ReturnCode

Parameters

RowNumber

NUM_BIN_4 type (input parameter)

ColumnNumber

NUM_BIN_4 type (input parameter)

Shift

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_DELETE_CELL_SHIFT_LEFT	any cells to the right of the row will be shifted the left,
_WRD_DELETE_CELL_SHIFT_UP	the cell will be cleared but not deleted,
_WRD_DELETE_CELL_ENTIRE_ROW	the whole row to which the cell belongs will be deleted,
_WRD_DELETE_CELL_ENTIRE_COLUMN	the whole column to which the cell belongs will be deleted,

ReturnCode

NUM_BIN_4 type (output parameter)

CEL_GET_VALUE

Retrieves the value of the cell in the specified position in the first table of the current range.

RowNumber	cell's row number,
ColumnNumber	cell's column number.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax
CALL_METHOD NameWordClientObject CEL_GET_VALUE RowNumber ColumnNumber Value ReturnCode
Parameters
RowNumber	NUM_BIN_4 type (input parameter)
ColumnNumber	NUM_BIN_4 type (input parameter)
Value	valid types: NUM_BIN_2, NUM_BIN_4, ALPHA(any n), NUM_E, NUM_P, BOOL, DATE, TIME, TIMESTAMP (output parameter)
ReturnCode	NUM_BIN_4 type (output parameter)

Note: If the cell has a numerical format, the value returned may be incorrect (notably if the format inserts spaces in the number).

Example

* Calculating subscriptions inclusive of tax - SubscriptIncTax - in row 8

* Column 2:

* TotSubscript = total subscriptions before taxes

RowNumber = 8

*Subscriptions inclusive of tax

ColumnNumber = 2

Formula = '=((' // TotSubscript // '+' // SubscriptTax ///')/100)'

NumericalFormat = '0,00'

CALL_METHOD WORD_CLI CEL_SET_FORMULA -

RowNumber ColumnNumber Formula ReturnCode

* Retrieving the SubscriptIncTax value

CALL_METHOD WORD_CLI CEL_GET_VALUE -

RowNumber ColumnNumber SubscriptIncTax ReturnCode

CEL_SET_FORMULA

Sets a calculation expression in the cell in the specified position in the first table of the current range.

RowNumber	cell's row number,
ColumnNumber	cell's column number,
Formula	calculation expression,
NumericalFormat	numerical format, specifying how the value is formatted.

We recommend consulting the Microsoft Word help documentation in order to fully understand the potential offered by this method.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax
CALL_METHOD NameWordClientObject CEL_SET_FORMULA RowNumber ColumnNumber Formula NumericalFormat ReturnCode
Parameters
RowNumber	NUM_BIN_4 type (input parameter)
ColumnNumber	NUM_BIN_4 type (input parameter)
Formula	ALPHA(250) (input parameter)
NumericalFormat	ALPHA(250) (input parameter)
ReturnCode	NUM_BIN_4 type (output parameter)

Example

First example

* Total amount of subscriptions

RowNumber = 6

ColumnNumber = 2

Formula = '=SUM(ABOVE)'

NumericalFormat = '0,00'

CALL_METHOD WORD_CLI CEL_SET_FORMULA -

RowNumber ColumnNumber Formula ReturnCode

Other example

* Calculating subscriptions inclusive of tax - SubscriptIncTax - in row 8

* Column 2:

* TotSubscript = total subscriptions before taxes

RowNumber = 8

*Subscriptions inclusive of tax

ColumnNumber = 2

Formula = '=((' // TotSubscript // '+' // SubscriptTax ///')/100)'

NumericalFormat = '0,00'

CALL_METHOD WORD_CLI CEL_SET_FORMULA -

RowNumber ColumnNumber Formula ReturnCode

* Retrieving the SubscriptIncTax value

CALL_METHOD WORD_CLI CEL_GET_VALUE -

RowNumber ColumnNumber SubscriptIncTax ReturnCode

CEL_SET_HEIGHT

Sets the height of the cell in the specified position in the first table of the current range. The unit of measurement used is the centimeter.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax
CALL_METHOD NameWordClientObject CEL_SET_HEIGHT LineNumber ColumnNumber Height ReturnCode
Parameters
RowNumber	NUM_BIN_4 type (input parameter)
ColumnNumber	NUM_BIN_4 type (input parameter)
Height	NUM_E(15,9) type (input parameter)
ReturnCode	NUM_BIN_4 type (output parameter)

CEL_SET_VALUE

Sets the value of the cell in the specified position in the first table of the current range. With numerical types, the value will be formatted using the specified numerical format, if any.

RowNumber	cell's row number,
ColumnNumber	cell's column number,
NumericalFormat	numerical format that specifies how the value is to be formatted for a numerical type.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax
CALL_METHOD NameWordClientObject CEL_SET_VALUE RowNumber ColumnNumber Value NumericalFormat ReturnCode
Parameters
RowNumber	NUM_BIN_4 type (input parameter)
ColumnNumber	NUM_BIN_4 type (input parameter)
Value	valid types: NUM_BIN_2, NUM_BIN_4, ALPHA(any n), NUM_E, NUM_P, BOOL, DATE, TIME, TIMESTAMP (input parameter)
NumericalFormat	ALPHA(250) (input parameter)
ReturnCode	NUM_BIN_4 type (output parameter)

CEL_SET_WIDTH

Sets the width of the cell in the specified position in the first table of the current range. The unit of measurement used is the centimeter.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax
CALL_METHOD NameWordClientObject CEL_SET_WIDTH RowNumber ColumnNumber Width ReturnCode
Parameters
RowNumber	NUM_BIN_4 type (input parameter)
ColumnNumber	NUM_BIN_4 type (input parameter)
Width	NUM_E(15,9) type (input parameter)
ReturnCode	NUM_BIN_4 type (output parameter)