Properties of the EXCEL CLIENT Object

Important: these properties are event parameters; they are only accessible in execution mode, and only have a meaning once the event has occurred.

ACTIVATED_SHEET_NAME

Concerns the SheetActivation event.

Contains the name of the sheet activated by the user in Microsoft Excel.

Adelia type	ALPHA(50).
Accessibility	Read only.
Example	Sales balance for 2017.

Note: This property is not implemented by the Cloud generator.

ACTIVATED_WORKBOOK_NAME

Concerns the WorkbookActivation event.

Contains the name of the workbook activated in Microsoft Excel.

Adelia type	ALPHA(260).
Accessibility	Read only.
Example	d:\doc\Workbook3.xls.

Note: This property is not implemented by the Cloud generator.

CALCULATED_SHEET_NAME

Concerns the SheetCalculation event.

Contains the name of the sheet for which a cell range has been calculated in Microsoft Excel.

Adelia type	ALPHA(50).
Accessibility	Read only.
Example	Sales balance for 2017.

Note: This property is not implemented by the Cloud generator.

CLOSED_WORKBOOK_NAME

Concerns the WorkbookClosing event.

Contains the name of the workbook that the user wants to close in Microsoft Excel.

Adelia type	ALPHA(260).
Accessibility	Read only.
Example	d:\doc\Workbook3.xls.

Note: This property is not implemented by the Cloud generator.

DEACTIVATED_SHEET_NAME

Concerns the SheetDeactivation event.

Contains the name of the Microsoft Excel sheet deactivated by the user.

Adelia type	ALPHA(50).
Accessibility	Read only.
Example	Sales balance for 2017.

Note: This property is not implemented by the Cloud generator.

DEACTIVATED_WORKBOOK_NAME

Concerns the WorkbookDeactivation event.

Contains the name of the workbook deactivated in Microsoft Excel.

Adelia type	ALPHA(260).
Accessibility	Read only.
Example	d:\doc\Workbook3.xls.

Note: This property is not implemented by the Cloud generator.

GRANTED_CLOSING

Concerns the WorkbookClosing event.

Used to set whether or not the Microsoft Excel workbook can be closed.

Adelia type	BOOL.
Accessibility	Write only.
Default value	"*TRUE".

Note: This property is not implemented by the Cloud generator.

GRANTED_PRINTING

Concerns the WorkbookPrinting event.

Used to set whether or not the Microsoft Excel workbook can be printed.

Adelia type	BOOL.
Accessibility	Write only.
Default value	"*TRUE".

Note: This property is not implemented by the Cloud generator.

GRANTED_SAVING

Concerns the WorkbookSaving event.

Used to set whether or not the Microsoft Excel workbook can be saved.

Adelia type	BOOL.
Accessibility	Read only.
Example	"*TRUE".

Note: This property is not implemented by the Cloud generator.

MODIFIED_RANGE

Concerns the SheetModification event.

Contains the range of cells possibly modified by the user in Microsoft Excel.

Adelia type	ALPHA(200).
Accessibility	Read only.
Example	'[Balance2017.xls]Sales balance for 2017'!$B$6.

Note: This property is not implemented by the Cloud generator.

MODIFIED_SHEET_NAME

Concerns the SheetModification event.

Contains the name of the Microsoft Excel sheet modified by the user.

Adelia type	ALPHA(50).
Accessibility	Read only.
Example	Sales balance for 2017.

Note: This property is not implemented by the Cloud generator.

NAME

Static name of the object.

Adelia type	ALPHA(128).
Accessibility
Layout design mode	Read/Write.
Execution mode	Read.
Associated constants	None.
Conditions for use	None.
Default value	Prefix of the basic object.

NEW_SHEET_NAME

Concerns the NewSheet event.

Contains the name of the new sheet that the user has added in Microsoft Excel.

Adelia type	ALPHA(50).
Accessibility	Read only.
Example	Worksheet4.

Note: This property is not implemented by the Cloud generator.

NEW_SHEET_WORKBOOK_NAME

Concerns the NewSheet event.

Contains the name of the workbook to which the user has added a sheet in Microsoft Excel.

Adelia type	ALPHA(260).
Accessibility	Read only.
Example	d:\doc\Workbook3.xls.

Note: This property is not implemented by the Cloud generator.

NEW_WORKBOOK_NAME

Concerns the NewWorkbook event.

Contains the name of the new workbook created in Microsoft Excel.

Adelia type	ALPHA(50).
Accessibility	Read only.
Example	Workbook2.

Note: This property is not implemented by the Cloud generator.

OPENED_WORKBOOK_NAME

Concerns the WorkbookOpening event.

Contains the name of the workbook opened in Microsoft Excel.

Adelia type	ALPHA(260).
Accessibility	Read only.
Example	d:\doc\Workbook3.xls.

Note: This property is not implemented by the Cloud generator.

PRINTED_WORKBOOK_NAME

Concerns the WorkbookPrinting event.

Contains the name of the workbook that the user wants to print in Microsoft Excel.

Adelia type	ALPHA(260).
Accessibility	Read only.
Example	d:\doc\Workbook3.xls.

Note: This property is not implemented by the Cloud generator.

RANGE_DOUBLE_CLICK

Concerns the LeftButtonDoubleClick event.

Contains the cell over which the user has double-clicked in Microsoft Excel.

Adelia type	ALPHA(200).
Accessibility	Read only.
Example	'[Balance2017.xls]Sales balance for 2017'!$B$6.

Note: This property is not implemented by the Cloud generator.

RANGE_RIGHT_CLICK

Concerns the RightButtonClick event.

Contains the range of cells over which the user has clicked the right mouse button in Microsoft Excel.

Adelia type	ALPHA(200).
Accessibility	Read only.
Example	'[Balance2017.xls]Sales balance for 2017'!$B$6:$E$11.

Note: This property is not implemented by the Cloud generator.

SAVED_WORKBOOK_NAME

Concerns the WorkbookSaving event.

Contains the name of the workbook that the user wants to save in Microsoft Excel.

Adelia type	ALPHA(260).
Accessibility	Read only.
Example	d:\doc\Workbook3.xls.

Note: This property is not implemented by the Cloud generator.

SELECTION_CHANGE_SHEET_NAME

Concerns the ChangeSelection event.

Contains the name of the sheet in which the user has modified the selected range.

Adelia type	ALPHA(50).
Accessibility	Read only.
Example	Sales balance for 2017.

Note: This property is not implemented by the Cloud generator.

SELECTION_CHANGE_RANGE

Concerns the ChangeSelection event.

Contains the range of cells selected by the user in Microsoft Excel.

Adelia type	ALPHA(200).
Accessibility	Read only.
Example	'[Balance2017.xls]Sales balance for 2017'!$B$6:$E$11.

Notes:

Where the name of the file (or worksheet) contains a space, it must be entered between apostrophes: '[Balance2017.xls]Sales balance for 2017'.

This property is not implemented by the Cloud generator.

SHEET_NAME_DOUBLE_CLICK

Concerns the LeftButtonDoubleClick event.

Contains the name of the sheet over which the user has double-clicked the left mouse button.

Adelia type	ALPHA(50).
Accessibility	Read only.
Example	Sales balance for 2017.

Note: This property is not implemented by the Cloud generator.

SHEET_NAME_RIGHT_CLICK

Concerns the RightButtonClick event.

Contains the name of the sheet over which the user has clicked the right mouse button.

Adelia type	ALPHA(50).
Accessibility	Read only.
Example	Sales balance for 2017.

Note: This property is not implemented by the Cloud generator.

WORKBOOK_TO_SAVE

Concerns the WorkbookSaving event.

Indicates whether or not the Save As dialog box must be opened in Microsoft Excel (true if the workbook has never been saved).

Adelia type	BOOL.
Accessibility	Read only.

Note: This property is not implemented by the Cloud generator.