SAP Help Home SAP Intelligent RPA Help Portal SAP Intelligent RPA Community

Table of Contents

Enumerations
Error
Application
Workbook
Worksheet
Pivot Table
Excel Helper
Without Excel Application

Module - Enumerations

Collection of the MS Excel constants.

Enumerations

XlHAlign

Enumeration to define the horizontal alignment in Excel.

Type:

number

Parameters:

Name Description
xlHAlignCenter Center.
xlHAlignCenterAcrossSelection Center across selection.
xlHAlignFill Fill.
xlHAlignGeneral General.
xlHAlignJustify Justify.
xlHAlignLeft Left.
xlHAlignRight Right.

XlUnderlineStyle

Enumeration to define the underline style in Excel.

Type:

number

Parameters:

Name Description
xlUnderlineStyleDouble Double thick underline.
xlUnderlineStyleDoubleAccounting Two thin underlines placed close together.
xlUnderlineStyleNone No underline.
xlUnderlineStyleSingle Single underline.

color.rgb

Predefined color collection in Excel represented by RGB array.

Type:

number

Parameters:

Name Description
xlColorIndexNone No color. Only applicable on Format Background Color activity.
xlColorIndexAutomatic Automatic color. Only applicable on Format Font Color activity.
aqua Aqua.
black Black.
blue Blue.
blueGray Blue gray.
brightGreen Bright green.
brown Brown.
cyan Cyan.
darkBlue Dark blue.
darkGreen Dark green.
darkRed Dark red.
darkTeal Dark teal.
darkYellow Dark yellow.
gold Gold.
gray25 Gray25.
gray50 Gray50.
gray75 Gray75.
green Green.
indigo Indigo.
lavender Lavender.
lightBlue Light blue.
lightGreen Light green.
lightOrange Light orange.
lightTurquoise Light turquoise.
lightYellow Light yellow.
lime Lime.
magenta Magenta.
oliveGreen Olive green.
orange Orange.
paleBlue Pale blue.
pink Pink.
plum Plum.
red Red.
rose Rose.
seaGreen Sea green.
skyBlue Sky blue.
tan Tan.
teal Teal.
violet Violet.
white White.
yellow Yellow.

listDirection

Enumeration to define the direction when the provided value is a simple list (one dimension array) of data.

Type:

number

Parameters:

Name Description
vertical The different items of the list will be written vertically in the excel worksheet.
horizontal The different items of the list will be written horizontally in the excel worksheet.

moveDirection

Enumeration to define the direction and the position of an active cell. Useful when this activity is used multiple times.

Type:

number

Parameters:

Name Description
vertical If you call PushValues multiple times, the active cell moves by keeping the same column coordinate. Only the row coordinate increases.
horizontal If you call PushValues multiple times, the active cell moves by keeping the same row coordinate. Only the column coordinate increases.

columnType

Enumeration to define if the column coordinate should be manipulated as a string or as a number.

Type:

number

Parameters:

Name Description
string The coordinate of the columns are string characters like 'F', 'HI', 'ABC'.
number The coordinate of the columns are number like '5', '45', '123'.

XlDirection

Enumeration to define a direction in the Excel worksheet.

Type:

number

Parameters:

Name Description
xlDown Go down.
xlToLeft Go to the left.
xlToRight Go to the right.
xlUp Go up.

XlVerticalDirection

Enumeration to define a vertical direction in the Excel worksheet.

Type:

number

Parameters:

Name Description
xlDown Go down.
xlUp Go up.

XlHorizontalDirection

Enumeration to define an horizontal direction in the Excel worksheet.

Type:

number

Parameters:

Name Description
xlToLeft Go to the left.
xlToRight Go to the right.

XlSheetVisibility

Enumeration to define the visibility of an Excel worksheet.

Type:

number

Parameters:

Name Description
xlSheetVisible The worksheet is visible.
xlSheetHidden The worksheet is hidden.
xlSheetVeryHidden The worksheet is hidden programmatically. The user cannot set the worksheet as visible in the Excel interface.

visibilitySelection

Enumeration to identify worksheets in the workbook based on their visibility.

Type:

string

Parameters:

Name Description
allWorksheets Select all the worksheets.
onlyVisibleWorksheets Select only the worksheets if they are visible.
onlyHiddenWorksheets Select only the worksheets if they are hidden.
onlyVeryHiddenWorksheets Select only the worksheets if they are very hidden.

worksheetMoveType

Enumeration to define a type of worksheet move. Useful for the Move Worksheet activity.

Type:

string

Parameters:

Name Description
firstPosition Move to the first position of the workbook.
lastPosition Move to the last position of the workbook.
leftWorksheet Move to the position just to the left of the reference worksheet.
rightWorksheet Move to the position just to the right of the reference worksheet.

getFormat

Enumeration to define the format of the output of the Get Values activity.

Type:

string

Parameters:

Name Description
standard A unique value is returned in case of unique cell range, otherwise a 2-D array is returned.
reduceToList A unique value is returned in case of unique cell range, a 1-D array is return for single row or single column range and otherwise a 2-D dimension is returned.
objectsHeadersOnFirstRow Return a list of objects. The properties of the objects are determined by the headers of the first row of the range.
objectsNoHeaders Return a list of objects. Properties of the objects are generated automatically with col1, col2, col3 based on the position in the worksheet.

updateLinkChoices

Enumeration to define whether or not to update links, or ask when opening a workbook.

Type:

number

Parameters:

Name Description
updateLinks Update links
dontUpdateLinks Don't update links
interactivePopup Display interactive popup

dateFormats

Enumeration to define the possible formats for returning a date read from excel

Type:

string

Parameters:

Name Description
object JavaScript date object
isoString ISO string, such as yyyy-mm-ddT00:00:000Z
localeDateString String dependent on local format

saveAsFormat

Enumeration to define the format of the file about the "Save As" activity.

Type:

number

Parameters:

Name Description
excelDefault The format of a new file is determined by the version of Excel being used. For an existing file, the default format is the last one used for the file.
csvUtf8 Export the current worksheet as CSV format.

exportAsFormat

Enumeration to define the format of the output of the getValues activity.

Type:

number

Parameters:

Name Description
pdf Export the current workbook as PDF format.
xps Export the current workbook as PDF XPS.

XlSortOrder

Specifies the sorting order for the specified range.

Type:

number

Parameters:

Name Description
xlAscending Sort in ascending order.
xlDescending Sort in descending order.

XlAutoFilterOperator

Specifies the operator to use in case of filtering.

Type:

number

Parameters:

Name Description
xlAnd Logical And
xlFilterValues The criteria contain simple value to perform the filtering.
xlOr Logical Or