Methods of the WORD CLIENT Object - Prefix APP

APP_BKGRND_PRINTING_COUNT

Returns the number of print jobs in the background printing job queue.

Syntax

CALL_METHOD NameWordClientObject APP_BKGRND_PRINTING_COUNT NbPrintJobs ReturnCode

Parameters

NbPrintJobs

NUM_BIN_4 type (output parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

Possible values:

0	Method run successfully.
Other	Method failed.

APP_BKGRND_SAVING_COUNT

Returns the number of files which have to be saved in the background.

Syntax

CALL_METHOD NameWordClientObject APP_BKGRND_SAVING_COUNT NbBackups ReturnCode

Parameters

NbBackups

NUM_BIN_4 type (output parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

Possible values:

0	Method run successfully.
Other	Method failed.

APP_CONNECT

Connects the Visual Adelia application to the Microsoft Word application.

If Microsoft Word is not already running on the workstation, it will be started but remain unseen.

If the Visual Adelia application is already connected, nothing will be done.

The WordStarted parameter will be set to *TRUE if Microsoft Word is already running, otherwise it will be set to *FALSE. This parameter can be used to close (or leave running) the Microsoft Word application when the Visual Adelia application is closed.

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 APP_CONNECT WordStarted ReturnCode

Parameters

WordStarted

BOOL type (output parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

Possible values:

0	Method run successfully.
Other	Method failed.

APP_CONNECT_EX

Connects the Visual Adelia application to the Microsoft Word application.

If the NewWordApp parameter is set to *TRUE, a new Microsoft Word process is run and the Visual Adelia application connects to this new process.

If the NewWordApp parameter is set to *FALSE, the Visual Adelia application connects either to the Microsoft Word application running on the workstation, if there is one, or else to a new Microsoft Word process.

If Microsoft Word is not already running on the workstation, it will be started but remain unseen.

The WordStarted parameter will be set to *TRUE if the Microsoft Word process to which the Visual Adelia application connects is already running, otherwise it will be set to *FALSE. This parameter can be used to close (or leave running) the Microsoft Word application when the Visual Adelia application is closed.

If the Visual Adelia application is already connected, no action is taken, and the WordStarted parameter is set to *TRUE.

Syntax

CALL_METHOD NameWordClientObject APP_CONNECT_EX NewWordApp WordStarted ReturnCode

Parameters

NewWordApp

BOOL type (input parameter)

WordStarted

BOOL type (output parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

Possible values:

0	Method run successfully.
Other	Method failed.

APP_DISCONNECT

Disconnects the Visual Adelia application from the Microsoft Word application.

If Microsoft Word is only used via method calls from the Visual Adelia application, it will be stopped.

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

Parameters

ReturnCode

NUM_BIN_4 type (output parameter)

Possible values:

0	Method run successfully.
Other	Method failed.

APP_DISPLAY_ALERTS

Instructs the Microsoft Word application whether or not to display warning or error messages in response to certain method calls.

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 APP_DISPLAY_ALERTS AlertType ReturnCode

Parameters

AlertType

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_ALERTS_NONE	No alert displayed.
_WRD_ALERTS_ALL	Warning and error messages displayed.
_WRD_ALERTS_MESSAGE_BOX	Warning messages displayed.

ReturnCode

NUM_BIN_ type 4 (output parameter)

Possible values:

0	Method run successfully.
Other	Method failed.

Note: This method, used with the parameter _WRD_ALERTS_ALL, is useful during the fine tuning phase, in order to obtain a clear description of the error.

APP_ENABLE_SCREEN_UPDATING

Specifies whether or not Microsoft Word can update its display, depending on the value of the ScreenUpdatingEnabled parameter.

Syntax
CALL_METHOD NameWordClientObject APP_ENABLE_SCREEN_UPDATING ScreenUpdatingEnabled ReturnCode
Parameters
ScreenUpdatingEnabled	BOOL type (input parameter)
ReturnCode	NUM_BIN_4 type (output parameter)

Note: This method can be useful if you want to freeze the display in order to save time while running a series of methods.

APP_RUN_MACRO

Runs a macro in the active document. This macro can be defined in the document or in the document model.

Syntax

CALL_METHOD NameWordClientObject APP_RUN_MACRO MacroName ReturnCode

Parameters

MacroName

ALPHA(250) type (input parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

Possible values:

0	Method run successfully.
Other	Method failed.

APP_GET_ACTIVE_PRINTER

Retrieves the active printer that is used for printing a document.

Syntax

CALL_METHOD NameWordClientObject APP_GET_ACTIVE_PRINTER PrinterName ReturnCode

Parameters

PrinterName

ALPHA(100) type (output parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

Possible values:

0	Method run successfully.
Other	Method failed.

APP_GET_OPTION

Retrieves the value of an option defined in the Microsoft Word application. The value appears in the dialog box opened via the "Options" option from the "Tools" menu.

Option	option, the value of which is to be retrieved.
Value	value of the option.

Syntax

CALL_METHOD NameWordClientObject APP_GET_OPTION Option Value ReturnCode

Parameters

Option

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_CHECK_SPELLING_AS_YOU_TYPE	BOOL	Indicates if Word checks spelling and automatically signals any errors as the user enters data.
_WRD_CHECK_GRAMMAR_AS_YOU_TYPE	BOOL	Indicates if Word checks grammar and automatically signals any errors as the user enters data.
_WRD_CHECK_GRAMMAR_WITH_SPELLING	BOOL	Indicates if Word checks grammar at the same time as spelling. The check procedure has been executed using the "Spelling and Grammar" option from the "Tools" menu.

Value

The type depends on the option (output parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

Possible values:

_WRD_ERR_OK	Method run successfully.
_WRD_ERR_EXEC	Method failed.
_WRD_ERR_TYPE	Value does not have the right Adelia type.
_WRD_ERR_PARAM	Option has an incorrect value.

Example >>

APP_QUIT

Closes the Microsoft Word application, possibly saving any unsaved documents.

ManageChanges	action to be performed for any unsaved modifications,
SaveFormat	indicates the format used to save a document not originally in the Microsoft Word 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 APP_QUIT ManageChanges SaveFormat ReturnCode

Parameters

ManageChanges

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_DO_NOT_SAVE_CHANGES	modifications not saved,
_WRD_PROMPT_TO_SAVE_CHANGES	Microsoft Word will ask the user if he wishes to save the modifications,
_WRD_SAVE_CHANGES	any modifications will be saved.

SaveFormat

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_WORD_DOCUMENT	the document will be saved in the Microsoft Word format,
_WRD_ORIGINAL_DOCUMENT_FORMAT	the document will be saved in its original format,
_WRD_PROMPT_USER	Microsoft Word will ask the user what the save format will be.

ReturnCode

NUM_BIN_4 type (output parameter)

Possible values:

0	Method run successfully.
Other	Method failed.

APP_SET_ACTIVE_PRINTER

Sets the active printer that is used for printing a document.

Syntax

CALL_METHOD NameWordClientObject APP_SET_ACTIVE_PRINTER PrinterName ReturnCode

Parameters

PrinterName

ALPHA(100) type (input parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

Possible values:

0	Method run successfully.
Other	Method failed.

APP_SET_OPTION

Sets an option in the Microsoft Word application. This corresponds to a choice made in the dialog box displayed via the "Options" option from the "Tools" menu.

Option	option, the value of which is to be set.
Value	new value of the option.

Syntax

CALL_METHOD NameWordClientObject APP_SET_OPTION Option Value ReturnCode

Parameters

Option

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_CHECK_SPELLING_AS_YOU_TYPE	BOOL	Word will check spelling and will automatically signal any errors as the user enters data. To display errors, the DOC_SET_OPTION method has to be used on the document concerned.
_WRD_CHECK_GRAMMAR_AS_YOU_TYPE	BOOL	Word will check grammar and will automatically signal any errors as the user enters data. To display errors, the DOC_SET_OPTION method has to be used on the document concerned.
_WRD_CHECK_GRAMMAR_WITH_SPELLING	BOOL	Word will check grammar at the same time as spelling. The check procedure has been executed using the "Spelling and Grammar" option from the "Tools" menu.

Value

The type depends on the option (input parameter)

Possible values:

_WRD_ERR_OK	Method run successfully.
_WRD_ERR_EXEC	Method failed.
_WRD_ERR_TYPE	Value does not have the right Adelia type.
_WRD_ERR_PARAM	Option has an incorrect value.

Example >>

APP_SET_VISIBLE

Sets the visibility of the Microsoft Word application according to the value of the Visibility parameter.

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. Microsoft Word does not become the active application when it is made visible.

Syntax

CALL_METHOD NameWordClientObject APP_SET_VISIBLE Visibility ReturnCode

Parameters

Visibility

BOOL type (input parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

Possible values:

0	Method run successfully.
Other	Method failed.