Macro command functions

[ ] indicates optional parameters

ABSREF(ref_text, reference)
ACTIVATE([window_text], [pane_num])
ACTIVATE.NEXT([workbook_text])
ACTIVATE.PREV([workbook_text])
ACTIVE.CELL()
ALERT(message_text, [type_num], [help_ref])
ALIGNMENT([horiz_align], [wrap], [vert_align], [orientation], [add_indent])
ASSIGN.TO.OBJECT([macro_ref])
ATTACH.TEXT(attach_to_num, [series_num], [point_num])
AXES([x_primary], [y_primary], [x_secondary], [y_secondary])
BEEP([tone_num])
BORDER([outline], [left], [right], [top], [bottom], [shade], [outline_color], [left_color], [right_color], [top_color], [bottom_color])
BRING.TO.FRONT()
CALCULATE.DOCUMENT()
CALCULATE.NOW()
CALLER()
CANCEL.KEY(enable_logical, [macro_ref])
CELL.PROTECTION([locked], [hidden])
CHECKBOX.PROPERTIES([value], [link], [accel_text], [accel_text2], [3d_shading])
CLEAR([type_num])
COLOR.PALETTE(file_text)
COLUMN.WIDTH([width_num], [reference], [standard], [type_num], [standard_num])
COPY([from_reference], [to_reference])
CREATE.OBJECT(obj_type, ref1, [x_offset1], [y_offset1], ref2, [x_offset2], [y_offset2], [text], [fill], [editable])
CREATE.OBJECT(obj_type, ref1, [x_offset1], [y_offset1], ref2, [x_offset2], [y_offset2], array, [fill])
CUT([from_reference], [to_reference])
DATA.FORM()
DATA.LABEL([show_option], [auto_text], [show_key])
DATA.SERIES([rowcol], [type_num], [date_num], [step_value], [stop_value], [trend])
DEFINE.NAME(name_text, [refers_to], [macro_type], [shortcut_text], [hidden], [category], [local])
DELETE.FORMAT(format_text)
DELETE.NAME(name_text)
DEREF(reference)
DIRECTORY([path_text])
DOCUMENTS([type_num], [match_text])
DUPLICATE()
ECHO([logical])
EDIT.COLOR(color_num, [red_value], [green_value], [blue_value])
EDIT.DELETE([shift_num])
EDIT.SERIES([series_num], [name_ref], [x_ref], [y_ref], [z_ref], [plot_order])
ENABLE.OBJECT([object_id], [enable_logical])
ERROR(enable_logical, [macro_ref])
EVALUATE(formula_text)
EXEC(program_text, [window_num])
EXTEND.POLYGON(array)
FCLOSE(file_num)
FILE.CLOSE([save_logical], [route_logical])
FILE.DELETE(file_text)
FILES([directory_text])
FILL.DOWN()
FILL.LEFT()
FILL.RIGHT()
FILL.UP()
FILTER([field_num], [criteria1], [operation], [criteria2])
FILTER.ADVANCED(operation, list_ref, [criteria_ref], [copy_ref], [unique])
FILTER.SHOW.ALL()
FONT.PROPERTIES([font], [font_style], [size], [strikethrough], [superscript], [subscript], [outline], [shadow], [underline], [color], [normal], [background], [start_char], [char_count])
FOPEN(file_text, [access_num])
FORMAT.LEGEND(position_num)
FORMAT.MOVE([x_offset], [y_offset], [reference])
FORMAT.NUMBER(format_text)
FORMAT.SHAPE(vertex_num, insert, [reference], [x_offset], [y_offset])
FORMAT.TEXT([x_align], [y_align], [orient_num], [auto_text], [auto_size], [show_key], [show_value], [add_indent])
FORMULA(formula_text, [reference])
FORMULA.ARRAY(formula_text, [reference])
FORMULA.CONVERT(formula_text, from_a1, [to_a1], [to_ref_type], [rel_to_ref])
FORMULA.FILL(formula_text, [reference])
FORMULA.FIND(text, in_num, at_num, by_num, [dir_num], [match_case])
FORMULA.FIND.NEXT()
FORMULA.FIND.PREV()
FORMULA.GOTO([reference], [corner])
FORMULA.REPLACE(find_text, replace_text, [look_at], [look_by], [active_cell], [match_case])
FPOS(file_num, [position_num])
FREAD(file_num, num_chars)
FREADLN(file_num)
FREEZE.PANES([logical], [col_split], [row_split])
FSIZE(file_num)
FULL.SCREEN([logical])
FWRITE(file_num, text)
FWRITELN(file_num, text)
GALLERY.AREA(type_num, [delete_overlay])
GALLERY.BAR(type_num, [delete_overlay])
GALLERY.COLUMN(type_num, [delete_overlay])
GALLERY.DOUGHNUT(type_num, [delete_overlay])
GALLERY.LINE(type_num, [delete_overlay])
GALLERY.PIE(type_num, [delete_overlay])
GALLERY.RADAR(type_num, [delete_overlay])
GALLERY.SCATTER(type_num, [delete_overlay])
GET.CELL(type_num, [reference])
GET.DOCUMENT(type_num, [name_text])
GET.FORMULA(reference)
GET.NAME(name_text, [info_type])
GET.NOTE([cell_ref], [start_char], [num_chars])
GET.OBJECT(type_num, [object_id], [start_num], [count_num], [item_index])
GET.WINDOW(type_num, [window_text])
GET.WORKBOOK(type_num, [name_text])
GET.WORKSPACE(type_num)
GOAL.SEEK(target_cell, target_value, variable_cell)
GRIDLINES([x_major], [x_minor], [y_major], [y_minor], [z_major], [z_minor], [2D_effect])
HIDE.OBJECT([object_id], [hide_logical])
HLINE([num_columns])
HPAGE([num_windows])
HSCROLL(position, [col_logical])
INPUT(message_text, [type_num], [title_text], [default], [x_pos], [y_pos], [help_ref])
INSERT([shift_num])
INSERT.TITLE([chart], [y_primary], [x_primary], [y_secondary], [x_secondary])
LABEL.PROPERTIES([accel_text], [accel_text2], [3d_shading])
LEGEND([logical])
LISTBOX.PROPERTIES([range], [link], [drop_size], [multi_select], [3d_shading])
MESSAGE(logical, [text])
NAMES([document_text], [type_num], [match_text])
NEW([type_num], [xy_series], [add_logical])
NOTE([add_text], [cell_ref], [start_char], [num_chars])
OBJECT.PROPERTIES([placement_type], [print_object])
ON.DOUBLECLICK([sheet_text], [macro_text])
ON.ENTRY([sheet_text], [macro_text])
ON.SHEET([sheet_text], [macro_text], [activate_logical])
OPEN(file_text, [update_links], [read_only], [format], [prot_pwd], [write_res_pwd], [ignore_rorec], [file_origin], [custom_delimit], [add_logical], [editable], [file_access], [notify_logical], [converter])
OPEN.DIALOG([file_filter], [button_text], [title], [filter_index])
OPTIONS.VIEW([formula], [status], [notes], [show_info], [object_num], [page_breaks], [formulas], [gridlines], [color_num], [headings], [outline], [zeros], [hor_scroll], [vert_scroll], [sheet_tabs])
PASTE([to_reference])
PASTE.SPECIAL([paste_num], [operation_num], [skip_blanks], [transpose])
PATTERNS([apattern], [afore], [aback])
PATTERNS([lauto], [lstyle], [lcolor], [lwt], [hwidth], [hlength], [htype])
PATTERNS([bauto], [bstyle], [bcolor], [bwt], [shadow], [aauto], [apattern], [afore], [aback], [rounded], [newui])
PATTERNS([bauto], [bstyle], [bcolor], [bwt], [shadow], [aauto], [apattern], [afore], [aback], [invert], [apply], [new_fill])
PATTERNS([lauto], [lstyle], [lcolor], [lwt], [mauto], [mstyle], [mfore], [mback], [apply], [smooth])
PROTECT.DOCUMENT([contents], [windows], [password], [objects], [scenarios])
QUIT()
REFTEXT(reference, [a1])
RELREF(reference, rel_to_ref)
ROW.HEIGHT([height_num], [reference], [standard_height], [type_num])
SAVE()
SAVE.AS([document_text], [type_num], [prot_pwd], [backup], [write_res_pwd], [read_only_rec])
SAVE.COPY.AS([document_text])
SAVE.DIALOG([init_filename], [title], [button_text], [file_filter], [filter_index])
SCALE([min_num], [max_num], [major], [minor], [cross], [logarithmic], [reverse], [max])
SCROLLBAR.PROPERTIES([value], [min], [max], [inc], [page], [link], [3d_shading])
SELECT([selection], [active_cell])
SELECT([object_id], [replace])
SELECT([item_text], [single_point])
SELECT.END(direction_num)
SELECT.LAST.CELL()
SELECTION()
SEND.TO.BACK()
SET.CONTROL.VALUE([value])
SHOW.ACTIVE.CELL()
SORT([orientation], [key1], [order1], [key2], [order2], [key3], [order3], [header], [custom], [case])
STANDARD.WIDTH([standard_num])
TEXT.BOX(add_text, [object_id], [start_num], [num_chars])
TEXT.TO.COLUMNS([destination_ref], [data_type], [text_delim], [consecutive_delim], [tab], [semicolon], [comma], [space], [other], [other_char], [field_info])
TEXTREF(text, [a1])
UNDO()
VLINE([num_rows])
VPAGE([num_windows])
VSCROLL(position, [row_logical])
WORKBOOK.ACTIVATE(sheet_name)
WORKBOOK.DELETE([sheet_name])
WORKBOOK.HIDE([sheet_text], [very_hidden])
WORKBOOK.INSERT([type_num])
WORKBOOK.NAME(old_sheet_name, new_sheet_name)
WORKBOOK.NEXT()
WORKBOOK.PREV()
WORKBOOK.UNHIDE([sheet_text])
ZOOM([magnification])


ABSREF(ref_text, reference)

Returns an absolute reference corresponding to an offset from another reference.

ref_textThe offset specified in R1C1 format.
referenceThe base reference.


ACTIVATE([window_text], [pane_num])

Specifies the workbook, sheet and/or pane that is to be active.

window_textThe workbook and/or sheet name. If this parameter is omitted then the active window is not changed.
pane_numFor a split window, specifies which pane is to be active. The possible values are:
1Upper or upper left.
2Upper right.
3Lower or lower left.
4Lower right.
If this parameter is omitted then the active pane is not changed.


ACTIVATE.NEXT([workbook_text])

Simulates the Ctrl+Page Down or Ctrl+Tab key combination.

workbook_textThe workbook for which the next sheet is to be selected. If this parameter is omitted then the next workbook is selected.


ACTIVATE.PREV([workbook_text])

Simulates the Ctrl+Page Up or Ctrl+Shift+Tab key combination.

workbook_textThe workbook for which the previous sheet is to be selected. If this parameter is omitted then the previous workbook is selected.


ACTIVE.CELL()

Returns a reference which represents the current position of the cursor on the active worksheet.



ALERT(message_text, [type_num], [help_ref])

Displays a message box containing the specified text. It returns TRUE if the OK button is pressed, otherwise FALSE.

message_textThe text to be displayed in the message box.
type_numThe type of message box to be displayed. The possible values are:
1A box containing a question mark icon and OK and Cancel buttons.
2A box containing an information icon and an OK button.
3A box containing an exclamation icon and an OK button.
If this parameter is omitted it defaults to 2.
help_refA reference to a Help topic (not currently implemented).


ALIGNMENT([horiz_align], [wrap], [vert_align], [orientation], [add_indent])

Simulates the Format Cells dialog Alignment page.

horiz_alignThe horizontal alignment to be used. The possible values are:
1General
2Left
3Center
4Right
5Fill
6Justify
7Center across selection
If this parameter is omitted the setting is not changed.
wrapWhether to wrap the text in the cells. The possible values are:
FALSEThe text is not wrapped
TRUEThe text is wrapped
If this parameter is omitted the setting is not changed.
vert_alignThe vertical alignment to be used. The possible values are:
1Top
2Center
3Bottom
4Justify
If this parameter is omitted the setting is not changed.
orientationThe text orientation. The possible valus are:
0Horizontal
1Vertical
2Upward
3Downward
If this parameter is omitted the setting is not changed.
add_indentNot currently implemented.


ASSIGN.TO.OBJECT([macro_ref])

Assigns a macro to an object.

macro_refThe reference of the macro to be assigned. If this parameter is omitted then any existing macro is removed.


ATTACH.TEXT(attach_to_num, [series_num], [point_num])

Attaches default text to the active chart. The SELECT and FORMULA functions can be used to change the text.

attach_to_numThe item where the default text is to be attached. The possible values are:
1Chart title
2Primary y-axis title
3Primary x-axis title
4Data label (not currently implemented)
5Secondary y-axis title (not currently implemented)
6Secondary x-axis title (not currently implemented)
series_numThe series number of the data label (not currently implemented)
point_numThe point number of the data label (not currently implemented)


AXES([x_primary], [y_primary], [x_secondary], [y_secondary])

Changes the active chart axes.

x_primaryWhether to draw the X-axis. The possible values are:
FALSEDo not draw the X-axis.
TRUEDo draw the X-axis.
If this parameter is omitted the setting is not changed.
y_primaryWhether to draw the Y-axis. The possible values are:
FALSEDo not draw the Y-axis.
TRUEDo draw the Y-axis.
If this parameter is omitted the setting is not changed.
x_secondaryWhether to draw the secondary X-axis (not currently implemented).
y_secondaryWhether to draw the secondary Y-axis (not currently implemented).


BEEP([tone_num])

Causes the computer to beep.

tone_numA number from 1 to 4 indicating which type of beep is to be produced (not currently implemented - all values will produce the same tone). If this parameter is omitted it defaults to 1.


BORDER([outline], [left], [right], [top], [bottom], [shade], [outline_color], [left_color], [right_color], [top_color], [bottom_color])

Simulates the Format Cells dialog Border page.

outlineThe border type to be applied to the outline of the selected cells. The possible values are:
0No border
1Thin
2Medium
3Dashed
4Dotted
5Thick
6Double
7Hairline
If this parameter is omitted the setting is not changed.
leftThe border type to be used for the left border of the selected cells. The possible values are the same as for the outline parameter.
If this parameter is omitted the setting is not changed.
rightThe border type to be used for the right border of the selected cells. The possible values are the same as for the outline parameter.
If this parameter is omitted the setting is not changed.
topThe border type to be used for the top border of the selected cells. The possible values are the same as for the outline parameter.
If this parameter is omitted the setting is not changed.
bottomThe border type to be used for the bottom border of the selected cells. The possible values are the same as for the outline parameter.
If this parameter is omitted the setting is not changed.
shadeNot implemented.
outline_colorThe color to be used for the outline border. The possible values are:
0Automatic
1 to 56One of the colors displayed in the Format Cells dialog Border page
If this parameter is omitted the setting is not changed.
left_colorThe color to be used for the left border. The possible values are the same as for the outline_color parameter.
If this parameter is omitted the setting is not changed.
right_colorThe color to be used for the right border. The possible values are the same as for the outline_color parameter.
If this parameter is omitted the setting is not changed.
top_colorThe color to be used for the top border. The possible values are the same as for the outline_color parameter.
If this parameter is omitted the setting is not changed.
bottom_colorThe color to be used for the bottom border. The possible values are the same as for the outline_color parameter.
If this parameter is omitted the setting is not changed.


BRING.TO.FRONT()

Changes the order of the objects on the active worksheet by moving the currently selected object to the front.



CALCULATE.DOCUMENT()

Causes the current worksheet to be recalculated.



CALCULATE.NOW()

Causes all worksheets to be recalculated.



CALLER()

Returns information about the caller of the macro.

Macro called from:Function returns:
User-defined functionreference of cell containing function call
User-defined function in array formulareference of array formula range
Attached to control or drawing objectobject identifier
Auto_Open macrofile name
Manually (control key combination)error value #REF!
ON.DOUBLECLICK macroreference of cell that was double-clicked
ON.ENTRY macroreference of cell where data was entered
ON.SHEET macroerror value #REF!


CANCEL.KEY(enable_logical, [macro_ref])

Specifies the action taken when the Escape key is pressed in a macro.

enable_logicalWhether to interrupt the macro. The possible values are:
FALSEThe macro continues
TRUEThe macro is interrupted
macro_refThe macro to be run when the Escape key is pressed (not currently implemented)


CELL.PROTECTION([locked], [hidden])

Simulates the Format Cells dialog Protection page.

lockedWhether the cell should be locked when the sheet is protected. The possible values are:
FALSEThe cell is not locked
TRUEThe cell is locked
If this parameter is omitted the setting is not changed.
hiddenWhether the cell formula should be hidden when the sheet is protected. The possible values are:
FALSEThe cell formula is not hidden
TRUEThe cell formula is hidden
If this parameter is omitted the setting is not changed.


CHECKBOX.PROPERTIES([value], [link], [accel_text], [accel_text2], [3d_shading])

Changes the properties of a check box or option button control.

valueThe value of the control. The possible values are:
FALSEUnchecked
TRUEChecked
0Unchecked
1Checked
2Mixed
If this parameter is omitted the value is not changed.
linkThe cell that is updated by the control. If this parameter is omitted the link is not changed.
accel_textThe accelerator key on a dialog sheet (not currently implemented).
accel_text2The second accelerator key on a dialog sheet (not currently implemented).
3d_shadingWhether to draw the control with 3d shading. The possible values are:
FALSE2d
TRUE3d
If this parameter is omitted the setting is not changed.


CLEAR([type_num])

Simulates the Edit Clear menu options.

type_numThe type of information to clear from the current selection on the active worksheet. The possible values are:
1Clear all
2Clear formats
3Clear contents
4Clear comments
If this parameter is omitted it defaults to 3.


COLOR.PALETTE(file_text)

Copies the color palette from another file.

file_textThe name of the file from which to copy the palette. The file must already be open. If this parameter is an empty string then the colors are reset to the default values.


COLUMN.WIDTH([width_num], [reference], [standard], [type_num], [standard_num])

Simulates the Format Column menu options.

width_numThe new width of the columns. The width is measured in characters. This parameter is ignored if standard is TRUE or type_num is specified. If this parameter is omitted the width of the specified columns is not changed.
referenceThe columns whose width is to be changed. If this parameter is omitted it defaults to the current selection on the active worksheet.
standardSpecifies whether the columns are to be set to the standard column width. The possible values are:
TRUEThe columns are set to the standard width.
FALSEThe columns are not set to the standard width.
If this parameter is omitted it defaults to FALSE.
type_numSpecifies whether the columns are to be hidden, unhidden or automatically sized. This parameter is ignored if standard is TRUE. The possible values are:
1The columns are hidden.
2The columns are unhidden.
3The columns are set to the width of the longest displayed value.
If this parameter is omitted the columns will not be hidden, unhidden or auto-sized.
standard_numSpecifies the value to be used for the standard width. The width is measured in characters. If this parameter is omitted the standard width is not changed.


COPY([from_reference], [to_reference])

Simulates the Edit Copy menu option.

from_referenceThe cells that are to be copied to the clipboard. If this parameter is omitted it defaults to the current selection on the active worksheet.
to_referenceThe cells where the copied information is to be pasted. If this parameter is omitted then the cells are not pasted.


CREATE.OBJECT(obj_type, ref1, [x_offset1], [y_offset1], ref2, [x_offset2], [y_offset2], [text], [fill], [editable])

Simulates the Insert Drawing and Insert Control menu options.

obj_typeThe type of object to be created. The possible values are:
1Line
2Rectangle
3Oval
6Text box
7Command button
11Check box
12Option button
14Label
16Spin control
17Scroll bar
18List box
19Group box
20Combo box
ref1The cell containing the top-left corner of the object.
x_offset1The offset in points of the top-left corner of the object from the left edge of the cell. If this parameter is omitted it defaults to 0.
y_offset1The offset in points of the top-left corner of the object from the top edge of the cell. If this parameter is omitted it defaults to 0.
ref2The cell containing the bottom-right corner of the object.
x_offset2The offset in points of the bottom-right corner of the object from the left edge of the cell. If this parameter is omitted it defaults to 0.
y_offset2The offset in points of the bottom-right corner of the object from the top edge of the cell. If this parameter is omitted it defaults to 0.
textThe text to be assigned to the object. If this parameter is omitted then no text is assigned.
fillSpecifies whether the object is filled or transparent (not currently implemented).
editableSpecifies whether a combo box is editable (not currently implemented).


CREATE.OBJECT(obj_type, ref1, [x_offset1], [y_offset1], ref2, [x_offset2], [y_offset2], array, [fill])

Simulates the Insert Drawing and Insert Control menu options.

obj_typeThe type of object to be created. The possible values are:
9Closed polygon
10Open polygon
ref1The cell containing the top-left corner of the object.
x_offset1The offset in points of the top-left corner of the object from the left edge of the cell. If this parameter is omitted it defaults to 0.
y_offset1The offset in points of the top-left corner of the object from the top edge of the cell. If this parameter is omitted it defaults to 0.
ref2The cell containing the bottom-right corner of the object.
x_offset2The offset in points of the bottom-right corner of the object from the left edge of the cell. If this parameter is omitted it defaults to 0.
y_offset2The offset in points of the bottom-right corner of the object from the top edge of the cell. If this parameter is omitted it defaults to 0.
arrayAn array or reference with 2 columns and at least 2 rows, containing the x and y points of the polygon.
fillSpecifies whether the object is filled or transparent (not currently implemented).


CUT([from_reference], [to_reference])

Simulates the Edit Cut menu option.

from_referenceThe cells that are to be cut to the clipboard. If this parameter is omitted it defaults to the current selection on the active worksheet.
to_referenceThe cells where the cut information is to be pasted. If this parameter is omitted then the cells are not pasted.


DATA.FORM()

Simulates the Format Data Form menu option.



DATA.LABEL([show_option], [auto_text], [show_key])

Changes the active chart data labels.

show_optionThe type of label to show. The possible values are:
1None
2Show value
3Show percent
4Show label
5Show label and percent
If this parameter is omitted the data labels are not changed.
auto_textWhether to reset the data labels (not currently implemented).
show_keyWhether to show the legend key next to the label (not currently implemented).


DATA.SERIES([rowcol], [type_num], [date_num], [step_value], [stop_value], [trend])

Simulates the Edit Fill Series menu option.

rowcolIndicates whether the series is in rows or columns. The possible values are:
1Rows
2Columns
If this parameter is omitted it defaults depending on the shape of the current selection.
type_numThe way in which the series values change. The possible values are:
1Linear
2Growth
3Date
4Auto (not currently implemented)
If this parameter is omitted it defaults to 1.
date_numThe way in which the date values change. The possible values are:
1Day
2Weekday
3Month
4Year
If this parameter is omitted it defaults to 1.
step_valueThe number used to add to or multiply by the series value. If this parameter is omitted it defaults to 1.
stop_valueThe value at which to stop filling the series. If this parameter is omitted then the entire selection is filled.
trendIndicates whether to fill the series using trend values calculated from existing data. The possible values are:
FALSEDon't use trend values.
TRUEUse trend values (not currently implemented).
If this parameter is omitted it defaults to FALSE.


DEFINE.NAME(name_text, [refers_to], [macro_type], [shortcut_text], [hidden], [category], [local])

Simulates the Insert Name Define Add menu option.

name_textA string containing the name to be defined.
refers_toThe value that is to be assigned to the name. If this parameter is omitted it defaults to a reference to the current selection on the active sheet.
macro_typeThe type of macro that this name refers to (not currently implemented).
shortcut_textThe shortcut key used to activate a command macro. If this parameter is omitted no shortcut key is assigned.
hiddenWhether the name is to be hidden in the name definition list. The possible values are:
FALSEShow the name in the list.
TRUEDo not show the name in the list.
If this parameter is omitted it defaults to FALSE.
categoryIdentifies the category of a custom function (not currently implemented).
localWhether the name is to local to the active sheet. The possible values are:
FALSEThe name is defined as global.
TRUEThe name is defined as local.
If this parameter is omitted it defaults to FALSE.


DELETE.FORMAT(format_text)

Deletes the specified custom number format. Any cells using this format will be changed to use the General format.

format_textA string containing the format to be deleted.


DELETE.NAME(name_text)

Simulates the Insert Name Define Delete menu option.

name_textA string containing the name to be deleted.


DEREF(reference)

Returns the values of cells in a reference. You should not need to use this function, as references are automatically converted to values where necessary when they are used in formulas.

referenceThe reference to the cells whose values you want.


DIRECTORY([path_text])

Returns the path of the current directory, and optionally allows you to change it.

path_textThe path to which you want to change the current directory. If this parameter is omitted the current directory is not changed. Note that in Windows CE the current directory is always the root directory and cannot be changed.


DOCUMENTS([type_num], [match_text])

Returns a horizontal array containing the names of the open files.

type_numSpecifies whether to include add-in workbooks in the list. The possible values are:
1List only open files that are not add-in workbooks.
2List only open files that are add-in workbooks.
3List all open files.
If this parameter is omitted it defaults to 1.
match_textA template name that may contain wildcard characters. If this parameter is omitted then all workbook names will be included.


DUPLICATE()

Duplicates the currently selected object.



ECHO([logical])

Controls screen updating while a macro is running.

logicalWhether to update the screen while the macro is running. The possible values are:
FALSEDo not update the screen
TRUEDo update the screen
If this parameter is omitted the setting is toggled.


EDIT.COLOR(color_num, [red_value], [green_value], [blue_value])

Changes the color associated with a specific color number.

color_numA number from 1 to 56, indicating which color is to be changed.
red_valueA number from 0 to 255, specifying the intensity of the red component. If this parameter is omitted the red component is not changed.
green_valueA number from 0 to 255, specifying the intensity of the green component. If this parameter is omitted the green component is not changed.
blue_valueA number from 0 to 255, specifying the intensity of the blue component. If this parameter is omitted the blue component is not changed.


EDIT.DELETE([shift_num])

Simulates the Edit Delete menu option.

shift_numThe way in which the cell deletion is to be processed. The possible values are:
1Shift cells left
2Shift cells up
3Delete entire rows
4Delete entire columns
If this parameter is omitted it defaults to 2.


EDIT.SERIES([series_num], [name_ref], [x_ref], [y_ref], [z_ref], [plot_order])

Adds or changes a series on the active chart.

series_numThe number of the series to be changed. If this parameter is zero or omitted then a new series is added.
name_refThe series name. If this parameter is omitted the name is not changed.
x_refThe X categories or values reference. If this parameter is omitted the reference is not changed.
y_refThe Y values reference. If this parameter is omitted the reference is not changed.
z_refThe Z values reference (not currently implemented).
plot_orderThe order of this series on the chart (not currently implemented).


ENABLE.OBJECT([object_id], [enable_logical])

Specifies whether an object should respond to mouse clicks.

object_idThe object to be enabled or disabled. If this parameter is omitted the currently selected object is used.
enable_logicalWhether the object is enabled. The possible values are:
TRUEThe object is enabled
FALSEThe object is disabled
If this parameter is omitted the setting is not changed.


ERROR(enable_logical, [macro_ref])

Specifies the action taken when an error occurs in a macro.

enable_logicalWhether to interrupt the macro. The possible values are:
FALSEThe macro continues
TRUEThe macro is interrupted
macro_refThe macro to be run when an error occurs (not currently implemented)


EVALUATE(formula_text)

Returns the result of evaluating a formula.

formula_textThe formula to be evaluated.


EXEC(program_text, [window_num])

Executes another program.

program_textThe program to be executed.
window_numThe window state for the executed program (not currently implemented). The possible values are:
1Normal
2Minimized
3Maximized
If this parameter is omitted it defaults to 2.


EXTEND.POLYGON(array)

Adds points to a polygon created by the CREATE.OBJECT function.

arrayAn array or reference with 2 columns, containing the x and y points of the polygon.


FCLOSE(file_num)

Closes a file that was previously opened by the FOPEN function.

file_numThe file number that was returned by the FOPEN function.


FILE.CLOSE([save_logical], [route_logical])

Simulates the File Close menu option.

save_logicalWhether to save a changed file before closing it. The possible values are:
FALSEDo not save the file
TRUESave the file
If this parameter is omitted then the prompt is displayed.
route_logicalWhether to route the file after closing it (not currently implemented).


FILE.DELETE(file_text)

Deletes a file.

file_textThe name of the file to be deleted.


FILES([directory_text])

Returns a horizontal array containing the names of the files in a directory.

directory_textA template name that may contain wildcard characters. If this parameter is omitted then all file names will be included.


FILL.DOWN()

Simulates the Edit Fill Down menu option.



FILL.LEFT()

Simulates the Edit Fill Left menu option.



FILL.RIGHT()

Simulates the Edit Fill Right menu option.



FILL.UP()

Simulates the Edit Fill Up menu option.



FILTER([field_num], [criteria1], [operation], [criteria2])

Simulates the Format Data Filter AutoFilter menu option.

field_numThe filter column number whose criteria are to be changed. The columns are number from left to right, with 1 being the first filtered column. If this parameter is omitted the filter is just turned on or off.
criteria1A string specifying the criteria to be used. If this parameter is omitted any filter criteria are removed from the specified column.
operationThe combination operation when multiple criteria are used. The possible values are:
1AND
2OR
If this parameter is omitted the second criteria is not used.
criteria2A string specifying the criteria to be used. If this parameter is omitted the second criteria is not used.


FILTER.ADVANCED(operation, list_ref, [criteria_ref], [copy_ref], [unique])

Simulates the Format Data Filter Advanced filter menu option.

operationWhether to filter in place or copy to another location. The possible values are:
1Filter the list in place
2Copy the list to another location
list_refThe location of the list to be filtered.
criteria_refThe location of any filter criteria to be used. If this parameter is omitted no criteria will be applied.
copy_refThe destination of the copied data. This is only used when operation is 2.
uniqueWhether to select unique records only. The possible values are:
FALSEDisplay all records that match the criteria.
TRUEDisplay only unique records that match the criteria.
If this parameter is omitted it defaults to FALSE.


FILTER.SHOW.ALL()

Simulates the Format Data Filter Show All menu option.



FONT.PROPERTIES([font], [font_style], [size], [strikethrough], [superscript], [subscript], [outline], [shadow], [underline], [color], [normal], [background], [start_char], [char_count])

Simulates the Format Cells dialog Font page or changes the font of the selected chart text.

fontThe name of the font to be used.
font_styleThe style to be used. The possible values are:
"Regular"Removes the bold and italic attributes.
"Bold"Sets the font to bold.
"Italic"Sets the font to italic.
"Bold Italic"Sets the font to bold and italic.
If this parameter is omitted the style is not changed.
sizeThe point size to be used. If this parameter is omitted the size is not changed.
strikethroughSets the strikethrough attribute. The possible values are:
FALSEThe font does not have the strikethrough attribute
TRUEThe font has the strikethrough attribute
If this parameter is omitted the strikethrough attribute is not changed.
superscriptNot currently implemented.
subscriptNot currently implemented.
outlineNot currently implemented.
shadowNot currently implemented.
underlineThe underline style to be used. The possible values are:
0None
1Single
2Double (not currently implemented)
3Single accounting (not currently implemented)
4Double accounting (not currently implemented)
If this parameter is omitted the underline style is not changed.
colorThe color to be used. The possible values are:
0Automatic
1 to 56One of the colors displayed in the Format Cells dialog Font page
If this parameter is omitted the color is not changed.
normalNot currently implemented.
backgroundNot currently implemented.
start_charNot currently implemented.
char_countNot currently implemented.


FOPEN(file_text, [access_num])

Opens a file for reading or writing. The return value is a file number that can be passed as a parameter to the FREAD, FREADLN, FWRITE, FWRITELN, FPOS, FSIZE and FCLOSE functions.

file_textThe name of the file to open.
access_numThe access required to the file. The possible values are:
1Open the file for reading and writing. The file must already exist.
2Open the file for reading only. The file must already exist.
3Create a new file for reading and writing. The file will be cleared if it already exists.
If this parameter is omitted it defaults to 1.


FORMAT.LEGEND(position_num)

Changes the active chart legend placement.

position_numThe placement of the legend. The possible values are:
1Bottom
2Corner
3Top
4Right
5Left


FORMAT.MOVE([x_offset], [y_offset], [reference])

Moves the currently selected object.

x_offsetThe offset in points of the top-left corner of the object from the left edge of the cell. If this parameter is omitted it defaults to 0.
y_offsetThe offset in points of the top-left corner of the object from the top edge of the cell. If this parameter is omitted it defaults to 0.
referenceThe cell containing the top-left corner of the object. If this parameter is omitted it defaults to A1.


FORMAT.NUMBER(format_text)

Simulates the Format Cells dialog Number page.

format_textThe number format to be used.


FORMAT.SHAPE(vertex_num, insert, [reference], [x_offset], [y_offset])

Inserts, moves or deletes polygon points.

vertex_numThe number of the vertex to be inserted, moved or deleted.
insertWhether the vertex is to be inserted, moved or deleted. The possible values are:
FALSEThe vertex is to be deleted (if none of the subsequent parameters are entered) or moved (if any of the remaining parameters are entered)
TRUEThe vertex is to be inserted
referenceThe cell from which the insert or move position is measured. If this parameter is omitted it defaults to the top left corner of the polygon.
x_offsetThe horizontal offset from the reference, measured in points. If this parameter is omitted it defaults to zero.
y_offsetThe vertical offset from the reference, measured in points. If this parameter is omitted it defaults to zero.


FORMAT.TEXT([x_align], [y_align], [orient_num], [auto_text], [auto_size], [show_key], [show_value], [add_indent])

Formats the text in a text box or command button.

x_alignThe horizontal alignment. The possible values are:
1Left
2Center
3Right
4Justify
If this parameter is omitted the setting is not changed.
y_alignThe vertical alignment. The possible values are:
1Top
2Center
3Bottom
4Justify
If this parameter is omitted the setting is not changed.
orient_numThe text orientation (not currently implemented).
auto_textResets data label text (not currently implemented).
auto_sizeResets the border around the text (not currently implemented).
show_keyShows legend key for data labels (not currently implemented).
show_valueShows values for data labels (not currently implemented).
add_indentUsed for Far East versions only (not currently implemented).


FORMULA(formula_text, [reference])

Enters the specified formula in the specified reference. Any references in the formula must be in R1C1 format. The FORMULA.CONVERT function can be used to convert references.

formula_textThe formula to be inserted.
referenceThe reference where formula to be inserted. If this parameter is omitted it defaults to the cursor position on the active worksheet.


FORMULA.ARRAY(formula_text, [reference])

Enters the specified array formula in the specified reference. Any references in the formula must be in R1C1 format. The FORMULA.CONVERT function can be used to convert references.

formula_textThe formula to be inserted.
referenceThe reference where formula to be inserted. If this parameter is omitted it defaults to the current selection on the active worksheet.


FORMULA.CONVERT(formula_text, from_a1, [to_a1], [to_ref_type], [rel_to_ref])

Converts the references in the specified formula from one type to another.

formula_textThe formula to be converted.
from_a1Whether references in the formula are in A1 or R1C1 format. The possible values are:
FALSEThe references are in R1C1 format
TRUEThe references are in A1 format
to_a1Whether references in the formula are converted to A1 or R1C1 format. The possible values are:
FALSEThe references are converted to R1C1 format
TRUEThe references are converted to A1 format
If this parameter is omitted the format is not changed.
to_ref_typeWhether references in the formula are converted to use absolute or relative reference type. The possible values are:
1Absolute row, absolute column
2Absolute row, relative column
3Relative row, absolute column
4Relative row, relative column
If this parameter is omitted the reference type is not changed.
rel_to_refThe cell that R1C1 references are relative to. If this parameter is omitted it defaults to the cell containing this function.


FORMULA.FILL(formula_text, [reference])

Enters the specified formula in the specified range. Any references in the formula must be in R1C1 format. The FORMULA.CONVERT function can be used to convert references.

formula_textThe formula to be inserted.
referenceThe reference where formula to be inserted. If this parameter is omitted it defaults to the current selection on the active worksheet.


FORMULA.FIND(text, in_num, at_num, by_num, [dir_num], [match_case])

Simulates the Edit Find menu option.

textThe text that you want to find.
in_numWhere you want to look for the text. The possible values are:
1Formulas
2Values
3Comments
at_numWhether to match the text against all or part of a cell. The possible values are:
1Entire cells only
2Any part of the text in a cell
by_numWhether to search by rows or by columns. The possible values are:
1By rows
2By columns
dir_numWhether to search for the next or previous match. The possible values are:
1Next
2Previous
If this parameter is omitted it defaults to 1.
match_caseWhether the search is case-sensitive. The possible values are:
TRUEThe search is case-sensitive
FALSEThe search is not case-sensitive
If this parameter is omitted it defaults to FALSE.


FORMULA.FIND.NEXT()

Finds the next cell based on the current criteria.



FORMULA.FIND.PREV()

Finds the previous cell based on the current criteria.



FORMULA.GOTO([reference], [corner])

Simulates the Edit Goto menu option.

referenceThe cells that are to be selected. If the sheet name is omitted then it defaults to the currently active sheet. If this parameter is omitted it defaults to the sheet and cells that were selected before the last goto command.
cornerSpecifies whether the top-left corner of the selection is to be placed in the top-left corner of the window. The possible values are:
FALSEThe sheet is not scrolled to move the selection to the top-left corner of the window.
TRUEThe sheet is scrolled to move the selection to the top-left corner of the window.
If this parameter is omitted it defaults to FALSE.


FORMULA.REPLACE(find_text, replace_text, [look_at], [look_by], [active_cell], [match_case])

Simulates the Edit Find/Replace menu option.

find_textThe text that you want to find.
replace_textThe text to replace the found text with.
look_atWhether to match the text against all or part of a cell. The possible values are:
1Entire cells only
2Any part of the text in a cell
If this parameter is omitted it defaults to 1.
look_byWhether to search by rows or by columns. The possible values are:
1By rows
2By columns
If this parameter is omitted it defaults to 1.
active_cellWhether to replace in just the current cell or in the whole sheet. The possible values are:
TRUEText in the active cell is replaced
FALSEText in the whole sheet is replaced
If this parameter is omitted it defaults to FALSE.
match_caseWhether the search is case-sensitive. The possible values are:
TRUEThe search is case-sensitive
FALSEThe search is not case-sensitive
If this parameter is omitted it defaults to the value last used.


FPOS(file_num, [position_num])

Returns the current read/write position in a file, and optionally allows you to change it.

file_numThe file number that was returned by the FOPEN function.
position_numThe location where the next read or write will occur.
If this parameter is omitted the current position is not changed.


FREAD(file_num, num_chars)

Returns a string of characters from a file.

file_numThe file number that was returned by the FOPEN function.
num_charsThe number of characters to read.


FREADLN(file_num)

Returns a string of characters from a file, up to the next end of line marker.

file_numThe file number that was returned by the FOPEN function.


FREEZE.PANES([logical], [col_split], [row_split])

Simulates the Format Freeze Panes menu option.

logicalWhether to freeze or unfreeze the panes. The possible values are:
FALSEUnfreeze the panes
TRUEFreeze the panes
If this parameter is omitted the setting is toggled.
col_splitThe number of columns to be frozen. If this parameter is omitted all columns left of the cursor cell are frozen.
row_splitThe number of rows to be frozen. If this parameter is omitted all rows above the cursor cell are frozen.


FSIZE(file_num)

Returns a size of a file.

file_numThe file number that was returned by the FOPEN function.


FULL.SCREEN([logical])

Simulates the Format Program Full screen menu option.

logicalWhether to switch to or from full screen mode. The possible values are:
FALSESwitch from full screen mode
TRUESwitch to full screen mode
If this parameter is omitted it defaults to TRUE.


FWRITE(file_num, text)

Writes a string of characters to a file.

file_numThe file number that was returned by the FOPEN function.
textThe text to be written.


FWRITELN(file_num, text)

Writes a string of characters to a file, followed by an end of line marker.

file_numThe file number that was returned by the FOPEN function.
textThe text to be written.


GALLERY.AREA(type_num, [delete_overlay])

Changes the active chart to an area chart.

type_numThe format to be applied to the chart. The possible values are:
1no horizontal gridlines, no vertical gridlines, linear y axis, no data labels, no drop lines
2no horizontal gridlines, no vertical gridlines, 100% y axis, no data labels, no drop lines (not currently implemented)
3no horizontal gridlines, no vertical gridlines, linear y axis, no data labels, drop lines (not currently implemented)
4horizontal gridlines, vertical gridlines, linear y axis, no data labels, no drop lines
5no horizontal gridlines, no vertical gridlines, linear y axis, data labels, no drop lines
delete_overlayWhether to delete any overlays (not currently implemented).


GALLERY.BAR(type_num, [delete_overlay])

Changes the active chart to a bar chart.

type_numThe format to be applied to the chart. The possible values are:
1no horizontal gridlines, no vertical gridlines, linear x axis, no data labels, not stacked, no series lines
2no horizontal gridlines, no vertical gridlines, linear x axis, no data labels, not stacked, no series lines
3no horizontal gridlines, no vertical gridlines, linear x axis, no data labels, stacked, no series lines (not currently implemented)
4no horizontal gridlines, no vertical gridlines, linear x axis, no data labels, not stacked, no series lines
5no horizontal gridlines, no vertical gridlines, 100% x axis, no data labels, stacked, no series lines (not currently implemented)
6no horizontal gridlines, vertical gridlines, linear x axis, no data labels, not stacked, no series lines
7no horizontal gridlines, no vertical gridlines, linear x axis, data values, not stacked, no series lines
8no horizontal gridlines, no vertical gridlines, linear x axis, no data labels, not stacked, no series lines
9no horizontal gridlines, no vertical gridlines, linear x axis, no data labels, stacked, series lines (not currently implemented)
10no horizontal gridlines, no vertical gridlines, 100% x axis, no data labels, stacked, series lines (not currently implemented)
delete_overlayWhether to delete any overlays (not currently implemented).


GALLERY.COLUMN(type_num, [delete_overlay])

Changes the active chart to a column chart.

type_numThe format to be applied to the chart. The possible values are:
1no horizontal gridlines, no vertical gridlines, linear y axis, no data labels, not stacked, no series lines
2no horizontal gridlines, no vertical gridlines, linear y axis, no data labels, not stacked, no series lines
3no horizontal gridlines, no vertical gridlines, linear y axis, no data labels, stacked, no series lines (not currently implemented)
4no horizontal gridlines, no vertical gridlines, linear y axis, no data labels, not stacked, no series lines
5no horizontal gridlines, no vertical gridlines, 100% y axis, no data labels, stacked, no series lines (not currently implemented)
6horizontal gridlines, no vertical gridlines, linear y axis, no data labels, not stacked, no series lines
7no horizontal gridlines, no vertical gridlines, linear y axis, data values, not stacked, no series lines
8no horizontal gridlines, no vertical gridlines, linear y axis, no data labels, not stacked, no series lines
9no horizontal gridlines, no vertical gridlines, linear y axis, no data labels, stacked, series lines (not currently implemented)
10no horizontal gridlines, no vertical gridlines, 100% y axis, no data labels, stacked, series lines (not currently implemented)
delete_overlayWhether to delete any overlays (not currently implemented).


GALLERY.DOUGHNUT(type_num, [delete_overlay])

Changes the active chart to a doughnut chart.

type_numThe format to be applied to the chart. The possible values are:
1no data labels, not exploded
2data labels, not exploded
3no data labels, first segment exploded (not currently implemented)
4no data labels, all segments exploded (not currently implemented)
5data labels, not exploded
6data percentages, not exploded
7data labels and percentages, not exploded
delete_overlayWhether to delete any overlays (not currently implemented).


GALLERY.LINE(type_num, [delete_overlay])

Changes the active chart to a line chart.

type_numThe format to be applied to the chart. The possible values are:
1markers, straight lines, no horizontal gridlines, no vertical gridlines, linear y axis, no hi-lo lines
2no markers, straight lines, no horizontal gridlines, no vertical gridlines, linear y axis, no hi-lo lines
3markers, no lines, no horizontal gridlines, no vertical gridlines, linear y axis, no hi-lo lines
4markers, straight lines, horizontal gridlines, no vertical gridlines, linear y axis, no hi-lo lines
5markers, straight lines, horizontal gridlines, vertical gridlines, linear y axis, no hi-lo lines
6markers, straight lines, horizontal gridlines, no vertical gridlines, logarithmic y axis, no hi-lo lines
7markers, no lines, no horizontal gridlines, no vertical gridlines, linear y axis, hi-lo lines (not currently implemented)
8high-low-close stock chart (not currently implemented)
9open-high-low-close stock chart (not currently implemented)
10no markers, curved lines, no horizontal gridlines, no vertical gridlines, linear y axis, no hi-lo lines (not currently implemented)
delete_overlayWhether to delete any overlays (not currently implemented).


GALLERY.PIE(type_num, [delete_overlay])

Changes the active chart to a pie chart.

type_numThe format to be applied to the chart. The possible values are:
1no data labels, not exploded
2data labels, not exploded
3no data labels, first segment exploded (not currently implemented)
4no data labels, all segments exploded (not currently implemented)
5data labels, not exploded
6data percentages, not exploded
7data labels and percentages, not exploded
delete_overlayWhether to delete any overlays (not currently implemented).


GALLERY.RADAR(type_num, [delete_overlay])

Changes the active chart to a radar chart.

type_numThe format to be applied to the chart. The possible values are:
1markers, no horizontal gridlines, linear y axis, not filled
2no markers, no horizontal gridlines, linear y axis, not filled
3no markers, no horizontal gridlines, no y axis, not filled
4no markers, horizontal gridlines, linear y axis, not filled
5no markers, horizontal gridlines, logarithmic y axis, not filled
6no markers, no horizontal gridlines, linear y axis, filled (not currently implemented)
delete_overlayWhether to delete any overlays (not currently implemented).


GALLERY.SCATTER(type_num, [delete_overlay])

Changes the active chart to a scatter (XY) chart.

type_numThe format to be applied to the chart. The possible values are:
1markers, no lines, no horizontal gridlines, no vertical gridlines, linear y axis, linear x axis
2markers, straight lines, no horizontal gridlines, no vertical gridlines, linear y axis, linear x axis
3markers, no lines, horizontal gridlines, vertical gridlines, linear y axis, linear x axis
4markers, no lines, horizontal gridlines, no vertical gridlines, logarithmic y axis, linear x axis
5markers, no lines, horizontal gridlines, vertical gridlines, logarithmic y axis, logarithmic x axis
6no markers, curved lines, no horizontal gridlines, no vertical gridlines, linear y axis, linear x axis (not currently implemented)
delete_overlayWhether to delete any overlays (not currently implemented).


GET.CELL(type_num, [reference])

Returns information about the specified cell.

type_numThe type of information to return. The possible values are:
1Absolute reference of the upper-left cell in reference, as text
2Row number of the top cell in reference
3Column number of the leftmost cell in reference
4Same as TYPE(reference)
5Contents of reference
6Formula in reference, as text
7Number format of the cell, as text
8Number indicating the cell's horizontal alignment
9Number indicating the left-border style assigned to the cell
10Number indicating the right-border style assigned to the cell
11Number indicating the top-border style assigned to the cell
12Number indicating the bottom-border style assigned to the cell
13Number from 0 to 18, indicating the pattern of the selected cell
14If the cell is locked, returns TRUE; otherwise, returns FALSE
15If the cell's formula is hidden, returns TRUE; otherwise, returns FALSE
16A two-item horizontal array containing the width of the active cell and a logical value indicating whether the cell's width is set to change as the standard width changes (TRUE) or is a custom width (FALSE)
17Row height of cell, in points
18Name of font, as text
19Size of font, in points
20If the cell is bold returns TRUE; otherwise returns FALSE
21If the cell is italic returns TRUE; otherwise returns FALSE
22If the cell is underlined returns TRUE; otherwise returns FALSE
23If the cell is struck out returns TRUE; otherwise returns FALSE
24Font color of cell, as a number in the range 1 to 56. If font color is automatic, returns 0
25If the cell is outlined returns TRUE; otherwise returns FALSE
26If the cell is shadowed returns TRUE; otherwise returns FALSE
32Name of the workbook and sheet containing the cell
33If the cell is formatted to wrap, returns TRUE; otherwise, returns FALSE
34Left-border color as a number in the range 1 to 56. If color is automatic, returns 0
35Right-border color as a number in the range 1 to 56. If color is automatic, returns 0
36Top-border color as a number in the range 1 to 56. If color is automatic, returns 0
37Bottom-border color as a number in the range 1 to 56. If color is automatic, returns 0
38Shade foreground color as a number in the range 1 to 56. If color is automatic, returns 0
39Shade background color as a number in the range 1 to 56. If color is automatic, returns 0
42The horizontal distance, measured in points, from the left edge of the active window to the left edge of the cell
43The vertical distance, measured in points, from the top edge of the active window to the top edge of the cell
44The horizontal distance, measured in points, from the left edge of the active window to the right edge of the cell
45The vertical distance, measured in points, from the top edge of the active window to the bottom edge of the cell
46If the cell contains a comment, returns TRUE; otherwise, returns FALSE
48If the cell contains a formula, returns TRUE; if a constant, returns FALSE
49If the cell is part of an array, returns TRUE; otherwise, returns FALSE
50Number indicating the cell's vertical alignment
51Number indicating the cell's text orientation
53Contents of the cell as it is currently displayed, as text
57If the cell is superscript returns TRUE; otherwise returns FALSE
58Returns the font style of the cell as text
59Returns the number for the underline style
60If the cell is subscript returns TRUE; otherwise returns FALSE
62The book and sheet name in the form "[Book1.xls]Sheet1"
66The name of the workbook containing the cell in the form "Book1.xls"
referenceThe cell whose information is to be returned. If this parameter is omitted it defaults to the active cell.


GET.DOCUMENT(type_num, [name_text])

Returns information about the specified file.

type_numThe type of information to return. The possible values are:
1The book and sheet name in the form "[Book1.xls]Sheet1"
2The path of the directory containing the file, or #N/A is the file has not been saved
3A number indicating the active sheet type: 1=worksheet, 2=chart sheet, 3=macro sheet, 4=info window, 5=reserved, 6=module, 7=dialog
4A logical value indicating whether the file has been changed since last save
7A logical value indicating whether the sheet is protected
9For worksheets, the number of the first used row (0 if empty)
For chart sheets, a number indicating the chart type: 1=area, 2=bar, 3=column, 4=line, 5=pie, 6=scatter, 7=3d area, 8=3d column, 9=3d line, 10=3d pie, 11=radar, 12=3d bar, 13=3d surface, 14=doughnut
10For worksheets, the number of the last used row (0 if empty)
11For worksheets, the number of the first used column (0 if empty)
For chart sheets, the chart series count
12For worksheets, the number of the last used column (0 if empty)
13The number of windows
14A number indicating the calculation mode: 1=automatic, 2=automatic except tables, 3=manual
20A logical value corresponding to the calculation - 1904 date system setting
37A number indicating the file type: 1=normal, 3=text, 6=CSV, 17=template
42A horizontal array of the objects on a sheet, or #N/A if there are none
48A number indicating the standard column width in characters
68The book name in the form "Book1.xls"
76The book and sheet name in the form "[Book1.xls]Sheet1"
85A logical value indicating whether the Advanced Filter is on
86A logical value indicating whether the AutoFilter is on
87The active sheet number
88The name of the active workbook in the form "Book1.xls"
name_textThe file whose information is to be returned. If this parameter is omitted it defaults to the active file.


GET.FORMULA(reference)

Returns the contents of a cell as a string. Any references in a formula will be returned in R1C1 format.

referenceThe cell whose contents are to be returned.


GET.NAME(name_text, [info_type])

Returns information about a name.

name_textA string containing the name.
info_typeThe type of information to be returned. The possible values are:
1Return the definition.
2Return TRUE if it is a local name, or FALSE if it is a global name.
If this parameter is omitted it defaults to 1.


GET.NOTE([cell_ref], [start_char], [num_chars])

Returns the text of a comment.

cell_refThe reference of the cell containing the comment. If this parameter is omitted it defaults to the active cell.
start_charThe position of the first character to be returned. If this parameter is omitted it defaults to 1.
num_charsThe length of the text to be returned. If this parameter is omitted it defaults to the length of the comment.


GET.OBJECT(type_num, [object_id], [start_num], [count_num], [item_index])

Returns information about the specified object.

type_numThe type of information to return. The possible values are:
1object type as number:
1 line
2 rectangle
3 oval
6 text box
7 command button
11 check box
12 option button
14 label
16 spinner
17 scroll bar
18 list box
19 group box
20 drop down box
2locked
3z-order
4top-left cell as R1C1 reference
5x-offset of top-left corner in points
6y-offset of top-left corner in points
7bottom-right cell as R1C1 reference
8x-offset of bottom-right corner in points
9y-offset of bottom-right corner in points
10reference of the macro as text
11object positioning as number:
1 move and size with cells
2 move but don't size with cells
3 don't move or size with cells
12object text from start_num for count_num characters
13font name
14font size
15bold
16italic
17underline
18strikethrough
19outline
20shadow
21text color
22horizontal alignment as number:
1 left
2 center
3 right
4 justified
23vertical alignment as number:
1 top
2 center
3 bottom
4 justified
26visible
48linked cell reference as text
49object id number
50object class name
51object name (class name and id number)
56enabled
62current value
63minimum value
64maximum value
65increment value
66page value
71list/combo entries
73input range reference as text
74dropdown lines
75draw 3d
object_idThe object identifier. If this parameter is omitted it defaults to the currently selected object on the active worksheet.
start_numThe text substring start position for type_num 12. If this parameter is omitted it defaults to 1.
count_numThe text substring length for type_num 12. If this parameter is omitted it defaults to 255.
item_indexThis parameter is not currently used.


GET.WINDOW(type_num, [window_text])

Returns information about the specified window.

type_numThe type of information to return. The possible values are:
1The book and sheet name in the form "[Book1.xls]Sheet1".
2The number of the window.
3The x-position in points from the left edge of the workspace to the left edge of the window.
4The y-position in points from the bottom of the formula bar to the top edge of the window.
5The window width, measured in points.
6The window height, measured in points.
7If the window is hidden then TRUE, otherwise FALSE.
8If formulas are displayed then TRUE, otherwise FALSE.
9If gridlines are displayed then TRUE, otherwise FALSE.
10If headings are displayed then TRUE, otherwise FALSE.
11If zeros are displayed then TRUE, otherwise FALSE.
12The gridline color (1-56) or 0 if automatic.
13The leftmost column number of each pane, in a horizontal array.
14The top row number of each pane, in a horizontal array.
15The number of columns in each pane, in a horizontal array.
16The number of rows in each pane, in a horizontal array.
17The split type: 1=none, 2=vertical, 3=horizontal, 4=both.
18If the window has a vertical split then TRUE, otherwise FALSE.
19If the window has a horizontal split then TRUE, otherwise FALSE.
20If the window is maximized then TRUE, otherwise FALSE.
21Reserved
22If View Outline Symbols is selected then TRUE, otherwise FALSE.
23The window status: 1=restored, 2=minimized, 3=maximized.
24If window panes are frozen then TRUE, otherwise FALSE.
25The zoom percentage.
26If horizontal scrollbars are displayed then TRUE, otherwise FALSE.
27If vertical scrollbars are displayed then TRUE, otherwise FALSE.
28The ratio of the sheet tabs to the horizontal scrollbar.
29If sheet tabs are displayed then TRUE, otherwise FALSE.
30The book and sheet name in the form "[Book1.xls]Sheet1".
31The book name in the form "Book1.xls".
window_textThe window whose information is to be returned. If this parameter is omitted it defaults to the active window.


GET.WORKBOOK(type_num, [name_text])

Returns information about the specified file.

type_numThe type of information to return. The possible values are:
1A horizontal array of sheet names in the form "[Book1.xls]Sheet1"
4The number of sheets in the workbook
16The workbook name in the form "Book1.xls"
20A number indicating the file type: 1=normal, 3=text, 6=CSV, 17=template
24A logical value indicating whether the file has been changed since last save
38The name of the active sheet in the form "Sheet1"
name_textThe file whose information is to be returned. If this parameter is omitted it defaults to the active file.


GET.WORKSPACE(type_num)

Returns information about the workspace.

type_numThe type of information to return. The possible values are:
6If the status bar is shown then TRUE, otherwise FALSE
7If the formula bar is shown then TRUE, otherwise FALSE
21If the standard toolbar is shown then TRUE, otherwise FALSE
26Name of user
27Name of organisation
32The full path to the application
40If screen updating is on then TRUE, otherwise FALSE
50If full screen mode is on then TRUE, otherwise FALSE


GOAL.SEEK(target_cell, target_value, variable_cell)

Simulates the Format Data Goal seek menu option.

target_cellThe cell that is required to be a certain value. It must be a single cell containing a formula that returns a numeric result.
target_valueThe value that the target cell needs to reach.
variable_cellThe cell whose value can be changed. It must be a single cell that either contains a number or is empty.


GRIDLINES([x_major], [x_minor], [y_major], [y_minor], [z_major], [z_minor], [2D_effect])

Changes the active chart gridlines.

x_majorWhether to draw the X-axis major gridlines. The possible values are:
FALSEDo not draw the X-axis major gridlines.
TRUEDo draw the X-axis major gridlines.
If this parameter is omitted the setting is not changed.
x_minorWhether to draw the X-axis minor gridlines (not currently implemented).
y_majorWhether to draw the Y-axis major gridlines. The possible values are:
FALSEDo not draw the Y-axis major gridlines.
TRUEDo draw the Y-axis major gridlines.
If this parameter is omitted the setting is not changed.
y_minorWhether to draw the Y-axis minor gridlines (not currently implemented).
z_majorWhether to draw the Z-axis minor gridlines (not currently implemented).
z_minorWhether to draw the Z-axis minor gridlines (not currently implemented).
2D_effectWhether to draw 2D gridlines on 3D charts (not currently implemented).


HIDE.OBJECT([object_id], [hide_logical])

Hides or shows an object.

object_idThe object to be hidden or shown. If this parameter is omitted the currently selected object is used.
hide_logicalWhether the object is hidden. The possible values are:
FALSEThe object is shown
TRUEThe object is hidden
If this parameter is omitted it defaults to TRUE.


HLINE([num_columns])

Scrolls the worksheet horizontally by the specified number of columns.

num_columnsThe number of columns to scroll. A negative number will scroll to the left. If this parameter is omitted it defaults to 1.


HPAGE([num_windows])

Scrolls the worksheet horizontally by the specified number of pages.

num_windowsThe number of pages to scroll. A negative number will scroll to the left. If this parameter is omitted it defaults to 1.


HSCROLL(position, [col_logical])

Scrolls the worksheet horizontally to the specified position.

positionThe proportional or absolute position to scroll to.
col_logicalWhether the position parameter represents a proportional or absolute column number. The possible values are:
FALSEThe position parameter is a number between 0 and 1 that represents how far across the worksheet to scroll to.
TRUEThe position parameter is a number between 1 and 256 that represents the column number to scroll to.
If this parameter is omitted it defaults to FALSE.


INPUT(message_text, [type_num], [title_text], [default], [x_pos], [y_pos], [help_ref])

Displays a message in a dialog box with an area for user input and OK and Cancel buttons. If the OK button is pressed then the text entered by the user is returned. If the Cancel button is pressed then this function returns the value FALSE.

message_textThe message that you want displayed in the dialog box.
type_numThe acceptable data type(s) for the data that you want returned. It can be any combination of the following (to specify more than one value, add the numbers together):
0Formula
1Number
2Text
4Logical
8Reference
16Error
64Array
If this parameter is omitted it defaults to 2.
title_textThe title to be used for the dialog box. If this parameter is omitted it defaults to "Input".
defaultThe text that you want to be initially displayed in the input area of the dialog box. If this parameter is omitted the input area will be blank.
x_posThe initial x position on the screen where the dialog box will be displayed. If this parameter is omitted it defaults to the center of the screen. (Not currently implemented).
y_posThe initial y position on the screen where the dialog box will be displayed. If this parameter is omitted it defaults to the center of the screen. (Not currently implemented).
help_refThe name of help topic that is to be displayed if the user presses the Help button in the dialog box. If this parameter is omitted then no Help button is displayed. (Not currently implemented).


INSERT([shift_num])

Simulates the Insert Cells menu option.

shift_numThe way in which the cell insertion is to be processed. The possible values are:
1Shift cells right
2Shift cells down
3Insert entire rows
4Insert entire columns
If this parameter is omitted it defaults to 2.


INSERT.TITLE([chart], [y_primary], [x_primary], [y_secondary], [x_secondary])

Attaches default text to the active chart. The SELECT and FORMULA functions can be used to change the text.

chartWhether to add a default chart title. The possible values are:
FALSEDelete any existing chart title.
TRUEAdd default chart title if one does not already exist.
If this parameter is omitted the chart title is not changed.
y_primaryWhether to add a default primary y-axis title. The possible values are:
FALSEDelete any existing primary y-axis title.
TRUEAdd default primary y-axis title if one does not already exist.
If this parameter is omitted the primary y-axis title is not changed.
x_primaryWhether to add a default primary x-axis title. The possible values are:
FALSEDelete any existing primary x-axis title.
TRUEAdd default primary x-axis title if one does not already exist.
If this parameter is omitted the primary x-axis title is not changed.
y_secondaryWhether to add a default secondary y-axis title (not currently implemented).
x_secondaryWhether to add a default secondary x-axis title (not currently implemented).


LABEL.PROPERTIES([accel_text], [accel_text2], [3d_shading])

Changes the properties of a label or group box control.

accel_textThe accelerator key on a dialog sheet (not currently implemented).
accel_text2The second accelerator key on a dialog sheet (not currently implemented).
3d_shadingWhether to draw the control with 3d shading. The possible values are:
FALSE2d
TRUE3d
If this parameter is omitted the setting is not changed.


LEGEND([logical])

Changes the active chart legend visibility.

logicalWhether to show the legend. The possible values are:
FALSEDo not show the legend
TRUEDo show the legend
If this parameter is omitted it defaults to TRUE.


LISTBOX.PROPERTIES([range], [link], [drop_size], [multi_select], [3d_shading])

Changes the properties of a list box or combo box control.

rangeThe input range from which to fill the list. If this parameter is omitted the setting is not changed.
linkThe cell that is updated by the control. If this parameter is omitted the link is not changed.
drop_sizeThe number of lines in the drop-down list of a combo box. If this parameter is omitted the setting is not changed.
multi_selectWhether to allow more than one list selection (not currently implemented).
3d_shadingWhether to draw the control with 3d shading. The possible values are:
FALSE2d
TRUE3d
If this parameter is omitted the setting is not changed.


MESSAGE(logical, [text])

Displays a message on the status bar.

logicalWhether to display or hide messages. The possible values are:
TRUEDisplay a message on the status bar.
FALSERemove any message from the status bar.
textThe message to be displayed. If this parameter is omitted it defaults to an empty string.


NAMES([document_text], [type_num], [match_text])

Returns a horizontal array containing defined names.

document_textThe name of the workbook containing the names. If this parameter is omitted it defaults to the active workbook.
type_numThe type of name to retrieve. The possible values are:
1Visible names
2Hidden names
3All names
If this parameter is omitted it defaults to 1.
match_textA template name that may contain wildcard characters. If this parameter is omitted all names will match.


NEW([type_num], [xy_series], [add_logical])

Simulates the File New menu option.

type_numThe type of workbook to create. The possible values are:
omittedNew workbook with 1 worksheet of the same type as the active worksheet.
1New workbook with 1 worksheet.
2New workbook with 1 chart based on the current selection (not currently implemented).
3New workbook with 1 macro sheet.
4New workbook with 1 international macro sheet (not currently implemented).
5New workbook based on Book.xlt or default template.
6New workbook with 1 VB module (not currently implemented).
7New workbook with 1 dialog sheet (not currently implemented).
file nameNew workbook based on template file.
xy_seriesHow to interpret selected data for a new chart (not currently implemented).
add_logicalWhether to add the specified sheet to the current workbook (not currently implemented).


NOTE([add_text], [cell_ref], [start_char], [num_chars])

Simulates the Insert Comment menu option.

add_textThe text that is to be added. If this parameter is omitted it defaults to an empty string.
cell_refThe cell where the comment is to be inserted. If this parameter is omitted it defaults to the active cell.
start_charThe start position in an existing comment where the new text is to be inserted. If this parameter is omitted it defaults to 1.
num_charsThe length of text in an existing comment that is to be replaced. If this parameter is omitted it defaults to the length of the existing text.


OBJECT.PROPERTIES([placement_type], [print_object])

Changes the properties of an object.

placement_typeHow the object is attached to the cells. The possible values are:
1Move and size with cells
2Move but don't size with cells
3Don't move or size with cells
If this parameter is omitted the setting is not changed.
print_objectWhether the object can be printed. The possible values are:
FALSEThe object is not printed
TRUEThe object is printed
If this parameter is omitted the setting is not changed.


ON.DOUBLECLICK([sheet_text], [macro_text])

Specifies a macro to be run when a cell is double-clicked.

sheet_textThe name of the sheet for which the macro is to be run. If this parameter is omitted then the macro will be run for all sheets.
macro_textA string containing a defined name or R1C1 reference indicating the macro that is to be run. If this parameter is omitted then no macro will be run.


ON.ENTRY([sheet_text], [macro_text])

Specifies a macro to be run when data is entered.

sheet_textThe name of the sheet for which the macro is to be run. If this parameter is omitted then the macro will be run for all sheets.
macro_textA string containing a defined name or R1C1 reference indicating the macro that is to be run. If this parameter is omitted then no macro will be run.


ON.SHEET([sheet_text], [macro_text], [activate_logical])

Specifies a macro to be run when a sheet is activated or deactivated.

sheet_textThe name of the sheet for which the macro is to be run. If this parameter is omitted then the macro will be run for all sheets.
macro_textA string containing a defined name or R1C1 reference indicating the macro that is to be run. If this parameter is omitted then no macro will be run.
activate_logicalSpecifies whether the macro is to be run when the sheet is activated or deactivated. The possible values are:
TRUEThe macro will be run when the sheet is activated.
FALSEThe macro will be run when the sheet is deactivated.
If this parameter is omitted it defaults to TRUE.


OPEN(file_text, [update_links], [read_only], [format], [prot_pwd], [write_res_pwd], [ignore_rorec], [file_origin], [custom_delimit], [add_logical], [editable], [file_access], [notify_logical], [converter])

Simulates the File Open menu option.

file_textThe name of the file to be opened.
update_linksWhether to update external references. The possible values are:
0Do not update any references
1Update external references
2Update remote references (not currently implemented)
3Update external and remote references (not currently implemented)
If this parameter is omitted and external references exist then a prompt will be displayed.
read_onlyWhether to open the file as read-only (not currently implemented).
formatThe character used as a delimiter for text files. The possible values are:
1Tab
2Comma
3Space
4Semicolon
5Nothing
6Custom (specified in the custom_delimit parameter)
If this parameter is omitted the text file delimiter will be determined from the file extension.
prot_pwdThe password required to unprotect a file (not currently implemented).
write_res_pwdThe password required to open a read-only file for writing (not currently implemented).
ignore_rorecWhether to suppress the display of the read-only recommended message (not currently implemented).
file_originThe operating system where the file originated (not currently implemented).
custom_delimitThe character used as a custom delimiter for text files.
add_logicalWhether to add the specified file to the current workbook (not currently implemented).
editableWhether a template file should be opened in read-write mode (not currently implemented).
file_accessWhether to change the access of a currently open file (not currently implemented).
notify_logicalWhether to send a message when a shared workbook becomes available (not currently implemented).
converterOverrides the default file type (not currently implemented).


OPEN.DIALOG([file_filter], [button_text], [title], [filter_index])

Returns a file name from the File Open dialog box, or FALSE if Cancel is selected.

file_filterOne or more file filters, separated by commas. If this parameter is omitted it defaults to "All Files (*.*), *.*".
button_textReplacement text for the Open button (not currently implemented).
titleReplacement text for the dialog box title. If this parameter is omitted the title is not changed.
filter_indexThe index of the initial file filter. If this parameter is omitted it defaults to 1


OPTIONS.VIEW([formula], [status], [notes], [show_info], [object_num], [page_breaks], [formulas], [gridlines], [color_num], [headings], [outline], [zeros], [hor_scroll], [vert_scroll], [sheet_tabs])

Changes the program, file or sheet view options.

formulaSpecifies whether the formula bar is displayed. The possible values are:
FALSEThe formula bar is not displayed
TRUEThe formula bar is displayed
If this parameter is omitted the setting is not changed.
statusSpecifies whether the status bar is displayed. The possible values are:
FALSEThe status bar is not displayed
TRUEThe status bar is displayed
If this parameter is omitted the setting is not changed.
notesSpecifies whether comments and indicators are displayed (not currently implemented).
show_infoSpecifies whether the info window is displayed (not currently implemented).
object_numSpecifies how objects are displayed (not currently implemented).
page_breaksSpecifies whether page breaks are displayed (not currently implemented).
formulasSpecifies whether to display formulas or values in cells. The possible values are:
FALSEValues are displayed
TRUEFormulas are displayed
If this parameter is omitted the setting is not changed.
gridlinesSpecifies whether gridlines are displayed. The possible values are:
FALSEGridlines are not displayed
TRUEGridlines are displayed
If this parameter is omitted the setting is not changed.
color_numSpecifies the color to be used for drawing gridlines (not currently implemented).
headingsSpecifies whether row and column headings are displayed. The possible values are:
FALSERow and column headings are not displayed
TRUERow and column headings are displayed
If this parameter is omitted the setting is not changed.
outlineSpecifies whether outline symbols are displayed (not currently implemented).
zerosSpecifies whether zero values are displayed (not currently implemented).
hor_scrollSpecifies whether the horizontal scroll bar is displayed. The possible values are:
FALSEThe horizontal scroll bar is not displayed
TRUEThe horizontal scroll bar is displayed
If this parameter is omitted the setting is not changed.
vert_scrollSpecifies whether the vertical scroll bar is displayed. The possible values are:
FALSEThe vertical scroll bar is not displayed
TRUEThe vertical scroll bar is displayed
If this parameter is omitted the setting is not changed.
sheet_tabsSpecifies whether the sheet tabs are displayed. The possible values are:
FALSEThe sheet tabs are not displayed
TRUEThe sheet tabs are displayed
If this parameter is omitted the setting is not changed.


PASTE([to_reference])

Simulates the Edit Paste menu option.

to_referenceThe cells where the copied information is to be pasted. If this parameter is omitted it defaults to the current selection on the active worksheet.


PASTE.SPECIAL([paste_num], [operation_num], [skip_blanks], [transpose])

Simulates the Edit Paste Special menu option.

paste_numThe type of information to be pasted. The possible values are:
1All
2Formulas
3Values
4Formats
5Comments
6All except borders
If this parameter is omitted it defaults to 1.
operation_numThe way in which the data being pasted is merged with existing data. The possible values are:
1None
2Add
3Subtract
4Multiply
5Divide
If this parameter is omitted it defaults to 1.
skip_blanksWhether to ignore blank cells in the data being pasted. The possible values are:
FALSEBlank cells are included.
TRUEBlank cells are skipped.
If this parameter is omitted it defaults to FALSE.
transposeWhether to transpose the data being pasted. The possible values are:
FALSEData is not transposed.
TRUEData is transposed.
If this parameter is omitted it defaults to FALSE.


PATTERNS([apattern], [afore], [aback])

Simulates the Format Cells dialog Patterns page.

apatternThe number of the pattern to be applied. The possible values are:
0No pattern
1Solid
250% Gray
375% Gray
425% Gray
5Horizontal Stripe
6Vertical Stripe
7Reverse Diagonal Stripe
8Diagonal Stripe
9Diagonal Crosshatch
10Thick Diagonal Crosshatch
11Thin Horizontal Stripe
12Thin Vertical Stripe
13Thin Reverse Diagonal Stripe
14Thin Diagonal Stripe
15Thin Horizontal Crosshatch
16Thin Diagonal Crosshatch
1712.5% Gray
186.25% Gray
If this parameter is omitted the setting is not changed.
aforeThe number of the foreground color to be applied. The possible values are:
1 to 56One of the colors displayed in the Format Cells dialog Patterns page
If this parameter is omitted the setting is not changed.
abackThe number of the background color to be applied. The possible values are:
1 to 56One of the colors displayed in the Format Cells dialog Patterns page
If this parameter is omitted the setting is not changed.


PATTERNS([lauto], [lstyle], [lcolor], [lwt], [hwidth], [hlength], [htype])

Changes the attributes of the selected line.

lautoThe line setting. The possible values are:
0Custom
1Automatic
2None
If this parameter is omitted the setting is not changed.
lstyleThe line style (not currently implemented).
lcolorThe line color. The possible values are:
1 to 56One of the colors displayed in the Format Cells dialog Patterns page
If this parameter is omitted the setting is not changed.
lwtThe line weight (not currently implemented).
hwidthThe arrowhead width (not currently implemented).
hlengthThe arrowhead length (not currently implemented).
htypeThe arrowhead type. The possible values are:
1None
2Open
3Closed
4Double open
5Double closed
If this parameter is omitted the setting is not changed.


PATTERNS([bauto], [bstyle], [bcolor], [bwt], [shadow], [aauto], [apattern], [afore], [aback], [rounded], [newui])

Changes the attributes of the selected text box, rectangle or oval.

bautoThe border setting. The possible values are:
0Custom
1Automatic
2None
If this parameter is omitted the setting is not changed.
bstyleThe border style (not currently implemented).
bcolorThe border color. The possible values are:
1 to 56One of the colors displayed in the Format Cells dialog Patterns page
If this parameter is omitted the setting is not changed.
bwtThe border weight (not currently implemented).
shadowWhether to apply a shadow to the object (not currently implemented).
aautoThe area setting. The possible values are:
0Custom
1Automatic
2None
If this parameter is omitted the setting is not changed.
apatternThe area pattern (not currently implemented).
aforeThe area foreground color. The possible values are:
1 to 56One of the colors displayed in the Format Cells dialog Patterns page
If this parameter is omitted the setting is not changed.
abackThe area background color (not currently implemented).
roundedWhether to draw the object with rounded corners (not currently implemented).
newuiWhether to use the new or old user interface color scheme (not currently implemented).


PATTERNS([bauto], [bstyle], [bcolor], [bwt], [shadow], [aauto], [apattern], [afore], [aback], [invert], [apply], [new_fill])

Changes the attributes of the selected chart plot areas, bars, columns, pie slices or text labels.

bautoThe border setting. The possible values are:
0Custom
1Automatic
2None
If this parameter is omitted the setting is not changed.
bstyleThe border style. The possible values are:
1Solid
2Dash
3Dot
4Dash dot
5Dash dot dot
6Dark
7Medium
8Light
If this parameter is omitted the setting is not changed.
bcolorThe border color. The possible values are:
1 to 56One of the colors displayed in the Format Cells dialog Patterns page
If this parameter is omitted the setting is not changed.
bwtThe border weight (not currently implemented).
shadowWhether to apply a shadow to the object (not currently implemented).
aautoThe area setting. The possible values are:
0Custom
1Automatic
2None
If this parameter is omitted the setting is not changed.
apatternThe area pattern (not currently implemented).
aforeThe area foreground color. The possible values are:
1 to 56One of the colors displayed in the Format Cells dialog Patterns page
If this parameter is omitted the setting is not changed.
abackThe area background color (not currently implemented).
invertWhether to invert the pattern for a negative value (not currently implemented).
applyWhether to apply changes to just this item or all similar items (not currently implemented).
new_fillWhether to use the new or old user interface color scheme (not currently implemented).


PATTERNS([lauto], [lstyle], [lcolor], [lwt], [mauto], [mstyle], [mfore], [mback], [apply], [smooth])

Changes the attributes of the selected chart series line.

lautoThe line setting. The possible values are:
0Custom
1Automatic
2None
If this parameter is omitted the setting is not changed.
lstyleThe line style. The possible values are:
1Solid
2Dash
3Dot
4Dash dot
5Dash dot dot
6Dark
7Medium
8Light
If this parameter is omitted the setting is not changed.
lcolorThe line color. The possible values are:
1 to 56One of the colors displayed in the Format Cells dialog Patterns page
If this parameter is omitted the setting is not changed.
lwtThe line weight (not currently implemented).
mautoThe marker setting. The possible values are:
0Custom
1Automatic
2None
If this parameter is omitted the setting is not changed.
mstyleThe marker style. The possible values are:
1Square
2Diamond
3Triangle
4X
5Star
6Dot
7Dash
8Circle
9Plus
If this parameter is omitted the setting is not changed.
mforeThe marker foreground color. The possible values are:
1 to 56One of the colors displayed in the Format Cells dialog Patterns page
If this parameter is omitted the setting is not changed.
mbackThe marker background color. The possible values are:
1 to 56One of the colors displayed in the Format Cells dialog Patterns page
If this parameter is omitted the setting is not changed.
applyWhether to apply changes to just this item or all similar items (not currently implemented).
smoothWhether to smooth picture markers (not currently implemented).


PROTECT.DOCUMENT([contents], [windows], [password], [objects], [scenarios])

Simulates the Format Sheet Protect menu option.

contentsWhether to protect the locked cell contents. The possible values are:
TRUEThe locked cell contents are protected
FALSEThe locked cell contents are unprotected
If this parameter is omitted it defaults to TRUE.
windowsWhether to protect windows from being moved or sized (not currently implemented). The possible values are:
TRUEThe windows are protected
FALSEThe windows are unprotected
If this parameter is omitted it defaults to FALSE.
passwordAn optional case-sensitive password to protect or unprotect the document.
objectsWhether to protect the locked objects (not currently implemented). The possible values are:
TRUEThe locked objects are protected
FALSEThe locked objects are unprotected
If this parameter is omitted it defaults to TRUE.
scenariosWhether to protect the scenarios (not currently implemented). The possible values are:
TRUEThe scenarios are protected
FALSEThe scenarios are unprotected
If this parameter is omitted it defaults to TRUE.


QUIT()

Simulates the File Exit menu option.



REFTEXT(reference, [a1])

Returns a string containing the specified reference.

referenceThe reference that is to be converted to text.
a1Specifies the style of the reference. The possible values are:
FALSER1C1 style
TRUEA1 style
If this parameter is omitted it defaults to FALSE.


RELREF(reference, rel_to_ref)

Returns a string containing an R1C1 reference that represents the offset of the first reference from the second.

referenceThe target reference.
rel_to_refThe base reference.


ROW.HEIGHT([height_num], [reference], [standard_height], [type_num])

Simulates the Format Row menu options.

height_numThe new height of the rows. The height is measured in points. This parameter is ignored if standard_height is TRUE or type_num is specified. If this parameter is omitted the height of the specified rows is not changed.
referenceThe rows whose height is to be changed. If this parameter is omitted it defaults to the current selection on the active worksheet.
standard_heightSpecifies whether the rows are to be set to the standard row height. The possible values are:
TRUEThe rows are set to the standard height.
FALSEThe rows are not set to the standard height.
If this parameter is omitted it defaults to FALSE.
type_numSpecifies whether the rows are to be hidden, unhidden or automatically sized. This parameter is ignored if standard_height is TRUE. The possible values are:
1The rows are hidden.
2The rows are unhidden.
3The rows are set to the height of the highest displayed value.
If this parameter is omitted the rows will not be hidden, unhidden or auto-sized.


SAVE()

Simulates the File Save menu option.



SAVE.AS([document_text], [type_num], [prot_pwd], [backup], [write_res_pwd], [read_only_rec])

Simulates the File Save As menu option.

document_textThe name for the saved file. If this parameter is omitted the current name will be used.
type_numThe type of file to save. The possible values are:
1Excel workbook (xls)
3Tab-delimited text (txt)
6Comma-separated values (csv)
17Excel template (xlt)
If this parameter is omitted it defaults to 1.
prot_pwdThe password required to unprotect a file (not currently implemented).
backupWhether to make a backup of the file (not currently implemented).
write_res_pwdThe password required to open a read-only file for writing (not currently implemented).
read_only_recWhether to save the file as read-only recommended (not currently implemented).


SAVE.COPY.AS([document_text])

Saves a copy of the current file with a different name.

document_textThe name for the saved file. If this parameter is omitted then the file is not saved.


SAVE.DIALOG([init_filename], [title], [button_text], [file_filter], [filter_index])

Returns a file name from the File Save As dialog box, or FALSE if Cancel is selected.

init_filenameThe suggested file name. If this parameter is omitted it defaults to the name of the active file.
titleReplacement text for the dialog box title. If this parameter is omitted the title is not changed.
button_textReplacement text for the Save button (not currently implemented).
file_filterOne or more file filters, separated by commas. If this parameter is omitted it defaults to "All Files (*.*), *.*".
filter_indexThe index of the initial file filter. If this parameter is omitted it defaults to 1.


SCALE([min_num], [max_num], [major], [minor], [cross], [logarithmic], [reverse], [max])

Changes the attributes of the selected chart value axis scale.

min_numThe minimum value. If this parameter is omitted the setting is not changed.
max_numThe maximum value. If this parameter is omitted the setting is not changed.
majorThe major step value. If this parameter is omitted the setting is not changed.
minorThe minor step value (not currently implemented).
crossThe value at which the opposite axis crosses this axis (not currently implemented).
logarithmicWhether this scale is linear or logarithmic. The possible values are:
FALSEThe scale is linear.
TRUEThe scale is logarithmic.
If this parameter is omitted the setting is not changed.
reverseWhether the scale values are show in reverse order (not currently implemented).
maxWhether the opposite axis crosses this axis at the maximum value (not currently implemented).


SCROLLBAR.PROPERTIES([value], [min], [max], [inc], [page], [link], [3d_shading])

Changes the properties of a scroll bar or spin control.

valueThe current value of the control. If this parameter is omitted the value is not changed.
minThe minimum value of the control. If this parameter is omitted the value is not changed.
maxThe maximum value of the control. If this parameter is omitted the value is not changed.
incThe change to the current value when the arrow button is clicked. If this parameter is omitted the value is not changed.
pageThe change to the current value when the area either side of the scroll bar thumb is clicked. If this parameter is omitted the value is not changed.
linkThe cell that is updated by the control. If this parameter is omitted the link is not changed.
3d_shadingWhether to draw the control with 3d shading. The possible values are:
FALSE2d
TRUE3d
If this parameter is omitted the setting is not changed.


SELECT([selection], [active_cell])

Sets the selection and cursor cell on the active worksheet.

selectionThe cells that are to be the selection. If this parameter is omitted the current selection is not changed.
active_cellThe cell that is to be the cursor cell. If this parameter is omitted it defaults to the top left cell in the selection.


SELECT([object_id], [replace])

Selects an object on the active worksheet.

object_idThe object to be selected. If this parameter is omitted the current selection is not changed.
replaceWhether to replace or add to the existing object selection (not currently implemented).


SELECT([item_text], [single_point])

Selects an object on the active chart.

item_textThe object to be selected. The possible values are:
"Chart"Entire chart
"Plot"Plot area
"Axis 1"Primary chart value axis
"Axis 2"Primary chart category axis
"Axis 3Secondary chart value axis or 3D chart series axis
"Axis 4"Secondary chart category axis
"Title"Chart title
"Text Axis 1"Primary chart value axis title
"Text Axis 2"Primary chart category axis title
"Text Axis 3"Primary chart series axis title
"Text n"nth floating text item
"Arrow n"nth arrow
"Gridline 1"Value axis major gridlines
"Gridline 2"Value axis minor gridlines
"Gridline 3"Category axis major gridlines
"Gridline 4"Category axis minor gridlines
"Gridline 5"Series axis major gridlines
"Gridline 6"Series axis minor gridlines
"Dropline 1"Primary chart droplines
"Dropline 2"Secondary chart droplines
"Hiloline 1"Primary chart hi-lo lines
"Hiloline 2"Secondary chart hi-lo lines
"UpBar1"Primary chart up bar
"UpBar2"Secondary chart up bar
"DownBar1"Primary chart down bar
"DownBar2"Secondary chart down bar
"Seriesline1"Primary chart series line
"Seriesline2"Secondary chart series line
"Floor"3D chart base
"Walls"3D chart back
"Corners"3D chart corners
"Sn"Series n
"SnPm"Series n point m data
"SnTm"Series n trend line m
"SnEm"Series n error bars m
"Text Sn"Series n text
"Text SnPm"Series n point m text
"Legend"Legend
"Legend Marker n"Legend marker n
"Legend Entry n"Legend entry n
If this parameter is omitted the current selection is not changed.
single_pointWhether to select a single point or the entire series (not currently implemented).


SELECT.END(direction_num)

Simulates the Ctrl+arrow key combination.

direction_numThe direction in which to move the cursor. The possible values are:
1Left
2Right
3Up
4Down


SELECT.LAST.CELL()

Simulates the Ctrl+End key combination.



SELECTION()

Returns a reference which represents the current selection on the active worksheet.



SEND.TO.BACK()

Changes the order of the objects on the active worksheet by moving the currently selected object to the back.



SET.CONTROL.VALUE([value])

Changes the current value of a control.

valueThe new value for the control. The possible values are:
Check box0Unchecked
1Checked
2Mixed
Option button0Unchecked
1Checked
Spin controlThe new value of the spin control
Scroll barThe new scroll position
List boxThe selected item (0 = no selection)
Combo boxThe selected item (0 = no selection)
If this parameter is omitted the setting is not changed.


SHOW.ACTIVE.CELL()

Scrolls the active cell into view.



SORT([orientation], [key1], [order1], [key2], [order2], [key3], [order3], [header], [custom], [case])

Simulates the Format Data Sort menu option.

orientationSpecifies whether to sort the rows or columns. The possible values are:
1Sort rows
2Sort columns
If this parameter is omitted it defaults to 1.
key1Specifies a reference to the first column or row to sort on. If this parameter is omitted it defaults to the first column or row in the selection.
order1Specifies whether to sort the data in ascending or descending order. The possible values are:
1Ascending
2Descending
If this parameter is omitted it defaults to 1.
key2Specifies a reference to the second column or row to sort on. If this parameter is omitted then the second key is not used.
order2Specifies whether to sort the data in ascending or descending order. The possible values are:
1Ascending
2Descending
If this parameter is omitted it defaults to 1.
key3Specifies a reference to the third column or row to sort on. If this parameter is omitted then the third key is not used.
order3Specifies whether to sort the data in ascending or descending order. The possible values are:
1Ascending
2Descending
If this parameter is omitted it defaults to 1.
headerSpecifies whether the selected cells include a header row or column. The possible values are:
0Determine the presence of a header automatically
1There is a header
2There is no header
If this parameter is omitted it defaults to 2.
customSpecifies whether to use a custom list for the first sort key. The possible values are:
1Use normal sort sequence
2Day short names
3Day long names
4Month short names
5Month long names
If this parameter is omitted it defaults to 1.
caseSpecifies whether the sort should be case-sensitive. The possible values are:
TRUEThe sort is case-sensitive
FALSEThe sort is not case-sensitive
If this parameter is omitted it defaults to FALSE.


STANDARD.WIDTH([standard_num])

Simulates the Format Column Standard width menu option.

standard_numThe new standard width. If this parameter is omitted then the standard width is not changed.


TEXT.BOX(add_text, [object_id], [start_num], [num_chars])

Changes the text of an object.

add_textThe text that is to be added.
object_idThe object identifier. If this parameter is omitted it defaults to the currently selected object on the active worksheet.
start_numThe start position in the existing text where the new text is to be inserted. If this parameter is omitted it defaults to 1.
num_charsThe length of existing text that is to be replaced. If this parameter is omitted it defaults to the length of the existing text.


TEXT.TO.COLUMNS([destination_ref], [data_type], [text_delim], [consecutive_delim], [tab], [semicolon], [comma], [space], [other], [other_char], [field_info])

Simulates the Format Data Text to Columns menu option.

destination_refSpecifies an alternative destination for the parsed data (not currently implemented).
data_typeSpecifies how the data is to be split. The possible values are:
1Delimited
2Fixed width
If this parameter is omitted it defaults to 1.
text_delimFor delimited data, specifies the text item delimiter. The possible values are:
1Double quote
2Single quote
3None
If this parameter is omitted it defaults to the value last specified from the menu option.
consecutive_delimFor delimited data, specifies whether to treat consecutive delimiters as one. The possible values are:
FALSETreat consecutive delimiters separately
TRUETreat consecutive delimiters as one
If this parameter is omitted it defaults to the value last specified from the menu option.
tabFor delimited data, specifies whether to treat the tab character as a delimiter. The possible values are:
FALSEDo not treat tab characters as delimiters
TRUETreat tab characters as delimiters
If this parameter is omitted it defaults to the value last specified from the menu option.
semicolonFor delimited data, specifies whether to treat the semicolon character as a delimiter. The possible values are:
FALSEDo not treat semicolon characters as delimiters
TRUETreat semicolon characters as delimiters
If this parameter is omitted it defaults to the value last specified from the menu option.
commaFor delimited data, specifies whether to treat the comma character as a delimiter. The possible values are:
FALSEDo not treat comma characters as delimiters
TRUETreat comma characters as delimiters
If this parameter is omitted it defaults to the value last specified from the menu option.
spaceFor delimited data, specifies whether to treat the space character as a delimiter. The possible values are:
FALSEDo not treat space characters as delimiters
TRUETreat space characters as delimiters
If this parameter is omitted it defaults to the value last specified from the menu option.
otherFor delimited data, specifies whether to treat the user-specified character as a delimiter. The possible values are:
FALSEDo not treat user-specified characters as delimiters
TRUETreat user-specified characters as delimiters
If this parameter is omitted it defaults to the value last specified from the menu option.
other_charFor delimited data, specifies the user-specified character to be treated as a delimiter. If this parameter is omitted it defaults to the value last specified from the menu option.
field_infoFor delimited data, an array specifying {column number, data format}, repeated as necessary. For fixed width data, an array specifying {start position, data format}, repeated as necessary. For the data format, the possible values are:
1General
2Text
3Date
9Skip
If this parameter is omitted the data format defaults to General.


TEXTREF(text, [a1])

Returns a reference corresponding to the specified text.

textThe string containing the reference.
a1Specifies the style of the reference. The possible values are:
FALSER1C1 style
TRUEA1 style
If this parameter is omitted it defaults to FALSE.


UNDO()

Simulates the Edit Undo menu option.



VLINE([num_rows])

Scrolls the worksheet vertically by the specified number of rows.

num_rowsThe number of rows to scroll. A negative number will scroll towards the top. If this parameter is omitted it defaults to 1.


VPAGE([num_windows])

Scrolls the worksheet vertically by the specified number of pages.

num_windowsThe number of pages to scroll. A negative number will scroll towards the top. If this parameter is omitted it defaults to 1.


VSCROLL(position, [row_logical])

Scrolls the worksheet vertically to the specified position.

positionThe proportional or absolute position to scroll to.
row_logicalWhether the position parameter represents a proportional or absolute row number. The possible values are:
FALSEThe position parameter is a number between 0 and 1 that represents how far down the worksheet to scroll to.
TRUEThe position parameter is a number between 1 and 65536 that represents the row number to scroll to.
If this parameter is omitted it defaults to FALSE.


WORKBOOK.ACTIVATE(sheet_name)

Specifies the sheet that is to be the active worksheet.

sheet_nameThe sheet that is to be the active worksheet.


WORKBOOK.DELETE([sheet_name])

Simulates the Edit Delete Sheet menu option.

sheet_nameThe sheet that is to be deleted. If this parameter is omitted it defaults to the currently active sheet.


WORKBOOK.HIDE([sheet_text], [very_hidden])

Simulates the Format Sheet Hide menu option.

sheet_textThe name of the sheet to hide. If this parameter is omitted it defaults to the currently active sheet.
very_hiddenWhether to show the name of the hidden sheet in the Unhide dialog box. The possible values are:
TRUEDo not show the sheet name
FALSEShow the sheet name
If this parameter is omitted it defaults to FALSE.


WORKBOOK.INSERT([type_num])

Simulates the Insert Worksheet, Chart and Macro sheet menu options.

type_numThe type of sheet that is to be added. The possible values are:
1A worksheet
2A chart
3A macro sheet
If this parameter is omitted it defaults to the type of the currently active sheet.


WORKBOOK.NAME(old_sheet_name, new_sheet_name)

Simulates the Format Sheet Rename menu option.

old_sheet_nameThe sheet that is to be renamed.
new_sheet_nameThe new name for the sheet.


WORKBOOK.NEXT()

Simulates the Ctrl+Page Down key combination.



WORKBOOK.PREV()

Simulates the Ctrl+Page Up key combination.



WORKBOOK.UNHIDE([sheet_text])

Simulates the Format Sheet Unhide menu option.

sheet_textThe name of the sheet to unhide. If this parameter is omitted it defaults to the first hidden sheet.


ZOOM([magnification])

Simulates the Format Sheet Zoom menu option.

magnificationThe magnification option. The possible values are:
numberSet the zoom level to the specified number. The number must be between 10 and 400.
TRUESet the zoom level so that the current selection fills the window.
FALSEReset the zoom level to 100%
If this parameter is omitted it defaults to TRUE.