Version

xamSpreadsheet - Replay-Only Actions

Topic Overview

Purpose

This topic provides information about replay-only actions for testing the XamSpreadsheet control.

XamSpreadsheet Replay-only Actions

GetCellData

Description

Returns data for the identified cell.

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sCellArg

String identifier for the cell.

oeValueType

Optional parameter string, integer index or enumerated value representing the type of data retrieved, the default is its value.

Possible exceptions

The possible exceptions to this action and the likely reason causing it is:

Object [Workbook] is null or has been disposed.

The following SpreadsheetCell [sCellArg ] was not found.

The option supplied is not one of the valid options, valid options are [ sshtCellTypeValue , sshtCellTypeFormula , sshtCellTypeText ]

ActivateCell

Description

Activate the identified cell

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sCellArg

String identifier for the cell.

Possible exceptions

The possible exceptions to this action and the likely reason causing it is:

  • Object [Workbook] is null or has been disposed.

  • The following SpreadsheetCell [sCellArg ] was not found.

CellEnterEditMode

Description

Puts the identified cell into edit mode

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sCellArg

String identifier for the cell.

bClearFirst

Optional boolean parameter, of if the cell value should be cleared first.

Possible exceptions

The possible exceptions to this action and the likely reason causing it is:

Object [Workbook] is null or has been disposed.

The following SpreadsheetCell [sCe*llArg* ] was not found.

CellExitEditMode

Description

If an editor is in editmode, exit edit mode by the supplied mode

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

oeEditType

Optional string, integer index or enumerated value representing who the value should be applied to the selected cells, default behavior is to only update the current cell.

Possible exceptions

The only possible exception to this action and the likely reason causing it is:

The option supplied is not one of the valid options, valid options are [ sshtUpdateSelectedCells , sshtCreateArrayFormula , sshtUpdateActiveCellOnly , sshtDiscardChanges ]

AppendCellText

Description

Appends the supplied text to the cell currently in edit mode

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sAddedText

String of text to add to the current cell.

Possible exceptions

None

Related Content

Topics

The following topics provide additional information related to this topic.

Topic Purpose

This topic provides information about the recordable user actions for testing the XamSpreadsheet™ control.

This topic provides reference information about the xamSpreadsheet’s custom properties embedded to objects of the identified types via the Control Property Access methods.

This topic provides reference information about the XamSpreadsheet™ control’s test object properties.

This topic provides reference material on the common enumerations used for testing the XamSpreadsheet™ control.