Products Downloads


French version


 

Updates the appearance of the table in the current range using the predefined format. The table's original appearance may be altered when rows or columns are added, meaning it no longer matches the initial format.

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 TBL_UPDATE_AUTO_FORMAT ReturnCode

Parameters

ReturnCode

NUM_BIN_4 type (output parameter)

 

 

Applies a predefined format to the first table in the current range. The arguments to be specified for this method correspond to the options for Microsoft Word's Table AutoFormat dialog box (in the Table menu). You can specify whether or not each of the format's characteristics is to be applied.

Format

number of the predefined format,

ApplyBorders

the format's borders will be applied to the table,

ApplyShading

the format's background shading will be applied to the table,

ApplyFont

the format's font will be applied to the table,

ApplyColor

the format's color will be applied to the table,

ApplyHeadingRows

the format's heading row properties will be applied to the table,

ApplyLastRow

the format's bottom row properties will be applied to the table,

ApplyFirstColumn

the format's first column properties will be applied to the table,

ApplyLastColumn

the format's last column properties will be applied to the table,

ApplyFit

the width of the cells will be reduced without changing the way text is displayed.

 

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 TBL_AUTO_FORMAT Format ApplyBorders ApplyShading ApplyFont ApplyColor ApplyHeadingRows ApplyLastRow ApplyFirstColumn ApplyLastColumn ApplyFit ReturnCode

Parameters

Format

NUM_BIN_4 type (input parameter)

_WRD_FORMAT_TBL_NONE,

_WRD_FORMAT_TBL_SIMPLE1

_WRD_FORMAT_TBL_SIMPLE2

_WRD_FORMAT_TBL_SIMPLE3

_WRD_FORMAT_TBL_CLASSIC1

_WRD_FORMAT_TBL_CLASSIC2

_WRD_FORMAT_TBL_CLASSIC3

_WRD_FORMAT_TBL_CLASSIC4

_WRD_FORMAT_TBL_COLORFUL1

_WRD_FORMAT_TBL_COLORFUL2

_WRD_FORMAT_TBL_COLORFUL3

_WRD_FORMAT_TBL_COLUMNS1

_WRD_FORMAT_TBL_COLUMNS2

_WRD_FORMAT_TBL_COLUMNS3

_WRD_FORMAT_TBL_COLUMNS4

_WRD_FORMAT_TBL_COLUMNS5

_WRD_FORMAT_TBL_GRID1

_WRD_FORMAT_TBL_GRID2

_WRD_FORMAT_TBL_GRID3

_WRD_FORMAT_TBL_GRID4

_WRD_FORMAT_TBL_GRID5

_WRD_FORMAT_TBL_GRID6

_WRD_FORMAT_TBL_GRID7

_WRD_FORMAT_TBL_GRID8

_WRD_FORMAT_TBL_LIST1

_WRD_FORMAT_TBL_LIST2

_WRD_FORMAT_TBL_LIST3

_WRD_FORMAT_TBL_LIST4

_WRD_FORMAT_TBL_LIST5

_WRD_FORMAT_TBL_LIST6

_WRD_FORMAT_TBL_LIST7

_WRD_FORMAT_TBL_LIST8

_WRD_FORMAT_TBL_3D_EFFECTS1

_WRD_FORMAT_TBL_3D_EFFECTS2

_WRD_FORMAT_TBL_3D_EFFECTS3

_WRD_FORMAT_TBL_CONTEMPORARY

_WRD_FORMAT_TBL_ELEGANT

_WRD_FORMAT_TBL_PROFESSIONAL

_WRD_FORMAT_TBL_SUBTLE1

_WRD_FORMAT_TBL_SUBTLE2

ApplyBorders

BOOL type (input parameter)

ApplyShading

BOOL type (input parameter)

ApplyFont

BOOL type (input parameter)

ApplyColor

BOOL type (input parameter)

ApplyHeadingRows

BOOL type (input parameter)

ApplyLastRow

BOOL type (input parameter)

ApplyFirstColumn

BOOL type (input parameter)

ApplyLastColumn

BOOL type (input parameter)

ApplyFit

BOOL type (input parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

 

 

Creates a table of the specified size in the current range. Provided the range has not been collapsed, its contents will be replaced by the table. Once this method has been run, the range will contain the table. The range must not already be in a table.

NbRows

number of rows in the table,

NbColumns

number of columns in the table.

 

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 TBL_ADD NbLines NbColumns ReturnCode

Parameters

NbLines

NUM_BIN_4 type (input parameter)

NbColumns

NUM_BIN_4 type (input parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

 

 

Completes the portion set by the row and column numbers for the first table in the current range with the specified variable or table. In the case of a table, the first NbValues values will be used in a loop to complete the table. If the parameter is not an Adelia table, the NbValues field must be set to 1. The cells will be filled moving from left to right and from top to bottom. With numerical types, values will be formatted using the specified numerical format, if any. For example, the numerical format "$#,##0.00" applied to the 4455.7 value gives "$4,455.70".

 

Specify the string following the switch (\#) as the numerical format.

For more information on using the numerical format, consult the "numeric picture switches" topic in the Word help file.

 

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 TBL_SET_VALUE NumRowCell1 NumColCell1 NumRowCell2 NumColCell2 Value NbValues NumericalFormat ReturnCode

Parameters

NumRowCell1

NUM_BIN_4 type (input parameter)

NumColCell1

NUM_BIN_4 type (input parameter)

NumRowCell2

NUM_BIN_4 type (input parameter)

NumColCell2

NUM_BIN_4 type (input parameter)

Value

Variable or table with the following valid types: NUM_BIN_2, NUM_BIN_4, ALPHA(any n), NUM_E, NUM_P, DATE, TIME, TIMESTAMP (input parameter)

NbValues

NUM_BIN_4 type (input parameter)

NumericalFormat

ALPHA(250) (input parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

 

 

Sorts the first table in the current range according to the specified criteria and columns. Up to three columns can be used as sorting keys. The column type and sorting criterion can be specified for each column. If only one column is used as a sorting key, the parameters concerning the first column must be set.

ExcludeHeader

specifies whether or not the table's heading row is to be excluded from the sorting procedure. If the table has no heading, you must set this parameter to *FALSE,

NumCol1

number of the first column used as a sorting key,

TypeCol1

column type of the first column used as a sorting key,

SortType1

direction in which the first column used as a sorting key is to be sorted,

NumCol2

number of the second column used as a sorting key,

TypeCol2

column type of the second column used as a sorting key,

SortType2

direction in which the second column used as a sorting key is to be sorted,

NumCol3

number of the third column used as a sorting key,

TypeCol3

column type of the third column used as a sorting key,

SortType3

direction in which the third column used as a sorting key is to be sorted,

CaseSensitive

specifies whether or not the sorting procedure is to take character case into account.

 

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 TBL_SORT ExcludeHeader NumCol1 TypeCol1 SortType1 NumCol2 TypeCol2 SortType2 NumCol3 TypeCol3 SortType3 CaseSensitive ReturnCode

Parameters

ExcludeHeader

BOOL type (input parameter)

NumCol1

NUM_BIN_4 type (input parameter)

TypeCol1

NUM_BIN_4 type (input parameter)

_WRD_SORT_FIELD_NONE

the column is not a sorting criterion,

_WRD_SORT_FIELD_NUMERIC

the column contains numerical values,

_WRD_SORT_FIELD_ALPHANUMERIC

the column contains alphanumerical values,

_WRD_SORT_FIELD_DATE

the column contains dates.

SortType1

NUM_BIN_4 type (input parameter)

_WRD_SORT_ORDER_NONE

the column is not a sorting criterion,

_WRD_SORT_ORDER_ASCENDING

sorted in ascending order,

_WRD_SORT_ORDER_DESCENDING

sorted in descending order.

NumCol2

NUM_BIN_4 type (input parameter)

TypeCol2

NUM_BIN_4 type (input parameter)

_WRD_SORT_FIELD_NONE

the column is not a sorting criterion,

_WRD_SORT_FIELD_NUMERIC

the column contains numerical values,

_WRD_SORT_FIELD_ALPHANUMERIC

the column contains alphanumerical values,

_WRD_SORT_FIELD_DATE

the column contains dates.

SortType2

NUM_BIN_4 type (input parameter)

_WRD_SORT_ORDER_NONE

the column is not a sorting criterion,

_WRD_SORT_ORDER_ASCENDING

sorted in ascending order,

_WRD_SORT_ORDER_DESCENDING

sorted in descending order.

NumCol3

NUM_BIN_4 type (input parameter)

TypeCol3

NUM_BIN_4 type (input parameter)

_WRD_SORT_FIELD_NONE

the column is not a sorting criterion,

_WRD_SORT_FIELD_NUMERIC

the column contains numerical values,

_WRD_SORT_FIELD_ALPHANUMERIC

the column contains alphanumerical values,

_WRD_SORT_FIELD_DATE

the column contains dates.

SortType3

NUM_BIN_4 type (input parameter)

_WRD_SORT_ORDER_NONE

the column is not a sorting criterion,

_WRD_SORT_ORDER_ASCENDING

sorted in ascending order,

_WRD_SORT_ORDER_DESCENDING

sorted in descending order.

CaseSensitive

BOOL type (input parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

 

 

 

 

 

 

 

↑ Top of page