Microsoft Excel.app terminology

/Applications/Microsoft Office 2011/Microsoft Excel.app

Standard Suite

Common terms for most applications

Commands

  • close -- Close an object
    • reference -- the object to close
    • [saving k.yes / k.no / k.ask] -- specifies whether changes should be saved before closing
    • [saving_in k.Macintosh_path / k.Posix_path] -- the file in which to save the object
  • count -- Return the number of elements of a particular class within an object
    • reference -- the object whose elements are to be counted
    • each type_class -- the class of the elements to be counted.
    • Result: integer -- the number of elements
  • data_size -- Return the size in bytes of an object
    • reference -- the object whose data size is to be returned
    • [as_ type_class] -- the data type for which the size is calculated
    • Result: integer -- the size of the object in bytes
  • delete -- Delete an element from an object
    • reference -- the element to delete
  • duplicate -- Duplicate object(s)
    • reference -- the object(s) to duplicate
    • [to location_reference] -- the new location for the object(s)
    • Result: reference -- to the duplicated object(s)
  • exists -- Verify if an object exists
    • reference -- the object in question
    • Result: boolean -- true if it exists, false if not
  • get -- Get the data for an object
    • reference -- the object whose data is to be returned
    • [as_ list of type_class] -- the desired types for the data, in order of preference
    • Result: anything -- the data from the object
  • make -- Make a new element
    • new type_class -- the class of the new element.
    • at location_reference -- the location at which to insert the element
    • [with_data anything] -- the initial data for the element
    • [with_properties record] -- the initial values for the properties of the element
    • Result: reference -- to the new object(s)
  • move -- Move object(s) to a new location
    • reference -- the object(s) to move
    • to location_reference -- the new location for the object(s)
    • Result: reference -- to the object(s) after they have been moved
  • open -- Open the specified object(s)
    • reference -- list of objects to open
  • print_ -- Print the specified object(s)
    • reference -- list of objects to print
    • [with_properties print_settings] -- the print settings
    • [print_dialog boolean] -- Should Microsoft Excel show the print dialog?
  • quit -- Quit an application program
    • [saving k.yes / k.no / k.ask] -- specifies whether to save currently open documents
  • save -- Save an object
    • reference -- the object to save
    • [in_ k.Macintosh_path / k.Posix_path] -- the file in which to save the object
    • [as_ k.CSV_file_format / k.CSV_Mac_file_format / k.CSV_MSDos_file_format / k.CSV_Windows_file_format / k.DBF3_file_format / k.DBF4_file_format / k.DIF_file_format / k.Excel2_file_format / k.Excel_2_east_asian_file_format / k.Excel3_file_format / k.Excel4_file_format / k.Excel5_file_format / k.Excel7_file_format / k.Excel_4_workbook_file_format / k.international_add_in_file_format / k.international_macro_file_format / k.workbook_normal_file_format / k.SYLK_file_format / k.current_platform_text_file_format / k.text_Mac_file_format / k.text_MSDos_file_format / k.text_printer_file_format / k.text_windows_file_format / k.HTML_file_format / k.XML_spreadsheet_file_format / k.PDF_file_format / k.Excel_binary_file_format / k.Excel_XML_file_format / k.macro_enabled_XML_file_format / k.macro_enabled_template_file_format / k.template_file_format / k.add_in_file_format / k.Excel98to2004_file_format / k.Excel98to2004_template_file_format / k.Excel98to2004_add_in_file_format] -- the file type of the document in which to save the data
  • select -- Make a selection
    • [reference] -- the object to select
  • set -- Set an object's data
    • reference -- the object to change
    • to anything -- the new value

Classes

Microsoft Office Suite

Common classes and commands used throughout all Office applications

Commands

  • add_item_to_combobox -- Add a new string to a custom combobox control.
    • command_bar_combobox
    • combobox_item unicode_text -- The string value to be added.
    • [entry_index short_integer] -- The index where the string is to be added.
  • clear_combobox -- Clear all of the strings form a custom combobox.
  • execute -- Runs the procedure or built-in command assigned to the specified command bar control.
  • get_combobox_item -- Return the string at the given index within a combobox.
    • command_bar_combobox
    • entry_index short_integer -- The index in the combobox where the string to be retrieved is located.
    • Result: unicode_text -- The string associated with the referenced combobox item.
  • get_count_of_combobox_items -- Return the number of strings within a combobox.
  • remove_an_item_from_combobox -- Remove a string from a custom combobox.
    • command_bar_combobox
    • entry_index short_integer -- The index in the combobox where the string to be removed is located.
  • reset -- Resets a built-in command bar or command bar control to its default configuration.
    • k.command_bar / k.command_bar_control
  • set_combobox_item -- Set the string an a given index for a custom combobox.
    • command_bar_combobox
    • entry_index short_integer -- The index where the string is to be set.
    • combobox_item unicode_text -- The string value to be set.

Classes

  • command_bar_button -- A button control within a command bar.
    • Plural name:
      • command_bar_buttons
    • Inherits from:
    • Properties:
      • button_face_is_default (r/o) boolean -- Returns if the face of a command bar button control is the original built-in face.
      • button_state k.button_state_up / k.button_state_down / k.button_state_unset -- Returns or set the appearance of a command bar button control. The property is read-only for built-in command bar buttons.
      • button_style k.button_automatic / k.button_icon / k.button_caption / k.button_icon_and_caption -- Returns or sets the way a command button control is displayed.
      • face_id integer -- Returns or sets the Id number for the face of the command bar button control.
  • command_bar_combobox -- A combobox menu control within a command bar.
    • Plural name:
      • command_bar_comboboxes
    • Inherits from:
    • Properties:
      • combobox_style k.combobox_style_normal / k.combobox_style_label -- Returns or sets the way a command bar combobox control is displayed.
      • combobox_text unicode_text -- Returns or sets the text in the display or edit portion of the command bar combobox control.
      • drop_down_lines integer -- Returns or sets the number of lines in a command bar control combobox control. The combobox control must be a custom control.
      • drop_down_width integer -- Returns or sets the width in pixels of the list for the specified command bar combobox control. An error occurs if you attempt to set this property for a built-in combobox control.
      • list_index integer
  • command_bar_control -- A control within a command bar.
    • Plural name:
      • command_bar_controls
    • Inherits from:
    • Inherited by:
    • Properties:
      • begin_group boolean -- Returns or sets if the command bar control appears at the beginning of a group of controls on the command bar.
      • built_in (r/o) boolean -- Returns true if the command bar control is a built-in command bar control.
      • control_type (r/o) k.control_custom / k.control_button / k.control_edit / k.control_drop_down / k.control_combobox / k.button_drop_down / k.split_drop_down / k.OCX_drop_down / k.generic_drop_down / k.graphic_drop_down / k.control_popup / k.graphic_Popup / k.button_popup / k.split_button_popup / k.split_button_MRU_popup / k.control_label / k.expanding_grid / k.split_expanding_grid / k.control_grid / k.control_gauge / k.graphic_combobox / k.control_pane / k.active_X / k.control_group / k.control_tab / k.control_spinner -- Returns the type of the command bar control.
      • description_text unicode_text -- Returns or sets the description for a command bar control. The description is not displayed to the user, but it can be useful for documenting the behavior of a control.
      • enabled boolean -- Returns or sets if the command bar control is enabled.
      • entry_index (r/o) integer -- Returns the index number for this command bar control.
      • height integer -- Returns or sets the height of a command bar control.
      • help_context_ID integer -- Returns or sets the help context ID number for the Help topic attached to the command bar control.
      • help_file unicode_text -- Returns or sets the file name for the help topic attached to the command bar. To use this property, you must also set the help context ID property.
      • id_ (r/o) integer -- Returns the id for a built-in command bar control.
      • left_position (r/o) integer -- Returns the left position of the command bar control.
      • name unicode_text -- Returns or sets the caption text for a command bar control.
      • parameter unicode_text -- Returns or sets a string that is used to execute a command.
      • priority integer -- Returns or sets the priority of a command bar control. A controls priority determines whether the control can be dropped from a docked command bar if the command bar controls can not fit in a single row. Valid priority number are 0 through 7.
      • tag unicode_text -- Returns or sets information about the command bar control, such as data that can be used as an argument in procedures, or information that identifies the control.
      • tooltip_text unicode_text -- Returns or sets the text displayed in a command bar controls tooltip.
      • top (r/o) integer -- Returns the top position of a command bar control.
      • visible boolean -- Returns or sets if the command bar control is visible.
      • width integer -- Returns or sets the width in pixels of the command bar control.
  • command_bar_popup -- A popup menu control within a command bar.
  • command_bar -- Toolbars used in all of the Office applications.
    • Plural name:
      • command_bars
    • Inherits from:
    • Properties:
      • bar_position k.bar_left / k.bar_top / k.bar_right / k.bar_bottom / k.bar_floating / k.bar_pop_up / k.bar_menu -- Returns or sets the position of the command bar.
      • bar_type (r/o) k.normal_command_bar / k.menubar_command_bar / k.popup_command_bar -- Returns the type of this command bar.
      • built_in (r/o) boolean -- True if the command bar is built-in.
      • context (r/o) unicode_text -- Returns or sets a string that determines where a command bar will be saved.
      • embeddable (r/o) boolean -- Returns if the command bar can be displayed inside the document window.
      • embedded boolean -- Returns or sets if the command bar will be displayed inside the document window.
      • enabled boolean -- Returns or set if the command bar is enabled.
      • entry_index (r/o) integer -- The index of the command bar.
      • height integer -- Returns or sets the height of the command bar.
      • left_position integer -- Returns or sets the left position of the command bar.
      • local_name unicode_text -- Returns or sets the name of the command bar in the localized language of the application. An error is returned when trying to set the local name of a built-in command bar.
      • name unicode_text -- Returns or sets the name of the command bar.
      • protection list -- Returns or sets the way a command bar is protected from user customization. It accepts a list of the following items: no protection, no customize, no resize, no move, no change visible, no change dock, no vertical dock, no horizontal dock.
      • row_index integer -- Returns or sets the docking order of a command bar in relation to other command bars in the same docking area. Can be an integer greater than zero.
      • top integer -- Returns or sets the top position of a command bar.
      • visible boolean -- Returns or sets if the command bar is visible.
      • width integer -- Returns or sets the width in pixels of the command bar.
    • Elements:
  • custom_document_property
  • document_property
    • Plural name:
      • document_properties
    • Inherits from:
    • Inherited by:
    • Properties:
      • document_property_type type_class -- Returns or sets the document property type.
      • link_source unicode_text -- Returns or sets the source of a lined custom document property.
      • link_to_content boolean -- True if the value of the document property is lined to the content of the container document. False if the value is static. This only applies to custom document properties. For built-in properties this is always false.
      • name unicode_text -- Returns or sets the name of the document property.
      • value unicode_text -- Returns or sets the value of the document property.
  • web_page_font
    • Inherits from:
    • Properties:
      • fixed_width_font unicode_text -- Returns or sets the fixed-width font setting.
      • fixed_width_font_size short_float -- Returns or sets the fixed-width font size. You can enter half-point sizes; if you enter other fractional point sizes, they are rounded up or down to the nearest half-point.
      • proportional_font unicode_text -- Returns or sets the proportional font setting.
      • proportional_font_size short_float -- Returns or sets the proportional font size. You can enter half-point sizes; if you enter other fractional point sizes, they are rounded up or down to the nearest half-point.

Microsoft Excel Suite

Excel specific classes and commands

Commands

  • Excel_comment_text -- Returns or sets the text of the comment
    • Excel_comment
    • [text unicode_text] -- The next text for the comment.
    • [start integer] -- The starting point within the existing text that the next test should be placed.
    • [over_write boolean] -- Set to true to over write the existing text of the comment with the new text.
    • Result: unicode_text -- The text of the comment.
  • Excel_repeat -- Repeats the last user-interface action.
  • accept_all_changes -- Accepts all changes in the specified shared workbook.
    • workbook
    • [when unicode_text] -- Specifies when all the changes are accepted.
    • [who unicode_text] -- Specifies by whom all the changes are accepted.
    • [where unicode_text] -- Specifies where all the changes are accepted.
  • activate_next -- Activates the current window, sends it to the back of the window z-order, then activates the next window according to the z-order.
  • activate_object -- Make the object active
    • k.window / k.sheet / k.workbook / k.pane
  • activate_previous -- Activates the specified window and then activates the window at the back of the window z-order.
  • add_chart_autoformat -- Adds a custom chart autoformat to the list of available chart autoformats.
    • chart chart -- A chart that contains the format that will be applied when the new chart autoformat is applied.
    • name unicode_text -- The name of the autoformat.
    • [description unicode_text] -- A description of the custom autoformat.
  • add_colorstop -- Adds ColorStop object to the ColorStops object.
    • colorstops
    • position float -- Represents the position in which to apply the ColorStop.
    • Result: colorstop
  • add_custom_list -- Adds a custom list for custom autofill and/or custom sort.
    • list_array k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_strings -- Specifies the source data, as either an array of strings or a range object.
    • [by_row boolean] -- Only used if list array is a range object. true to create a custom list from each row in the range. false to create a custom list from each column in the range.
  • add_data_field -- Adds a data field to a PivotTable report.
    • pivot_table
    • field null -- The unique field on the server.
    • [caption unicode_text] -- The label used in the PivotTable report to identify this data field.
    • [function unicode_text] -- The function performed in the added data field.
    • Result: pivot_field
  • add_data_validation -- Adds data validation to the specified range.
    • validation
    • type k.validate_input_only / k.validate_whole_number / k.validate_decimal / k.validate_list / k.validated_date / k.validate_time / k.validate_text_length / k.validate_custom -- The validation type.
    • [alert_style k.valid_alert_none / k.valid_alert_stop / k.valid_alert_warning / k.valid_alert_information] -- The validation alert style.
    • [operator k.operator_between / k.operator_not_between / k.operator_equal / k.operator_not_equal / k.operator_greater / k.operator_less / k.operator_greater_equal / k.operator_less_equal] -- The data validation operator.
    • [formula1 unicode_text] -- The first part of the data validation equation.
    • [formula2 unicode_text] -- The second part of the data validation when operator is operator between or operator not between, otherwise, this argument is ignored.
  • add_fields_to_pivot_table -- Adds row, column, and page fields to a pivot table.
    • pivot_table
    • [row_fields list] -- Specifies a list of pivot field names to be added as rows. The list elements are strings.
    • [column_fields list] -- Specifies a list of pivot field names to be added as columns. The list elements are strings.
    • [page_fields list] -- Specifies a list of pivot field names to be added as pages. The list elements are strings.
    • [add_to_table boolean] -- Set to true to add the fields to the pivot table, none of the existing fields are replaced. False to replace existing fields with the new fields. The default value is false.
  • add_item_to_list -- Adds a string to the list control
    • k.listbox / k.dropdown
    • item_text unicode_text -- The string that will be added.
    • [entry_index integer] -- The position in the list to add the string.
  • add_member_property_field -- Adds a member property field to the display for the cube field.
    • cube_field
    • property_ unicode_text -- The unique name of the member property.
    • [property_order unicode_text] -- Sets the PropertyOrder property value for a CubeField object.
    • [property_displayed_in k.display_property_in_pivot_table / k.display_property_in_tooltip / k.display_property_in_pivot_table_and_tooltip]
  • add_page_item -- Adds an additional item to a multiple item page field.
    • pivot_field
    • item_ unicode_text -- Source name of a PivotItem object, corresponding to the specific Online Analytical Processing member unique name.
    • [clear_list unicode_text] -- If False, adds a page item to the existing list. If True, deletes all current items and adds Item.
  • add_sortfield -- Creates a new sort field and returns a sortfields object.
    • sortfields
    • key range -- Specifies a key value for the sort.
    • [sorton k.sort_on_cell_value / k.sort_on_cell_color / k.sort_on_font_color / k.sort_on_icon] -- The field to sort on.
    • [order k.sort_ascending / k.sort_descending / k.sort_manual] -- Specifies the sort order.
    • [customorder anything] -- Specifies if a custom sort order should be used.
    • [dataoption k.sort_normal / k.sort_text_as_numbers] -- Specifies the data option.
  • allocate_change
  • allocate_changes
  • apply_filter -- Apply the defined filter
    • reference
  • apply_sort -- Sorts the range based on the currently applied sort states.
    • reference
  • apply_theme -- Applies a theme or design template to the specified workbook
  • arrange_windows -- Arranges the windows on the screen
    • [arrange_style k.arrange_style_cascade / k.arrange_style_horizontal / k.arrange_style_tiled / k.arrange_style_vertical] -- Specifies the way the windows will be arranged. The default is tiled.
    • [active_workbook boolean] -- Set to true to arrange only the visible windows of the active workbook, false otherwise. The default is false.
    • [sync_horizontal boolean] -- Ignored if active workbook is false. Set to true to synchronize the windows of the active workbook when scrolling horizontally. False to not synchronize the windows. The default value is false.
    • [sync_vertical boolean] -- Ignored if active workbook is false. Set to true to synchronize the windows of the active workbook when scrolling vertically. False to not synchronize the windows. The default value is false.
  • auto_show -- Displays the number of top or bottom items for a row, page, or column field in the specified PivotTable report
    • pivot_field
    • type k.type_automatic / k.type_manual -- Use type_automatic to cause the pivot table to show the items that match the specified criteria. Use type_manual to disable this feature.
    • range k.position_top / k.position_bottom -- The location at which to start showing items.
    • count integer -- The number of items to be shown.
    • field unicode_text -- The name of the base data field.
  • auto_sort -- Establishes automatic pivot table field-sorting rules.
    • pivot_field
    • sort_order k.sort_ascending / k.sort_descending / k.sort_manual -- The sort order.
    • sort_field unicode_text -- The name of the sort key field.
  • break_link -- Converts formulas linked to other Microsoft Excel sources to values.
    • workbook
    • name unicode_text -- The name of the link.
    • type k.link_type_Excel_links / k.link_type_OLE_links -- The type of link.
  • bring_to_front -- Bring the object to the front of the z-order of objects.
    • k.button / k.checkbox / k.option_button / k.scrollbar / k.listbox / k.groupbox / k.dropdown / k.spinner / k.label / k.textbox
  • calculate -- Calculates all open workbooks, a specific worksheet in a workbook, or a specified range of cells on a worksheet..
    • k.application / k.sheet
  • calculate_full -- Forces a full calculation of the data in all open workbooks.
  • calculate_full_rebuild -- For all open workbooks, forces a full calculation of the data and rebuilds the dependencies
  • can_check_in -- Returns True if Excel can check in a specified workbook to a server.
  • can_check_out -- Returns True if Excel can check out a specified workbook from a server.
    • reference
    • file_name unicode_text -- The server path and name of the workbook.
    • Result: boolean
  • cancel_refresh -- Cancels all background queries for the specified query table. Use the refreshing property to determine whether a background query is currently in progress.
  • centimeters_to_points -- Converts a measurement from centimeters to points, one point equals 0.035 centimeters.
    • centimeters_ float -- The centimeter value to be converted.
    • Result: float -- The value in points.
  • change_connection -- Changes the connection of the specified PivotTable.
  • change_file_access -- Changes the access permissions for the workbook. This may require an updated version to be loaded from the disk.
    • workbook
    • mode k.workbook_read_only / k.workbook_read_write -- Specifies the new access mode.
    • [write_password unicode_text] -- Specifies the write-reserved password if the file is write reserved and mode is read write. Ignored if there's no password for the file or if mode is read only.
    • [notify boolean] -- Set to true, or omit, to notify the user if the file cannot be immediately accessed.
  • change_link -- Changes a link from one document to another.
    • workbook
    • name unicode_text -- The name of the Microsoft Excel link to be changed, as it was returned from the link sources method.
    • new_name unicode_text -- The new name of the link.
    • [type k.link_type_Excel_links / k.link_type_OLE_links] -- The link type.
  • change_pivot_cache -- Changes the PivotCache of the specified PivotTable.
    • pivot_table
    • pivot_cache unicode_text -- A PivotTable or PivotCache object that represents the new PivotCache for the specfied PivotTable.
  • change_scenario -- Changes the scenario to have a new set of changing cells and, optionally, scenario values.
    • scenario
    • changing_cells k.range_object / k.A1_style_range_reference / k.named_range -- A range object that specifies the new set of changing cells for the scenario. The changing cells must be on the same sheet as the scenario.
    • [values list] -- A list that contains the new scenario values for the changing cells. If this argument is omitted, the scenario values are assumed to be the current values in the changing cells.
  • check_in -- Returns a workbook from a local computer to a server, and sets the local file to read-only so that it cannot be edited locally.
    • workbook
    • [save_changes boolean] -- True saves the workbook to the server location. The default value is False.
    • [comments unicode_text] -- Comments for the revision of the workbook being checked in. Only applies if SaveChanges equals True.
    • [make_public boolean] -- True allows the user to perform a publish on the workbook after being checked in.
  • check_in_with_version -- Returns a workbook from a local computer to a server, and sets the local file to read-only so that it cannot be edited locally.
    • workbook
    • [save_changes boolean] -- True saves the workbook to the server location. The default value is False.
    • [comments unicode_text] -- Comments for the revision of the workbook being checked in. Only applies if SaveChanges equals True
    • [make_public boolean] -- True allows the user to perform a publish on the workbook after being checked in.
    • [version_type k.minor_version / k.major_version / k.overwrite_current_version] -- Version number of the workbook.
  • check_out -- Copies a specified workbook from a server to a local computer for editing. Returns a String that represents the local path and file name of the workbook checked out.
    • reference
    • file_name unicode_text -- The server path and name of the workbook.
  • check_spelling -- Checks the spelling of an object.
    • k.sheet / k.button / k.checkbox / k.option_button / k.groupbox / k.label / k.textbox
    • [custom_dictionary unicode_text] -- A string that indicates the file name of the custom dictionary to examine if the word isn't found in the main dictionary. If this argument is omitted, the currently specified dictionary is used.
    • [ignore_uppercase boolean] -- Set to true to have Microsoft Excel ignore words that are all uppercase. False to have Microsoft Excel check words that are all uppercase.
    • [always_suggest boolean] -- Set to true to have Microsoft Excel display a list of suggested alternate spellings when an incorrect spelling is found. False to have Microsoft Excel wait for you to input the correct spelling.
  • check_spelling_for -- Checks the spelling of a single word. Returns True if the word is found in one of the dictionaries.
    • text_to_check unicode_text -- The word to be checked.
    • [custom_dictionary unicode_text] -- A string that indicates the file name of the custom dictionary to examine if the word isn't found in the main dictionary. If this argument is omitted, the currently specified dictionary is used.
    • [ignore_uppercase boolean] -- Set to true to have Microsoft Excel ignore words that are all uppercase.
    • Result: boolean
  • circle_invalid -- Circles invalid entries on the worksheet.
  • clear_all_filters -- The ClearAllFilters method deletes all filters currently applied to the PivotTable.
    • k.pivot_table / k.pivot_field
  • clear_arrows -- Clears the tracer arrows from the worksheet. Tracer arrows are added by using the auditing feature.
  • clear_circles -- Clears circles from invalid entries on the worksheet.
  • clear_colorstops -- Clears the represented object.
    • reference
  • clear_contents -- Clears the formulas from the range. Clears the data from a chart but leaves the formatting. Clears all the data, formatting, and formulas from a list object.
  • clear_label_filters -- This method deletes all label filters or all date filters in the PivotFilters collection of the PivotField.
  • clear_manual_filter -- The ClearManualFilter method provides an easy way to set the Visible property to True for all items of a PivotField in PivotTables, and to empty the HiddenItemsList or VisibleItemsList collections in OLAP PivotTables.
    • k.cube_field / k.pivot_field
  • clear_sortfields -- Clears all the sortfields object.
    • reference
  • clear_table -- The ClearTable method is used for clearing a PivotTable.
  • clear_value_filters -- Calling this method deletes all value filters in the PivotFilters collection of the PivotField.
  • commit_changes
  • convert_formula -- Converts cell references in a formula between the A1 and R1C1 reference styles, between relative and absolute references, or both
    • formula_to_convert unicode_text -- A string that contains the formula you want to convert. This must be a valid formula, and it must begin with an equal sign.
    • from_reference_style k.A1 / k.R1C1 -- The reference style of the formula.
    • [to_reference_style k.A1 / k.R1C1] -- The reference style you want returned.
    • [to_absolute k.A1 / k.R1C1] -- Specifies the converted reference type.
    • [relative_to k.range_object / k.A1_style_range_reference / k.named_range] -- A range object that contains one cell. Relative references relate to this cell.
    • Result: unicode_text -- The converted formula
  • convert_to_formulas -- The ConvertToFormulas method is new in 1st_Excel12 and is used for converting a PivotTable to cube formulas.
  • convert_to_range -- Converts a list object to a normal Excel range.
  • copy_object -- Copies the object to the clipboard.
    • k.button / k.checkbox / k.option_button / k.scrollbar / k.listbox / k.groupbox / k.dropdown / k.spinner / k.label / k.textbox
  • copy_picture -- Copies the selected object to the clipboard as a picture.
    • k.button / k.checkbox / k.option_button / k.scrollbar / k.listbox / k.groupbox / k.dropdown / k.spinner / k.label / k.textbox
    • [appearance k.printer / k.screen] -- Specifies how the picture should be copied.
    • [format k.bitmap / k.picture] -- The format of the picture.
  • copy_worksheet -- Copies the sheet to another location in the workbook.
    • sheet
    • [before_ sheet] -- The sheet before which the copied sheet will be placed. You cannot specify before if you specify after.
    • [after_ sheet] -- The sheet after which the copied sheet will be placed. You cannot specify after if you specify before.
  • create_cube_file -- Creates a cube file from a PivotTable report connected to an Online Analytical Processing data source.
    • pivot_table
    • file unicode_text -- The name of the cube file to be created.
    • [measures unicode_text] -- An array of unique names of measures that are to be part of the slice.
    • [levels unicode_text] -- An array of strings. Each array item is a unique level name.
    • [members unicode_text] -- An array of string arrays. The elements correspond, in order, to the hierarchies represented in the Levels array.
    • [properties_ unicode_text] -- False results in no member properties being included in the slice. The default value is True.
    • Result: unicode_text
  • create_new_document -- Creates a new document linked to the specified hyperlink.
    • hyperlink
    • file_name unicode_text -- The file name of the specified document.
    • edit_now boolean -- Set to true to have the specified document open immediately in its associated editing environment.. The default value is true.
    • overwrite boolean -- Set to true to overwrite any existing file of the same name in the same folder. False if any existing file of the same name is preserved and the file name argument specifies a new file name. The default value is false.
  • create_pivot_fields -- The CreatePivotFields method enables users to create all PivotFields of a CubeField.
  • create_pivot_table -- Creates a PivotTable report based on a PivotCache object.
    • pivot_cache
    • table_destination unicode_text
    • [table_name unicode_text]
    • [read_data unicode_text]
    • [default_version unicode_text]
  • create_summary_for_scenarios -- Creates a new worksheet that contains a summary report for the scenarios on the specified worksheet.
    • worksheet
    • [report_type k.summary_pivot_table / k.standard_summary] -- Specifies the report type.
    • [result_cells k.range_object / k.A1_style_range_reference / k.named_range] -- Normally, this range refers to one or more cells containing the formulas that depend on the changing cell values for your model, that is, the cells that show the results of a particular scenario.
  • cut -- Cuts the object to the clipboard.
    • k.button / k.checkbox / k.option_button / k.scrollbar / k.listbox / k.groupbox / k.dropdown / k.spinner / k.label / k.textbox
  • delete -- Deletes the object.
    • k.cube_field / k.calculated_member / k.pivot_filter / k.value_change
  • delete_chart_autoformat -- Removes a custom chart autoformat from the list of available chart autoformats.
    • name unicode_text -- The name of the custom autoformat to be removed.
  • delete_colorstop -- Clears the represented object.
  • delete_custom_list -- Deletes a custom list.
    • list_num integer -- The custom list number. This number must be greater than or equal to 5.
  • delete_number_format -- Deletes a custom number format from the workbook.
    • workbook
    • number_format unicode_text -- Names the number format to be deleted.
  • delete_sortfield -- Removes the specified sortfield object from the SortFields collection.
    • reference
  • discard_change
  • discard_changes
  • double_click -- Equivalent to double-clicking the active cell.
  • drill_to -- The DrillTo method supports drilling to a specified PivotField from another PivotField.
    • k.pivot_field / k.pivot_item
    • field unicode_text
  • evaluate -- Converts a Microsoft Excel name to an object or value.
    • name anything -- The name of the object, using the naming convention of Microsoft Excel.
    • Result: anything -- The resulting object or value.
  • exclusive_access -- Assigns the current user exclusive access to the workbook that's open as a shared list.
    • workbook
    • Result: boolean -- Specifies success or failure.
  • follow -- Displays a cached document, if it's already been downloaded. Otherwise, this method resolves the hyperlink, downloads the target document, and displays the document in the appropriate application.
    • hyperlink
    • [new_window boolean] -- Set to true to display the target application in a new window. The default value is false.
    • [extra_info unicode_text] -- A string that specifies additional information for HTTP to use to resolve the hyperlink. For example, you can use extra info to specify the coordinates of an image map, the contents of a form, or a file name.
    • [method k.append_string / k.post_string] -- Specifies the way extra info is attached.
    • [header_info unicode_text] -- A string that specifies header information for the HTTP request. The default value is an empty string.
  • follow_hyperlink -- Displays a cached document, if it's already been downloaded. Otherwise, this method resolves the hyperlink, downloads the target document, and displays the document in the appropriate application.
    • workbook
    • address unicode_text -- The address of the target document.
    • [sub_address unicode_text] -- The location within the target document. The default value is the empty string.
    • [new_window boolean] -- Set to true to display the target application in a new window. The default value is false.
    • [extra_info unicode_text] -- A string that specifies additional information for HTTP to use to resolve the hyperlink. For example, you can use extra info to specify the coordinates of an image map, the contents of a form, or a file name.
    • [method k.idle / k.greeting / k.goodbye / k.begin_speaking / k.character_success_major / k.get_attention_major / k.get_attention_minor / k.searching / k.printing / k.gesture_right / k.writing_noting_something / k.working_at_something / k.thinking / k.sending_mail / k.listens_to_computer / k.disappear / k.appear / k.get_artsy / k.get_techy / k.get_wizardy / k.checking_something / k.look_down / k.look_down_left / k.look_down_right / k.look_left / k.look_right / k.look_up / k.look_up_left / k.look_up_right / k.saving / k.gesture_down / k.gesture_left / k.gesture_up / k.empty_trash] -- Specifies the way extra info is attached.
    • [header_info unicode_text] -- A string that specifies header information for the HTTP request. The default value is an empty string.
  • get_FileMaker_criteria -- Get the criteria from an existing Excel query that was created against a FileMaker database
  • get_border -- Returns the specified border object.
    • k.format_condition / k.display_format / k.top_10_format_condition / k.above_average_format_condition / k.unique_values_format_condition
    • which_border k.inside_horizontal / k.inside_vertical / k.diagonal_down / k.diagonal_up / k.edge_bottom / k.edge_left / k.edge_right / k.edge_top / k.border_bottom / k.border_left / k.border_right / k.border_top -- This specifies which border object should be retrieved.
    • Result: border
  • get_clipboard_formats -- Returns a list of the formats that are currently on the clipboard.
    • Result: list
  • get_custom_list_contents -- Returns a custom list of strings.
    • list_num integer -- The list number.
    • Result: list
  • get_custom_list_num -- Returns the custom list number for an array of strings. You can use this method to match both built-in lists and custom-defined lists.
    • list_array list -- A list of strings.
    • Result: integer
  • get_dialog -- Returns a the specified dialog object.
    • k.dialog_open / k.dialog_open_links / k.dialog_save_as / k.dialog_file_delete / k.dialog_page_setup / k.dialog_print / k.dialog_printer_setup / k.dialog_arrange_all / k.dialog_window_size / k.dialog_window_move / k.dialog_run / k.dialog_set_print_titles / k.dialog_font / k.dialog_display / k.dialog_protect_document / k.dialog_calculation / k.dialog_extract / k.dialog_data_delete / k.dialog_sort / k.dialog_data_series / k.dialog_table / k.dialog_format_number / k.dialog_alignment / k.dialog_style / k.dialog_border / k.dialog_cell_protection / k.dialog_column_width / k.dialog_clear / k.dialog_paste_special / k.dialog_edit_delete / k.dialog_insert / k.dialog_paste_names / k.dialog_define_name / k.dialog_create_names / k.dialog_formula_goto / k.dialog_formula_find / k.dialog_gallery_area / k.dialog_gallery_bar / k.dialog_gallery_column / k.dialog_gallery_line / k.dialog_gallery_pie / k.dialog_gallery_scatter / k.dialog_combination / k.dialog_gridlines / k.dialog_axes / k.dialog_attach_text / k.dialog_patterns / k.dialog_main_chart / k.dialog_overlay / k.dialog_scale / k.dialog_format_legend / k.dialog_format_text / k.dialog_parse / k.dialog_unhide / k.dialog_workspace / k.dialog_activate / k.dialog_copy_picture / k.dialog_delete_name / k.dialog_delete_format / k.dialog_new / k.dialog_row_height / k.dialog_format_move / k.dialog_format_size / k.dialog_formula_replace / k.dialog_select_special / k.dialog_apply_names / k.dialog_replace_font / k.dialog_split / k.dialog_outline / k.dialog_save_workbook / k.dialog_copy_chart / k.dialog_format_font / k.dialog_note / k.dialog_set_update_status / k.dialog_color_palette / k.dialog_change_link / k.dialog_app_move / k.dialog_app_size / k.dialog_main_chart_type / k.dialog_overlay_chart_type / k.dialog_open_mail / k.dialog_send_mail / k.dialog_standard_font / k.dialog_consolidate / k.dialog_sort_special / k.dialog_gallery_threeD_area / k.dialog_gallery_threeD_column / k.dialog_gallery_threeD_line / k.dialog_gallery_threeD_pie / k.dialog_view_threeD / k.dialog_goal_seek / k.dialog_workgroup / k.dialog_fill_group / k.dialog_update_link / k.dialog_promote / k.dialog_demote / k.dialog_show_detail / k.dialog_object_properties / k.dialog_save_new_object / k.dialog_apply_style / k.dialog_assign_to_object / k.dialog_object_protection / k.dialog_show_toolbar / k.dialog_print_preview / k.dialog_edit_color / k.dialog_format_main / k.dialog_format_overlay / k.dialog_edit_series / k.dialog_define_style / k.dialog_gallery_radar / k.dialog_zoom / k.dialog_insert_object / k.dialog_size / k.dialog_move / k.dialog_format_auto / k.dialog_gallery_threeD_bar / k.dialog_gallery_threeD_surface / k.dialog_customize_toolbar / k.dialog_workbook_add / k.dialog_workbook_move / k.dialog_workbook_copy / k.dialog_workbook_options / k.dialog_save_workspace / k.dialog_chart_wizard / k.dialog_assign_to_tool / k.dialog_placement / k.dialog_fill_workgroup / k.dialog_workbook_new / k.dialog_scenario_cells / k.dialog_scenario_add / k.dialog_scenario_edit / k.dialog_scenario_summary / k.dialog_pivot_table_wizard / k.dialog_pivot_field_properties / k.dialog_options_calculation / k.dialog_options_edit / k.dialog_options_view / k.dialog_add_in_manager / k.dialog_menu_editor / k.dialog_attach_toolbars / k.dialog_options_chart / k.dialog_vba_insert_file / k.dialog_vba_procedure_definition / k.dialog_routing_slip / k.dialog_mail_logon / k.dialog_insert_picture / k.dialog_gallery_doughnut / k.dialog_chart_trend / k.dialog_workbook_insert / k.dialog_options_transition / k.dialog_options_general / k.dialog_filter_advanced / k.dialog_mail_next_letter / k.dialog_data_label / k.dialog_insert_title / k.dialog_font_properties / k.dialog_macro_options / k.dialog_workbook_unhide / k.dialog_workbook_name / k.dialog_gallery_custom / k.dialog_add_chart_autoformat / k.dialog_chart_add_data / k.dialog_tab_order / k.dialog_subtotal_create / k.dialog_workbook_tab_split / k.dialog_workbook_protect / k.dialog_scrollbar_properties / k.dialog_pivot_show_pages / k.dialog_text_to_columns / k.dialog_format_charttype / k.dialog_pivot_field_group / k.dialog_pivot_field_ungroup / k.dialog_checkbox_properties / k.dialog_label_properties / k.dialog_listbox_properties / k.dialog_editbox_properties / k.dialog_open_text / k.dialog_pushbutton_properties / k.dialog_filter / k.dialog_function_wizard / k.dialog_save_copy_as / k.dialog_options_lists_add / k.dialog_series_axes / k.dialog_series_x / k.dialog_series_y / k.dialog_errorbar_x / k.dialog_errorbar_y / k.dialog_format_chart / k.dialog_series_order / k.dialog_mail_edit_mailer / k.dialog_standard_width / k.dialog_scenario_merge / k.dialog_properties / k.dialog_summary_info / k.dialog_find_file / k.dialog_active_cell_font / k.dialog_vba_make_add_in / k.dialog_file_sharing / k.dialog_autocorrect / k.dialog_custom_views / k.dialog_insert_name_label / k.dialog_series_shape / k.dialog_chart_options_data_labels / k.dialog_chart_options_data_table / k.dialog_set_background_picture / k.dialog_data_validation / k.dialog_chart_type / k.dialog_chart_location / k.dialog_chart_source_data / k.dialog_series_options / k.dialog_pivot_table_options / k.dialog_pivot_solve_order / k.dialog_pivot_calculated_field / k.dialog_pivot_calculated_item / k.dialog_conditional_formatting / k.dialog_insert_hyperlink / k.dialog_protect_sharing / k.dialog_phonetic / k.dialog_import_text_file / k.dialog_web_options_general / k.dialog_web_options_pictures / k.dialog_web_options_files / k.dialog_web_options_fonts / k.dialog_web_options_encoding
    • Result: dialog
  • get_file_converters -- Returns a list of all of the file converter objects.
    • Result: list
  • get_international -- Returns information about a specific international setting.
    • data_type k.twenty_four_hour_clock / k.four_digit_years / k.alternate_array_separator / k.column_separator / k.country_code / k.country_setting / k.currency_before / k.currency_code / k.currency_digits / k.currency_leading_zeros / k.currency_minus_sign / k.currency_negative / k.currency_space_before / k.currency_trailing_zeros / k.date_order / k.date_separator / k.day_code / k.day_leading_zero / k.decimal_separator / k.general_format_name / k.hour_code / k.left_brace / k.left_bracket / k.list_separator / k.lower_case_column_letter / k.lower_case_row_letter / k.mdy / k.metric / k.minute_code / k.month_code / k.month_leading_zero / k.month_name_chars / k.noncurrency_digits / k.non_english_functions / k.right_brace / k.right_bracket / k.row_separator / k.second_code / k.thousands_separator / k.time_leading_zero / k.time_separator / k.upper_case_column_letter / k.upper_case_row_letter / k.weekday_name_chars / k.year_code -- The international data to be returned.
    • Result: anything
  • get_list_item -- Returns a string from the list
    • k.listbox / k.dropdown
    • [entry_index integer] -- The index of the string to be returned.
    • Result: unicode_text
  • get_open_filename -- Displays the standard Open dialog box and gets a file name from the user without actually opening any files.
    • [file_filter unicode_text] -- This string is a list of comma-separated file type codes, for example, TEXT,XLA5,XLS4. If omitted, this argument defaults to all file types.
    • [button_text unicode_text] -- Specifies the text used for the open button in the dialog box. If this argument is omitted, the button text is Open.
    • [multi_select boolean] -- Set to true to allow multiple file names to be selected. Set to false to allow only one file name to be selected. The default value is false.
    • Result: unicode_text -- The name of the selected file to open
  • get_pivot_data -- Returns a Range object with information about a data item in a PivotTable report.
    • pivot_table
    • [data_field unicode_text] -- The name of the field containing the data for the PivotTable.
    • [field1 unicode_text] -- The name of a column or row field in the PivotTable report.
    • [item1 unicode_text] -- The name of an item in field1.
    • [field2 unicode_text] -- The name of a column or row field in the PivotTable report.
    • [item2 unicode_text] -- The name of an item in field2.
    • [field3 unicode_text] -- The name of a column or row field in the PivotTable report.
    • [item3 unicode_text] -- The name of an item in field3.
    • [field4 unicode_text] -- The name of a column or row field in the PivotTable report.
    • [item4 unicode_text] -- The name of an item in field4.
    • [field5 unicode_text] -- The name of a column or row field in the PivotTable report.
    • [item5 unicode_text] -- The name of an item in field5.
    • [field6 unicode_text] -- The name of a column or row field in the PivotTable report.
    • [item6 unicode_text] -- The name of an item in field6.
    • [field7 unicode_text] -- The name of a column or row field in the PivotTable report.
    • [item7 unicode_text] -- The name of an item in field7.
    • [field8 unicode_text] -- The name of a column or row field in the PivotTable report.
    • [item8 unicode_text] -- The name of an item in field8.
    • [field9 unicode_text] -- The name of a column or row field in the PivotTable report.
    • [item9 unicode_text] -- The name of an item in field9.
    • [field10 unicode_text] -- The name of a column or row field in the PivotTable report.
    • [item10 unicode_text] -- The name of an item in field10.
    • [field11 unicode_text] -- The name of a column or row field in the PivotTable report.
    • [item11 unicode_text] -- The name of an item in field11.
    • [field12 unicode_text] -- The name of a column or row field in the PivotTable report.
    • [item12 unicode_text] -- The name of an item in field12.
    • [field13 unicode_text] -- The name of a column or row field in the PivotTable report.
    • [item13 unicode_text] -- The name of an item in field13.
    • [field14 unicode_text] -- The name of a column or row field in the PivotTable report.
    • [item14 unicode_text] -- The name of an item in field14.
    • Result: range
  • get_pivot_table_data -- Retrieve data from a pivot table
    • pivot_table
    • name unicode_text -- Describes a single cell in the pivot table, using syntax similar to the pivot select method or the pivot table references in calculated item formulas.
    • Result: float
  • get_previous_selections -- Returns a list of the last four ranges or names selected. Each element in the list is a range object.
    • Result: list
  • get_registered_functions -- Returns information about functions in code resources that were registered with the REGISTER or REGISTER.ID macro functions.
    • Result: list
  • get_save_as_filename -- Displays the standard save as dialog box and gets a file name from the user without actually saving any files.
    • [initial_filename unicode_text] -- Specifies the suggested file name. If this argument is omitted, Microsoft Excel uses the active workbook's name.
    • [file_filter unicode_text] -- This string is a list of comma-separated file type codes, for example, TEXT, XLA5, XLS4. If omitted, this argument defaults to all file types.
    • [filter_index integer] -- This string is a list of comma-separated file type codes, for example, TEXT, XLA5, XLS4. If omitted, this argument defaults to all file types.
    • [button_text unicode_text] -- Specifies the text used for the save button in the dialog box. If this argument is omitted, the button text is Save.
    • Result: unicode_text -- The selected file name.
  • get_subtotals -- Returns subtotals displayed with the specified field. Valid only for nondata fields.
    • pivot_field
    • [subtotal_index k.subtotal_automatic / k.subtotal_sum / k.subtotal_count / k.subtotal_average / k.subtotal_max / k.subtotal_min / k.subtotal_product / k.subtotal_count_numbers / k.subtotal_standard_deviation / k.subtotal_standard_deviation_p / k.subtotal_variable / k.subtotal_variable_p] -- Specifies the subtotal to be returned as follows: 1 automatic, 2 sum, 3 count, 4 average, 5 max, 6 min, 7 product, 8 count nums, 9 StdDev, 10 StdDevp, 11 Var, 12 Varp.
    • Result: boolean
  • get_values -- Returns or sets a list that contains the current values of the changing cells for the scenario.
  • get_visible_fields -- Returns a list of all the visible pivot fields. Visible pivot fields are shown as row, column, page or data fields.
  • get_webpage_font -- Returns the specified web page font object.
    • k.Arabic_character_set / k.Cyrillic_character_set / k.English_character_set / k.Greek_character_set / k.Hebrew_character_set / k.Japanese_character_set / k.Korean_character_set / k.Multilingual_Unicode_character_set / k.Simplified_Chinese_character_set / k.Thai_character_set / k.Traditional_Chinese_character_set / k.Vietnamese_character_set
    • Result: web_page_font
  • goto -- Selects any range in any workbook, and activates that workbook if it's not already active.
    • [reference_ k.range_object / k.A1_style_range_reference / k.named_range] -- The destination. Can be a range object, a string that contains a cell reference in R1C1-style notation. If this argument is omitted, the destination is the last range you used the goto method to select.
    • [scroll boolean] -- Set to true to scroll through the window so that the upper-left corner of the range appears in the upper-left corner of the window. The default is false.
  • help_ -- Displays the Help window.
    • [help_file unicode_text] -- The name of the online Help file to display. If this argument isn't specified, Microsoft Excel Help is displayed.
    • [help_context_id integer] -- Specifies the context ID number for the Help topic to display. If this argument isn't specified, the default topic for the specified Help file is displayed.
  • highlight_changes_options -- Controls how changes are shown in a shared workbook.
    • workbook
    • [when k.since_my_last_save / k.all_changes / k.not_yet_reviewed] -- The changes that are shown.
    • [who unicode_text] -- The user or users whose changes are shown. Can be Everyone, Everyone but Me, or the name of one of the users of the shared workbook.
    • [where k.range_object / k.A1_style_range_reference / k.named_range] -- An A1-style range reference that specifies the area to check for changes.
  • inches_to_points -- Converts a measurement from inches to points.
    • inches_ float -- Specifies the inch value to be converted to points.
    • Result: float -- The value of the inches converted to points.
  • input_box -- Displays a dialog box for user input. Returns the information entered in the dialog box.
    • prompt unicode_text -- The message to be displayed in the dialog box.
    • [title unicode_text] -- The title for the input box. If this argument is omitted, the default title is Input.
    • [default k.range_object / k.A1_style_range_reference / k.named_range / k.input_default_as_string] -- Specifies a value that will appear in the text box when the dialog box is initially displayed. If this argument is omitted, the text box is left empty.
    • [left_position integer] -- Specifies an x position for the dialog box in relation to the upper-left corner of the screen, in points.
    • [top integer] -- Specifies a y position for the dialog box in relation to the upper-left corner of the screen, in points.
    • [type k.a_number / k.input_type_as_string / k.a_number_or_a_string / k.a_bool / k.range_object / k.list_of_numbers / k.list_of_strings / k.list_of_number_or_string / k.list_of_bools / k.list_of_range_objects] -- Specifies what type of data the result should be.
    • Result: reference
  • intersect -- Returns a range object that represents the rectangular intersection of two or more ranges.
    • range1 range -- One of the intersecting ranges.
    • range2 range -- One of the intersecting ranges.
    • [range3 range] -- One of the intersecting ranges.
    • [range4 range] -- One of the intersecting ranges.
    • [range5 range] -- One of the intersecting ranges.
    • [range6 range] -- One of the intersecting ranges.
    • [range7 range] -- One of the intersecting ranges.
    • [range8 range] -- One of the intersecting ranges.
    • [range9 range] -- One of the intersecting ranges.
    • [range10 range] -- One of the intersecting ranges.
    • [range11 range] -- One of the intersecting ranges.
    • [range12 range] -- One of the intersecting ranges.
    • [range13 range] -- One of the intersecting ranges.
    • [range14 range] -- One of the intersecting ranges.
    • [range15 range] -- One of the intersecting ranges.
    • [range16 range] -- One of the intersecting ranges.
    • [range17 range] -- One of the intersecting ranges.
    • [range18 range] -- One of the intersecting ranges.
    • [range19 range] -- One of the intersecting ranges.
    • [range20 range] -- One of the intersecting ranges.
    • [range21 range] -- One of the intersecting ranges.
    • [range22 range] -- One of the intersecting ranges.
    • [range23 range] -- One of the intersecting ranges.
    • [range24 range] -- One of the intersecting ranges.
    • [range25 range] -- One of the intersecting ranges.
    • [range26 range] -- One of the intersecting ranges.
    • [range27 range] -- One of the intersecting ranges.
    • [range28 range] -- One of the intersecting ranges.
    • [range29 range] -- One of the intersecting ranges.
    • [range30 range] -- One of the intersecting ranges.
    • Result: range -- The intersection region of the specified ranges.
  • item_selected -- Returns if a particular item in the list is selected
    • k.listbox / k.dropdown
    • [entry_index integer] -- The index of the string to be checked to see if it is selected..
    • Result: boolean -- Returns true if the items was selected.
  • large_scroll -- Scrolls the contents of the window by pages.
    • k.window / k.pane
    • [down integer] -- The number of pages to scroll the contents down.
    • [up integer] -- The number of pages to scroll the contents up.
    • [to_right integer] -- The number of pages to scroll the contents to the right.
    • [to_left integer] -- The number of pages to scroll the contents to the left.
  • link_info -- Returns the link date and update status.
    • workbook
    • name unicode_text -- The name of the link, as returned from the link sources method.
    • link_info k.edition_date / k.update_state -- The type of information to be returned.
    • [type k.link_info_olelinks / k.link_info_publishers / k.link_info_subscribers] -- The type of link to return.
    • Result: reference
  • link_sources -- Returns a list of links in the workbook. The names in the array are the names of the linked documents. Returns empty if there are no links.
    • workbook
    • [type k.link_type_Excel_links / k.link_type_OLE_links] -- The type of link to return.
    • Result: list
  • list_formulas -- Creates a list of calculated pivot table items and fields on a separate worksheet.
  • make_connection -- Establishes a connection for the specified PivotTable cache.
  • merge_scenarios -- Merges the scenarios from the merge source worksheet into this worksheet
    • worksheet
    • merge_source k.worksheet_object / k.worksheet_name -- The worksheet to merge with.
  • merge_workbook -- Merges changes from one workbook into an open workbook.
    • workbook
    • file_name unicode_text -- The file name of the workbook that contains the changes to be merged into the open workbook.
  • modify -- Modifies data validation for a range.
    • validation
    • [type k.validate_input_only / k.validate_whole_number / k.validate_decimal / k.validate_list / k.validated_date / k.validate_time / k.validate_text_length / k.validate_custom] -- The validation type.
    • [alert_style k.valid_alert_none / k.valid_alert_stop / k.valid_alert_warning / k.valid_alert_information] -- The validation alert style.
    • [operator k.operator_between / k.operator_not_between / k.operator_equal / k.operator_not_equal / k.operator_greater / k.operator_less / k.operator_greater_equal / k.operator_less_equal] -- The data validation operator.
    • [formula1 unicode_text] -- The first part of the data validation equation.
    • [formula2 unicode_text] -- The second part of the data validation when operator is operator between or operator not between, otherwise, this argument is ignored.
  • modify_applies_to_range -- Changes the range that this format condition applies to.
    • k.format_condition / k.color_scale_format_condition / k.databar_format_condition / k.icon_set_format_condition / k.top_10_format_condition / k.above_average_format_condition / k.unique_values_format_condition
    • range range
  • modify_condition -- Modifies an existing conditional format.
    • format_condition
    • type k.cell_value / k.expression / k.color_scale / k.databar / k.top_10 / k.icon_sets / k.unique_values / k.text_string / k.blanks_condition / k.time_period / k.above_average_condition / k.no_blanks_condition / k.errors_condition / k.no_errors_condition -- Specifies whether the conditional format is based on a cell value or an expression.
    • [operator k.operator_between / k.operator_not_between / k.operator_equal / k.operator_not_equal / k.operator_greater / k.operator_less / k.operator_greater_equal / k.operator_less_equal] -- The conditional format operator.
    • [formula1 unicode_text] -- The value or expression associated with the conditional format.
    • [formula2 unicode_text] -- he value or expression associated with the second part of the conditional format when operator is operator between or operator not between.
    • [string_ unicode_text]
    • [operator2 k.operator_between / k.operator_not_between / k.operator_equal / k.operator_not_equal / k.operator_greater / k.operator_less / k.operator_greater_equal / k.operator_less_equal] -- The conditional format operator.
  • modify_condition_value -- Modifies an existing condition value.
    • condition_value
    • type k.condition_value_none / k.condition_value_number / k.condition_value_lowest_value / k.condition_value_highest_value / k.condition_value_percent / k.condition_value_formula / k.condition_value_percentile / k.condition_value_automatic_minimum / k.condition_value_automatic_maximum -- Specifies whether the conditional format is based on a cell value or an expression.
    • [condition_value anything] -- The value or expression associated with the conditional format.
  • modify_sort_key -- Modify the key value by which values are sorted in the field.
  • new_window_on_workbook -- Creates a new window or a copy of the specified workbook window.
  • next_Excel_comment -- Returns the next Excel comment object
  • on_key -- Runs a specified procedure when a particular key or key combination is pressed.
    • key string -- Specifies the key to bind the procedure to.
    • [command_key_pressed boolean] -- Specifies if the command key needs to pressed as well and the key specified by the key argument.
    • [shift_key_pressed boolean] -- Specifies if the shift key needs to pressed as well and the key specified by the key argument.
    • [option_key_pressed boolean] -- Specifies if the option key needs to pressed as well and the key specified by the key argument.
    • [control_key_pressed boolean] -- Specifies if the control key needs to pressed as well and the key specified by the key argument.
    • [procedure k.script_ / k.script_Text] -- A string containing AppleScript commands. If this argument is empty nothing happens when key is pressed. If procedure is omitted, key reverts to its normal result in Microsoft Excel.
  • open_FileMaker_file -- Open a FileMaker file as an Excel worksheet.
    • filename unicode_text -- Specifies the file name of the FileMaker file to be opened.
  • open_data_base -- Open a data base
    • reference
    • filename unicode_text
    • [command_text unicode_text]
    • [rcommand_type integer]
    • [back_ground_query null]
    • [import_data_as integer]
  • open_links -- Opens the supporting documents for a link or links.
    • workbook
    • name unicode_text -- The name of the Microsoft Excel link, as returned from the link sources method.
    • [read_only boolean] -- Set to true to open documents as read-only. The default value is false.
    • [type k.link_type_Excel_links / k.link_type_OLE_links] -- The link type.
  • open_text_file -- Loads and parses a text file as a new workbook with a single sheet that contains the parsed text-file data.
    • filename unicode_text -- Specifies the file name of the text file to be opened and parsed.
    • [origin k.Macintosh / k.MSDos / k.MSWindows] -- Specifies the origin of the text file.
    • [start_row integer] -- The row number at which to start parsing text. The default is 1.
    • [data_type k.delimited / k.fixed_width] -- Specifies the column format of the data in the file.
    • [text_qualifier k.text_qualifier_double_quote / k.text_qualifier_none / k.text_qualifier_single_quote] -- Specifies the text qualifier
    • [consecutive_delimiter boolean] -- Set to true to have consecutive delimiters considered one delimiter. The default is false.
    • [tab boolean] -- Set to true to have the tab character be the delimiter. The default is false.
    • [semicolon boolean] -- Set to true to have the semicolon character be the delimiter. The default is false.
    • [comma boolean] -- Set to true to have the comma character be the delimiter. The default is false.
    • [space boolean] -- Set to true to have the comma character be the delimiter. The default is false.
    • [use_other boolean] -- Set to true to have the character specified by the other char argument be the delimiter. The data type argument must be delimited. The default is false.
    • [other_char unicode_text] -- This is required if the use other argument is true. Specifies the delimiter character when Other is true. If more than one character is specified, only the first character of the string is used, the remaining characters are ignored.
    • [field_info list] -- A list contain parse information for the individual columns of data. Formats are general format, text format, MDY format, DMY format, YMD format, MYD format, DYM format, YDM format, skip column.
    • [decimal_separator unicode_text] -- The decimal separator that Microsoft Excel uses when recognizing numbers. The default setting is the system setting.
    • [thousands_separator unicode_text] -- The thousands separator that Excel uses when recognizing numbers. The default setting is the system setting.
  • open_workbook -- Opens a workbook.
    • workbook_file_name unicode_text -- The name of the file containing the workbook to be opened.
    • [update_links k.do_not_update_links / k.update_external_links_only / k.update_remote_links_only / k.update_remote_and_external_links] -- Specifies the way links in the file are updated. If this argument is omitted, the user is prompted to specify how links will be updated.
    • [read_only boolean] -- Set to true to open the workbook in read-only mode.
    • [format k.tab_delimiter / k.commas_delimiter / k.spaces_delimiter / k.semicolon_delimiter / k.no_delimiter / k.custom_character_delimiter] -- If Microsoft Excel is opening a text file, this argument specifies the delimiter character. If this argument is omitted, the current delimiter is used.
    • [password unicode_text] -- A string that contains the password required to open a protected workbook. If this argument is omitted and the workbook requires a password, the user is prompted for the password.
    • [write_reserved_password unicode_text] -- A string that contains the password required to write to a write-reserved workbook. If this argument is omitted and the workbook requires a password, the user will be prompted for the password.
    • [ignore_read_only_recommended boolean] -- Set to true to have Microsoft Excel not display the read-only recommended message if the workbook was saved with the read-only recommended option.
    • [origin k.Macintosh / k.MSDos / k.MSWindows] -- If the file is a text file, this argument indicates where it originated so that code pages and Carriage return/line feed, CR/LF can be mapped correctly.
    • [delimiter unicode_text] -- If the file is a text file and the format argument is custom character delimiter, this argument is a string that specifies the character to be used as the delimiter.
    • [editable boolean] -- If the file is a Microsoft Excel 4.0 add-in, this argument is true to open the add-in so that it's a visible window. If the file isn't an add-in, true prevents the running of any Auto_Open macros.
    • [notify boolean] -- If the file cannot be opened in read/write mode, this argument is true to add the file to the file notification list. Excel will open the file as read-only, poll the file notification list, and then notify the user when the file becomes available.
    • [converter integer] -- The index of the first file converter to try when opening the file. The specified file converter is tried first, if this converter doesn't recognize the file, all other converters are tried.
    • [add_to_mru boolean] -- Set to true to add this workbook to the list of recently used files. The default value is false.
    • Result: workbook -- A workbook object for the newly opened workbook.
  • open_xml -- Open an XML file
    • reference
    • filename unicode_text
    • [style_sheets integer]
    • [load_option integer]
  • paste_special_on_worksheet -- Pastes the contents of the clipboard onto the sheet, using a specified format. Use this method to paste data from other applications or to paste data in a specific format.
    • sheet
    • [format unicode_text] -- A string that specifies the clipboard format of the data.
    • [link boolean] -- Set to true to establish a link to the source of the pasted data. If the source data isn't suitable for linking or the source application doesn't support linking, this parameter is ignored. The default value is false.
    • [display_as_icon boolean] -- Set to true to display the pasted as an icon. The default value is false.
    • [icon_file_name unicode_text] -- The name of the file that contains the icon to use if display as icon is true
    • [icon_index integer] -- The index number of the icon within the icon file.
    • [icon_label unicode_text] -- The text label of the icon.
    • [no_HTML_formatting boolean] -- Set to true to remove all formatting, hyperlinks, and images from HTML. Set to false to paste HTML as is. The default value is false.
  • paste_worksheet -- Pastes the contents of the Clipboard onto the sheet.
    • sheet
    • [destination k.range_object / k.A1_style_range_reference / k.named_range] -- A range object that specifies where the clipboard contents should be pasted. If this argument is omitted, the current selection is used.
    • [link boolean] -- Set to true to establish a link to the source of the pasted data. If this argument is specified, the destination argument cannot be used. The default value is false.
  • pivot_select -- Selects part of a pivot table.
    • pivot_table
    • name unicode_text -- The selection, in standard pivot table selection format.
    • mode k.selection_mode_label_only / k.selection_mode_data_and_label / k.selection_mode_data_only / k.selection_mode_origin / k.selection_mode_button / k.selection_mode_blanks -- Specifies the structured selection mode.
  • previous_Excel_comment -- Returns the previous Excel comment object
  • print_out -- Prints the object
    • k.window / k.sheet / k.workbook
    • [from_ integer] -- The number of the page at which to start printing. If this argument is omitted, printing starts at the beginning.
    • [to integer] -- The number of the last page to print. If this argument is omitted, printing ends with the last page.
    • [copies integer] -- The number of copies to print. If this argument is omitted, one copy is printed.
    • [preview boolean] -- Set to true to have Microsoft Excel invoke print preview before printing the object.
    • [active_printer unicode_text] -- Sets the name of the active printer.
    • [print_to_file boolean] -- Set to true to print to a file.
    • [collate boolean] -- Set to true to collate multiple copies.
  • print_preview -- Shows a preview of the object as it would look when printed. This function has been deprecated.
    • k.window / k.sheet / k.workbook
    • [enable_changes boolean] -- Controls access to the page setup dialog and the ability to change margins from the preview window by enabling or disabling the setup and margins buttons, respectively.
  • protect_sharing -- Saves the workbook and protects it for sharing.
    • workbook
    • [file_name unicode_text] -- A string indicating the name of the saved file. You can include a full path. If you don't, Microsoft Excel saves the file in the current folder.
    • [password unicode_text] -- A case-sensitive string indicating the protection password to be given to the file. Should be no longer than 15 characters.
    • [write_reservation_password unicode_text] -- A string indicating the write-reservation password for this file. If a file is saved with the password and the password isn't supplied when the file is opened, the file is opened read-only.
    • [read_only_recommended boolean] -- Set to true to display a message when the file is opened, recommending that the file be opened read-only.
    • [create_backup boolean] -- Set to true to create a backup file.
    • [sharing_password unicode_text] -- A string indicating the password to be used to protect the file for sharing.
    • [file_format k.CSV_file_format / k.CSV_Mac_file_format / k.CSV_MSDos_file_format / k.CSV_Windows_file_format / k.DBF3_file_format / k.DBF4_file_format / k.DIF_file_format / k.Excel2_file_format / k.Excel_2_east_asian_file_format / k.Excel3_file_format / k.Excel4_file_format / k.Excel5_file_format / k.Excel7_file_format / k.Excel_4_workbook_file_format / k.international_add_in_file_format / k.international_macro_file_format / k.workbook_normal_file_format / k.SYLK_file_format / k.current_platform_text_file_format / k.text_Mac_file_format / k.text_MSDos_file_format / k.text_printer_file_format / k.text_windows_file_format / k.HTML_file_format / k.XML_spreadsheet_file_format / k.PDF_file_format / k.Excel_binary_file_format / k.Excel_XML_file_format / k.macro_enabled_XML_file_format / k.macro_enabled_template_file_format / k.template_file_format / k.add_in_file_format / k.Excel98to2004_file_format / k.Excel98to2004_template_file_format / k.Excel98to2004_add_in_file_format] -- A enum indicating the format of the file for sharing.
  • protect_workbook -- Protect workbook structure from changes.
    • workbook
    • [password unicode_text] -- A string that specifies a case-sensitive password for the sheet or workbook. If this argument is omitted, you can unprotect the sheet or workbook without using a password. Otherwise, you must specify the password to unprotect the sheet or workbook.
    • [structure boolean] -- Set to true to protect the structure of the workbook, the relative position of the sheets. The default value is true.
    • [windows boolean] -- Set to true to protect the workbook windows. If this argument is omitted, the windows aren't protected.
  • protect_worksheet -- Protects a worksheet so that it cannot be modified.
    • sheet
    • [password unicode_text] -- A string that specifies a case-sensitive password for the sheet or workbook. If this argument is omitted, you can unprotect the sheet or workbook without using a password. Otherwise, you must specify the password to unprotect the sheet or workbook.
    • [drawing_objects boolean] -- Set to true to protect shapes. The default value is false.
    • [worksheet_contents boolean] -- Set to true to protect contents. The default value is true.
    • [scenarios boolean] -- Set to true to protect scenarios. The default value is true.
    • [user_interface_only boolean] -- Set to true to protect the user interface, but not macros. If this argument is omitted, protection applies both to macros and to the user interface.
    • [allow_formatting_cells boolean] -- Set to true to allow user format cells. The default value is false.
    • [allow_formatting_columns boolean] -- Set to true to allow user format columns. The default value is false.
    • [allow_formatting_rows boolean] -- Set to true to allow user format rows. The default value is false.
    • [allow_inserting_columns boolean] -- Set to true to allow user insert columns. The default value is false.
    • [allow_inserting_rows boolean] -- Set to true to allow user insert rows. The default value is false.
    • [allow_inserting_hyperlinks boolean] -- Set to true to allow user insert hyperlinks. The default value is false.
    • [allow_deleting_columns boolean] -- Set to true to allow user delete columns. The default value is false.
    • [allow_deleting_rows boolean] -- Set to true to allow user delete rows. The default value is false.
    • [allow_sorting boolean] -- Set to true to allow user sort. The default value is false.
    • [allow_filtering boolean] -- Set to true to allow user use autofilter. The default value is false.
    • [allow_using_pivot_table boolean] -- Set to true to allow user use pivotTable reports. The default value is false.
  • purge_change_history_now -- Removes entries from the change log for the specified workbook.
    • workbook
    • days integer -- The number of days that changes in the change log are to be retained.
    • [sharing_password unicode_text] -- The password that unprotects the workbook for sharing. If the workbook is protected for sharing with a password and this argument is omitted, the user is prompted for the password.
  • refresh -- Updates the pivot table cache or query table.
  • refresh_all -- Refreshes all external data ranges and PivotTables in the workbook.
  • refresh_data_source_values
  • refresh_query_table -- Updates the PivotTable cache or query table.
    • query_table
    • [background_query boolean] -- Set to true to return control to the procedure as soon as a database connection is made and the query is submitted and the query is updated in the background.
    • Result: boolean
  • refresh_table -- Refreshes the pivot table from the source data. Returns true if it's successful.
  • register_xll -- Loads an XLL code resource and automatically registers the functions and commands contained in the resource.
    • filename unicode_text -- The file name containing the XLL code resource.
    • Result: boolean -- Specifies success or failure.
  • reject_all_changes -- Rejects all changes in the specified shared workbook.
    • workbook
    • [when unicode_text] -- Specifies when all the changes are rejected.
    • [who unicode_text] -- Specifies by whom all the changes are rejected.
    • [where unicode_text] -- Specifies where all the changes are rejected.
  • remove_all_items -- Removes all of the strings from the list
    • k.listbox / k.dropdown
  • remove_item -- Removes a specified string from the list
    • k.listbox / k.dropdown
    • entry_index integer -- The index of the string to be removed.
    • [count integer] -- The number of string starting a the index that should be removed. The default is one.
  • remove_user -- Disconnects the specified user from the shared workbook.
    • workbook
    • entry_index integer -- The user index.
  • repeat_all_labels
    • pivot_table
    • repeat k.do_not_repeat_labels / k.repeat_labels
  • reset_all_page_breaks -- Resets all page breaks on the specified worksheet.
  • reset_colors -- Resets the color palette to the default colors.
  • reset_timer -- Resets the refresh timer for the specified PivotTable report to the last interval you set using the RefreshPeriod property.
    • k.pivot_cache / k.query_table
  • resize
  • row_axis_layout -- This method is used for simultaneously setting layout options for all existing PivotFields.
    • pivot_table
    • layout k.compact_row / k.tabular_row / k.outline_row -- Can be xlCompactRow, xlTabularRow, or xlOutlineRow.
  • run_VB_Macro -- Runs a macro or calls a function. This can be used to run a macro written in the Microsoft Excel 4.0 macro language, or to run a function in a DLL or XLL.
    • k.range_object / k.A1_style_range_reference / k.named_range
    • [arg1 anything] -- An argument to be passed to the macro.
    • [arg2 anything] -- An argument to be passed to the macro.
    • [arg3 anything] -- An argument to be passed to the macro.
    • [arg4 anything] -- An argument to be passed to the macro.
    • [arg5 anything] -- An argument to be passed to the macro.
    • [arg6 anything] -- An argument to be passed to the macro.
    • [arg7 anything] -- An argument to be passed to the macro.
    • [arg8 anything] -- An argument to be passed to the macro.
    • [arg9 anything] -- An argument to be passed to the macro.
    • [arg10 anything] -- An argument to be passed to the macro.
    • [arg11 anything] -- An argument to be passed to the macro.
    • [arg12 anything] -- An argument to be passed to the macro.
    • [arg13 anything] -- An argument to be passed to the macro.
    • [arg14 anything] -- An argument to be passed to the macro.
    • [arg15 anything] -- An argument to be passed to the macro.
    • [arg16 anything] -- An argument to be passed to the macro.
    • [arg17 anything] -- An argument to be passed to the macro.
    • [arg18 anything] -- An argument to be passed to the macro.
    • [arg19 anything] -- An argument to be passed to the macro.
    • [arg20 anything] -- An argument to be passed to the macro.
    • [arg21 anything] -- An argument to be passed to the macro.
    • [arg22 anything] -- An argument to be passed to the macro.
    • [arg23 anything] -- An argument to be passed to the macro.
    • [arg24 anything] -- An argument to be passed to the macro.
    • [arg25 anything] -- An argument to be passed to the macro.
    • [arg26 anything] -- An argument to be passed to the macro.
    • [arg27 anything] -- An argument to be passed to the macro.
    • [arg28 anything] -- An argument to be passed to the macro.
    • [arg29 anything] -- An argument to be passed to the macro.
    • [arg30 anything] -- An argument to be passed to the macro.
    • Result: unicode_text -- The result of the macro call.
  • run_XLM_Macro -- Runs a macro or calls a function. This can be used to run a macro written in the Microsoft Excel 4.0 macro language, or to run a function in a DLL or XLL.
    • k.range_object / k.A1_style_range_reference / k.named_range
    • [arg1 anything] -- An argument to be passed to the macro.
    • [arg2 anything] -- An argument to be passed to the macro.
    • [arg3 anything] -- An argument to be passed to the macro.
    • [arg4 anything] -- An argument to be passed to the macro.
    • [arg5 anything] -- An argument to be passed to the macro.
    • [arg6 anything] -- An argument to be passed to the macro.
    • [arg7 anything] -- An argument to be passed to the macro.
    • [arg8 anything] -- An argument to be passed to the macro.
    • [arg9 anything] -- An argument to be passed to the macro.
    • [arg10 anything] -- An argument to be passed to the macro.
    • [arg11 anything] -- An argument to be passed to the macro.
    • [arg12 anything] -- An argument to be passed to the macro.
    • [arg13 anything] -- An argument to be passed to the macro.
    • [arg14 anything] -- An argument to be passed to the macro.
    • [arg15 anything] -- An argument to be passed to the macro.
    • [arg16 anything] -- An argument to be passed to the macro.
    • [arg17 anything] -- An argument to be passed to the macro.
    • [arg18 anything] -- An argument to be passed to the macro.
    • [arg19 anything] -- An argument to be passed to the macro.
    • [arg20 anything] -- An argument to be passed to the macro.
    • [arg21 anything] -- An argument to be passed to the macro.
    • [arg22 anything] -- An argument to be passed to the macro.
    • [arg23 anything] -- An argument to be passed to the macro.
    • [arg24 anything] -- An argument to be passed to the macro.
    • [arg25 anything] -- An argument to be passed to the macro.
    • [arg26 anything] -- An argument to be passed to the macro.
    • [arg27 anything] -- An argument to be passed to the macro.
    • [arg28 anything] -- An argument to be passed to the macro.
    • [arg29 anything] -- An argument to be passed to the macro.
    • [arg30 anything] -- An argument to be passed to the macro.
    • Result: unicode_text -- The result of the macro call.
  • save_as -- Saves changes into a different file.
    • sheet
    • filename unicode_text -- A string that indicates the name of the file to be saved. You can include a full path. If you don't, Microsoft Excel saves the file in the current folder.
    • [file_format k.CSV_file_format / k.CSV_Mac_file_format / k.CSV_MSDos_file_format / k.CSV_Windows_file_format / k.DBF3_file_format / k.DBF4_file_format / k.DIF_file_format / k.Excel2_file_format / k.Excel_2_east_asian_file_format / k.Excel3_file_format / k.Excel4_file_format / k.Excel5_file_format / k.Excel7_file_format / k.Excel_4_workbook_file_format / k.international_add_in_file_format / k.international_macro_file_format / k.workbook_normal_file_format / k.SYLK_file_format / k.current_platform_text_file_format / k.text_Mac_file_format / k.text_MSDos_file_format / k.text_printer_file_format / k.text_windows_file_format / k.HTML_file_format / k.XML_spreadsheet_file_format / k.PDF_file_format / k.Excel_binary_file_format / k.Excel_XML_file_format / k.macro_enabled_XML_file_format / k.macro_enabled_template_file_format / k.template_file_format / k.add_in_file_format / k.Excel98to2004_file_format / k.Excel98to2004_template_file_format / k.Excel98to2004_add_in_file_format] -- Specifies the file format to use when you save the file.
    • [password unicode_text] -- A case-sensitive string, no more than 15 characters, that indicates the protection password to be given to the file.
    • [write_reservation_password unicode_text] -- A string that indicates the write-reservation password for this file. If a file is saved with the password and the password isn't supplied when the file is opened, the file is opened as read-only.
    • [read_only_recommended boolean] -- Set to true to display a message when the file is opened, recommending that the file be opened as read-only.
    • [create_backup boolean] -- Set to true to create a backup file.
    • [add_to_most_recently_used_list boolean] -- Set to true to add this workbook to the list of recently used files. The default value is false.
    • [overwrite boolean] -- Set to true to automatically overwrite an existing file.
    • [save_as_local_language boolean] -- True saves files against the language of Microsoft Excel. False is the default, which saves files against the language of Visual Basic for Applications
  • save_as_ODC -- Saves the PivotTable cache source as a Microsoft Office Data Connection file.
    • pivot_table
    • ODC_file_name unicode_text -- Location to save the file.
    • [description unicode_text] -- Description that will be saved in the file.
    • [keywords unicode_text] -- Space-separated keywords that can be used to search for this file.
  • save_workbook_as -- Saves changes into a different file.
    • workbook
    • [filename unicode_text] -- A string that indicates the name of the file to be saved. You can include a full path. If you don't, Microsoft Excel saves the file in the current folder.
    • [file_format k.CSV_file_format / k.CSV_Mac_file_format / k.CSV_MSDos_file_format / k.CSV_Windows_file_format / k.DBF3_file_format / k.DBF4_file_format / k.DIF_file_format / k.Excel2_file_format / k.Excel_2_east_asian_file_format / k.Excel3_file_format / k.Excel4_file_format / k.Excel5_file_format / k.Excel7_file_format / k.Excel_4_workbook_file_format / k.international_add_in_file_format / k.international_macro_file_format / k.workbook_normal_file_format / k.SYLK_file_format / k.current_platform_text_file_format / k.text_Mac_file_format / k.text_MSDos_file_format / k.text_printer_file_format / k.text_windows_file_format / k.HTML_file_format / k.XML_spreadsheet_file_format / k.PDF_file_format / k.Excel_binary_file_format / k.Excel_XML_file_format / k.macro_enabled_XML_file_format / k.macro_enabled_template_file_format / k.template_file_format / k.add_in_file_format / k.Excel98to2004_file_format / k.Excel98to2004_template_file_format / k.Excel98to2004_add_in_file_format] -- Specifies the file format to use when you save the file.
    • [password unicode_text] -- A case-sensitive string, no more than 15 characters, that indicates the protection password to be given to the file.
    • [write_reservation_password unicode_text] -- A string that indicates the write-reservation password for this file. If a file is saved with the password and the password isn't supplied when the file is opened, the file is opened as read-only.
    • [read_only_recommended boolean] -- Set to true to display a message when the file is opened, recommending that the file be opened as read-only.
    • [create_backup boolean] -- Set to true to create a backup file.
    • [access_mode k.exclusive / k.no_change / k.shared] -- Specifies the access mode for the new file.
    • [conflict_resolution k.local_session_changes / k.other_session_changes / k.user_resolution] -- Specifies who conflict resolutions will be handled.
    • [add_to_most_recently_used_list boolean] -- Set to true to add this workbook to the list of recently used files. The default value is false.
    • [overwrite boolean] -- Set to true to automatically overwrite an existing file.
  • save_workspace -- Saves the current workspace.
    • [workspace_file_name unicode_text] -- The saved file name.
  • scroll_workbook_tabs -- Scrolls through the workbook tabs at the bottom of the window. Doesn't affect the active sheet in the workbook.
    • window
    • [sheets integer] -- The number of sheets to scroll by. Use a positive number to scroll forward, a negative number to scroll backward, or 0 to not scroll at all. You must specify sheets if you don't specify position.
    • [position k.scroll_tab_position_first / k.scroll_tab_position_last] -- Specifies the sheet to scroll to. You must specify position if you don't specify sheets.
  • send_html_mail -- Opens a message window in Microsoft Outlook for sending the specified document, formatted as html.
  • send_mail -- Opens a message window in your registered mail program for sending the specified document as an attachment.
  • send_to_back -- Sends the object to the back of the z-order.
    • k.button / k.checkbox / k.option_button / k.scrollbar / k.listbox / k.groupbox / k.dropdown / k.spinner / k.label / k.textbox
  • set_FileMaker_criteria
    • query_table
    • criteria_index integer
    • field_name unicode_text
    • operator k.criteria_equals / k.criteria_less_than_or_equal_to / k.criteria_greater_than_or_equal_to / k.criteria_less_than / k.criteria_greater_than / k.criteria_begins_with / k.criteria_ends_with / k.criteria_contains
    • clause_text unicode_text
    • condition k.no_condition / k.and_condition / k.or_condition
  • set_background_picture -- Sets the background graphic for a worksheet.
    • sheet
    • [picture_file_name unicode_text] -- The name of the graphic file.
  • set_first_priority -- Sets this condition to the highest priority.
    • k.format_condition / k.color_scale_format_condition / k.databar_format_condition / k.icon_set_format_condition / k.top_10_format_condition / k.above_average_format_condition / k.unique_values_format_condition
  • set_last_priority -- Sets this condition to the lowest priority.
    • k.format_condition / k.color_scale_format_condition / k.databar_format_condition / k.icon_set_format_condition / k.top_10_format_condition / k.above_average_format_condition / k.unique_values_format_condition
  • set_list_item -- Set a string in the list
    • k.listbox / k.dropdown
    • [entry_index integer] -- The index of the string to be set.
    • item_text unicode_text -- The new text to be set.
  • set_sort_range -- Sets the starting and ending character positions for Sort object.
    • sort
    • rng range -- Specifies the range for the sort object.
  • set_subtotals -- Sets subtotals displayed with the specified field. Valid only for nondata fields.
    • pivot_field
    • [subtotal_index k.automatic_subtotal / k.sum_subtotal / k.count_subtotal / k.average_subtotal / k.maximum_value / k.minimum_value / k.product_subtotal / k.count_numbers_subtotal / k.standard_deviation / k.standard_deviation_P / k.variance_subtotal / k.variance_P_subtotal] -- Specifies the subtotal to be set as follows: 1 automatic, 2 sum, 3 count, 4 average, 5 max, 6 min, 7 product, 8 count nums, 9 StdDev, 10 StdDevp, 11 Var, 12 Varp.
    • value boolean -- Specifies the subtotal to be set as follows: 1 automatic, 2 sum, 3 count, 4 average, 5 max, 6 min, 7 product, 8 count nums, 9 StdDev, 10 StdDevp, 11 Var, 12 Varp.
  • show -- Displays the built-in dialog box and waits for the user to input data.
    • k.dialog / k.scenario
  • show_all -- Show all the hidden data, but do not exist the filter mode
    • reference
  • show_all_data -- Makes all rows of the currently filtered list visible. If autofilter is in use, this method changes the arrows to All.
  • show_custom_view -- Displays the custom view
  • show_data_form -- Displays the data form associated with the worksheet.
  • show_levels -- Displays the specified number of row and/or column levels of an outline.
    • outline
    • [row_levels integer] -- Specifies the number of row levels of an outline to display. If the outline has fewer levels than the number specified, Microsoft Excel displays all the levels. If this argument is zero or is omitted, no action is taken on rows.
    • [column_levels integer] -- Specifies the number of column levels of an outline to display. If the outline has fewer levels than the number specified, Microsoft Excel displays all the levels. If this argument is zero or is omitted, no action is taken on columns.
  • show_pages -- Creates a new pivot table for each item in the page field. Each new pivot table is created on a new worksheet.
    • pivot_table
    • [page_field unicode_text] -- A string that names a single page field in the pivot table.
  • small_scroll -- Scrolls the contents of the window by rows or columns.
    • k.window / k.pane
    • [down integer] -- The number of rows to scroll the contents down.
    • [up integer] -- The number of rows to scroll the contents up.
    • [to_right integer] -- The number of rows to scroll the contents to the right.
    • [to_left integer] -- The number of rows to scroll the contents to the left.
  • subtotal_location -- This method changes the subtotal location for all existing PivotFields.
    • pivot_table
    • location k.at_top / k.at_bottom -- xlSubtotalLocationType can be either xlAtTop or xlAtBottom.
  • toggle_forms_design -- Toggles Microsoft Office Excel into and out of design mode.
  • undo -- Cancels the last user-interface action.
  • union -- Returns the union of two or more ranges.
    • range1 range -- One of the ranges that will be put into the union range.
    • range2 range -- One of the ranges that will be put into the union range.
    • [range3 range] -- One of the ranges that will be put into the union range.
    • [range4 range] -- One of the ranges that will be put into the union range.
    • [range5 range] -- One of the ranges that will be put into the union range.
    • [range6 range] -- One of the ranges that will be put into the union range.
    • [range7 range] -- One of the ranges that will be put into the union range.
    • [range8 range] -- One of the ranges that will be put into the union range.
    • [range9 range] -- One of the ranges that will be put into the union range.
    • [range10 range] -- One of the ranges that will be put into the union range.
    • [range11 range] -- One of the ranges that will be put into the union range.
    • [range12 range] -- One of the ranges that will be put into the union range.
    • [range13 range] -- One of the ranges that will be put into the union range.
    • [range14 range] -- One of the ranges that will be put into the union range.
    • [range15 range] -- One of the ranges that will be put into the union range.
    • [range16 range] -- One of the ranges that will be put into the union range.
    • [range17 range] -- One of the ranges that will be put into the union range.
    • [range18 range] -- One of the ranges that will be put into the union range.
    • [range19 range] -- One of the ranges that will be put into the union range.
    • [range20 range] -- One of the ranges that will be put into the union range.
    • [range21 range] -- One of the ranges that will be put into the union range.
    • [range22 range] -- One of the ranges that will be put into the union range.
    • [range23 range] -- One of the ranges that will be put into the union range.
    • [range24 range] -- One of the ranges that will be put into the union range.
    • [range25 range] -- One of the ranges that will be put into the union range.
    • [range26 range] -- One of the ranges that will be put into the union range.
    • [range27 range] -- One of the ranges that will be put into the union range.
    • [range28 range] -- One of the ranges that will be put into the union range.
    • [range29 range] -- One of the ranges that will be put into the union range.
    • [range30 range] -- One of the ranges that will be put into the union range.
    • Result: range -- A range object that is the union of the supplied range objects.
  • unprotect -- Removes protection from a sheet or workbook. This method has no effect if the sheet or workbook isn't protected.
    • k.sheet / k.workbook
    • [password unicode_text] -- A string that denotes the case-sensitive password to use to unprotect the sheet or workbook. If you omit this argument for a sheet that's protected with a password, you'll be prompted for the password.
  • unprotect_sharing -- Turns off protection for sharing and saves the workbook.
    • workbook
    • [sharing_password unicode_text] -- The workbook password.
  • update -- Updates the link or pivot table.
  • update_from_file -- Updates a read-only workbook from the saved disk version of the workbook if the disk version is more recent than the copy of the workbook that is loaded in memory.
  • update_link -- Updates a Microsoft Excel link.
    • workbook
    • [name unicode_text] -- The name of the Microsoft Excel link to be updated, as returned from the link sources method.
    • [type k.link_type_Excel_links / k.link_type_OLE_links] -- The link type.
  • use_default_folder_suffix -- Sets the folder suffix for the specified document to the default suffix for the language support you have selected or installed.
  • web_page_preview -- Displays a preview of the specified workbook as it would look if saved as a Web page.

Classes

  • Excel_comment -- Represents a cell comment.
    • Plural name:
      • Excel_comments
    • Inherits from:
    • Properties:
      • author (r/o) unicode_text -- Returns the author of the comment.
      • shape_object (r/o) shape -- Returns a shape object that represents the shape attached to the specified comment.
      • visible boolean -- Returns or sets if the specified object is visible.
  • ODBC_error
    • Plural name:
      • ODBC_errors
    • Inherits from:
    • Properties:
      • error_string (r/o) unicode_text -- Returns the ODBC error string.
      • sql_state (r/o) unicode_text -- Returns the SQL state error.
  • Protection -- Represents the various types of protection options available for a worksheet
    • Inherits from:
    • Properties:
      • allow_deleting_columns (r/o) boolean -- Returns True if the deleting of columns is allowed on a protected worksheet. Read-only Boolean.
      • allow_deleting_rows (r/o) boolean -- Returns True if the deleting of rows is allowed on a protected worksheet. Read-only Boolean.
      • allow_filtering (r/o) boolean -- Returns True if the filtering is allowed on a protected worksheet. Read-only Boolean.
      • allow_formatting_cells (r/o) boolean -- Returns True if the formatting of cells is allowed on a protected worksheet. Read-only Boolean.
      • allow_formatting_columns (r/o) boolean -- Returns True if the formatting of columns is allowed on a protected worksheet. Read-only Boolean.
      • allow_formatting_rows (r/o) boolean -- Returns True if the formatting of rows is allowed on a protected worksheet. Read-only Boolean.
      • allow_inserting_columns (r/o) boolean -- Returns True if the inserting of columns is allowed on a protected worksheet. Read-only Boolean.
      • allow_inserting_hyperlinks (r/o) boolean -- Returns True if the inserting of hyperlinks is allowed on a protected worksheet. Read-only Boolean.
      • allow_inserting_rows (r/o) boolean -- Returns True if the inserting of rows is allowed on a protected worksheet. Read-only Boolean.
      • allow_sorting (r/o) boolean -- Returns True if the sorting is allowed on a protected worksheet. Read-only Boolean.
      • allow_using_pivot_table (r/o) boolean -- Returns True if the using of pivot table is allowed on a protected worksheet. Read-only Boolean.
  • above_average_format_condition
    • Inherits from:
    • Properties:
      • above_or_below k.format_above_average / k.format_below_average / k.format_equal_above_average / k.format_equal_below_average / k.format_above_standard_deviation / k.format_below_standard_deviation
      • applies_to (r/o) range -- Returns the range this format condition applies to. Read Only.
      • calc_for k.calc_for_all_values / k.calc_for_row_groups / k.calc_for_col_groups
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • format_condition_priority integer -- Specifies the priority for the format condition. Read/Write.
      • format_condition_type (r/o) k.cell_value / k.expression / k.color_scale / k.databar / k.top_10 / k.icon_sets / k.unique_values / k.text_string / k.blanks_condition / k.time_period / k.above_average_condition / k.no_blanks_condition / k.errors_condition / k.no_errors_condition -- Return the conditional format type.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • number_format unicode_text -- Returns or sets the format code for the object.
      • number_of_standard_deviations integer
      • pivot_condition_scope_type k.pivot_condition_selection_scope / k.pivot_condition_fields_scope / k.pivot_condition_data_field_scope -- Returns or sets the part of the pivot table that the pivot table format condition is scoped to
      • pivot_table_condition (r/o) boolean -- Tells whether this format condition is a pivot table condition.
      • stop_if_true (r/o) boolean -- Tells whether the processing of format conditions stops if this condition is true. Read Only.
  • active_filter
  • add_in -- Represents a single add-in, either installed or not installed.
    • Plural name:
      • add_ins
    • Inherits from:
    • Properties:
      • full_name (r/o) unicode_text -- Returns the name of the add in, including its path on disk, as a string.
      • installed boolean -- Returns or sets if the add in is installed.
      • name (r/o) unicode_text -- Returns the name of the object.
      • path (r/o) unicode_text -- Returns the complete path of the object, excluding the final separator and name of the add in.
  • application -- A representation of the Microsoft Excel application.
    • Plural name:
      • applications
    • Inherits from:
    • Properties:
      • AutoFormatAsYouTypeReplaceHyperlinks boolean -- True if Microsoft Excel automatically formats hyperlinks as you type. False if Excel does not automatically format hyperlinks as you type.
      • Excel_cursor k.I_beam_cursor / k.default_cursor / k.northwest_arrow_cursor / k.wait_cursor -- Returns or sets the appearance of the mouse pointer in Microsoft Excel.
      • ODBC_timeout integer -- Returns or sets the ODBC query time limit, in seconds. The default value is 45 seconds.
      • active_cell (r/o) cell -- Returns a range object that represents the active cell in the active window, the window on top, or in the specified window. If the window isn't displaying a worksheet, this property fails.
      • active_chart (r/o) chart -- Returns a chart object that represents the active chart, either an embedded chart or a chart sheet. An embedded chart is considered active when it's either selected or activated.
      • active_printer unicode_text -- Returns or sets the name of the active printer.
      • active_sheet (r/o) sheet -- Returns an object that represents the active sheet, the sheet on top, in the active workbook or in the specified window or workbook.
      • active_window (r/o) window -- Returns a window object that represents the active window, the window on top.
      • active_workbook (r/o) workbook -- Returns a workbook object that represents the workbook in the active window, the window on top.
      • alert_before_overwriting boolean -- Returns or sets if Microsoft Excel displays a message before overwriting nonblank cells during a drag-and-drop editing operation.
      • alt_startup_path unicode_text -- Returns or sets the name of the alternate startup folder.
      • arbitrary_XML_support_available (r/o) boolean -- Returns a Boolean value that indicates whether the XML features in Microsoft Excel are available
      • ask_to_update_links boolean -- Returns or sets if Microsoft Excel asks the user to update links when opening files with links.
      • autocorrect_object (r/o) autocorrect -- Returns an autocorrect object that represents the Microsoft Excel AutoCorrect attributes.
      • automation_security k.msoAutomationSecurityLow / k.msoAutomationSecurityByUI / k.msoAutomationSecurityForceDisable
      • build (r/o) integer -- Returns the Microsoft Excel build number.
      • calculate_before_save boolean -- Returns or sets if workbooks are calculated before they're saved to disk.
      • calculation k.calculation_automatic / k.calculation_manual / k.calculation_semiautomatic -- Returns or sets the calculation mode.
      • calculation_version (r/o) integer -- Returns a number whose rightmost four digits are the minor calculation engine version number, and whose other digits, on the left, are the major version of Microsoft Excel.
      • caption (r/o) unicode_text -- Returns the name of the application.
      • cell_drag_and_drop boolean -- Returns or sets if dragging and dropping cells is enabled.
      • command_underlines k.command_underlines_automatic / k.command_underlines_off / k.command_underlines_on -- Returns or sets the state of the command underlines in Microsoft Excel.
      • copy_objects_with_cells boolean -- Returns or sets if objects are cut, copied, extracted, and sorted with cells.
      • custom_list_count (r/o) integer -- Returns the number of defined custom lists, including built-in lists.
      • cut_copy_mode k.copy_mode / k.cut_mode -- Returns or sets the status of cut or copy mode.
      • data_entry_mode k.data_entry_on / k.data_entry_strict / k.data_entry_off -- Returns or sets data entry mode, as shown in the following table. When in data entry mode, you can enter data only in the unlocked cells in the currently selected range.
      • default_file_path unicode_text -- Returns or sets the default path that Microsoft Excel uses when it opens files.
      • default_save_format k.CSV_file_format / k.CSV_Mac_file_format / k.CSV_MSDos_file_format / k.CSV_Windows_file_format / k.DBF3_file_format / k.DBF4_file_format / k.DIF_file_format / k.Excel2_file_format / k.Excel_2_east_asian_file_format / k.Excel3_file_format / k.Excel4_file_format / k.Excel5_file_format / k.Excel7_file_format / k.Excel_4_workbook_file_format / k.international_add_in_file_format / k.international_macro_file_format / k.workbook_normal_file_format / k.SYLK_file_format / k.current_platform_text_file_format / k.text_Mac_file_format / k.text_MSDos_file_format / k.text_printer_file_format / k.text_windows_file_format / k.HTML_file_format / k.XML_spreadsheet_file_format / k.PDF_file_format / k.Excel_binary_file_format / k.Excel_XML_file_format / k.macro_enabled_XML_file_format / k.macro_enabled_template_file_format / k.template_file_format / k.add_in_file_format / k.Excel98to2004_file_format / k.Excel98to2004_template_file_format / k.Excel98to2004_add_in_file_format -- Returns or sets the default format for saving files.
      • default_web_options_object (r/o) default_web_options -- Returns the default web object.
      • display_alerts boolean -- Returns or sets if Microsoft Excel displays certain alerts and messages while handling events from AppleScript.
      • display_comment_indicator k.no_indicator / k.comment_indicator_only / k.comment_and_indicator -- Returns or sets the way cells display comments and indicators.
      • display_excel_4_menus boolean -- Returns or sets if Microsoft Excel displays version 4.0 menu bars.
      • display_formula_bar boolean -- Returns or sets if the formula bar is displayed.
      • display_full_screen boolean -- Returns or sets if Microsoft Excel is in full-screen mode.
      • display_function_tooltips boolean -- Returns or sets if function tool tips can be displayed.
      • display_insert_options boolean -- Returns or sets if the insert options button should be displayed.
      • display_note_indicator boolean -- Returns or sets if cells containing notes display cell tips and contain note indicators, small dots in their upper-right corners.
      • display_recent_files boolean -- Returns or sets if the list of recently used files is displayed on the file menu.
      • display_scroll_bars boolean -- Returns or sets if scroll bars are visible for all workbooks.
      • display_status_bar boolean -- Returns or sets if the status bar is displayed.
      • edit_directly_in_cell boolean -- Returns or sets if Microsoft Excel allows editing in cells.
      • enable_animations boolean -- Returns or sets if animated insertion and deletion is enabled.
      • enable_autocomplete boolean -- Returns or sets if the autocomplete feature is enabled.
      • enable_cancel_key k.cancel_key_disabled / k.error_handler / k.interrupt -- Controls how Microsoft Excel handles CTRL-BREAK, ESC, or cmd-period user interruptions to the running procedure.
      • enable_events boolean -- Returns or sets if events are enabled for the application object.
      • enable_formula_autocomplete boolean -- Returns or sets if the formula autocomplete feature is enabled.
      • enable_formula_type_ahead boolean -- Returns or sets if the formula autocomplete type ahead is enabled.
      • enable_sound boolean -- Returns or sets if sound is enabled for Microsoft Office.
      • extend_list boolean -- Returns or sets if Microsoft Excel automatically extends formatting and formulas to new data that is added to a list.
      • fixed_decimal boolean -- All data entered after this property is set to true will be formatted with the number of fixed decimal places set by the fixed decimal places property.
      • fixed_decimal_places integer -- Returns or sets the number of fixed decimal places used when the fixed decimal property is set to true.
      • formula_autocomplete_wait integer -- Returns or sets number of characters to wait before formula type ahead.
      • frontmost (r/o) null -- Returns if the application is the frontmost window.
      • include_empty_cells_in_lists boolean -- Returns or sets if empty cells are included in range lists.
      • iteration boolean -- Returns or sets if Microsoft Excel will use iteration to resolve circular references.
      • keep_four_digit_years boolean -- Returns or sets if years values should be kept as four digits instead of two.
      • keyboard_script integer
      • library_path (r/o) unicode_text -- Returns the path to the Library folder.
      • localized_language (r/o) integer -- Returns the Windows language ID for the locale that Microsoft Excel is using.
      • math_coprocessor_available (r/o) boolean -- Returns true if a math coprocessor is available.
      • max_change float -- Returns or sets the maximum amount of change between each iteration as Microsoft Excel resolves circular references.
      • max_iterations integer -- Returns or sets the maximum number of iterations that Microsoft Excel can use to resolve a circular reference.
      • measurement_unit k.inches_ / k.centimeters_ / k.millimeters -- Returns or set the current unit of measure.
      • memory_free (r/o) integer -- Returns the amount of memory that's still available for Microsoft Excel to use, in bytes.
      • memory_total (r/o) integer -- Returns the total amount of memory, in bytes, that's available to Microsoft Excel, including memory already in use.
      • memory_used (r/o) integer -- Returns the amount of memory that Microsoft Excel is currently using, in bytes.
      • move_after_return boolean -- Returns or sets if the active cell will be moved as soon as the ENTER/RETURN key is pressed.
      • move_after_return_direction k.toward_the_bottom / k.toward_the_left / k.toward_the_right / k.toward_the_top -- Returns or sets the direction in which the active cell is moved when the user presses ENTER.
      • name (r/o) unicode_text -- Returns the name of the application.
      • network_templates_path (r/o) unicode_text -- Returns the network path where templates are stored. If the network path doesn't exist, this property returns an empty string.
      • operating_system (r/o) unicode_text -- Returns the name and version number of the current operating system.
      • organization_name (r/o) unicode_text -- Returns the registered organization name.
      • path (r/o) unicode_text -- Returns the complete path of the application, excluding the final separator and name of the application.
      • path_separator (r/o) unicode_text -- Returns the path separator character.
      • pivot_table_selection boolean -- Returns or sets if pivot tables use structured selection.
      • prompt_for_summary_info boolean -- Returns or sets if Microsoft Excel asks for summary information when files are first saved.
      • reference_style k.A1 / k.R1C1 -- Returns or sets how Microsoft Excel displays cell references and row and column headings in either A1 or R1C1 reference style.
      • ribbon_expanded boolean -- Returns or sets a Boolean value that indicates whether the Ribbon in Microsoft Excel is expanded
      • roll_zoom boolean -- Returns or sets if the IntelliMouse zooms instead of scrolling.
      • save_interval integer
      • screen_updating boolean -- Returns or sets if screen updating is turned on. Turn screen updating off to speed up your AppleScript code. You won't be able to see what the code is doing, but it will run faster.
      • selection (r/o) range -- Returns the selected object in the active window.
      • sheets_in_new_workbook integer -- Returns or sets the number of sheets that Microsoft Excel automatically inserts into new workbooks.
      • show_chart_tip_names boolean -- Returns or sets if charts show chart tip names.
      • show_chart_tip_values boolean -- Returns or sets if charts show chart tip values.
      • show_ribbon boolean -- Returns or sets a Boolean value that indicates whether the Ribbon in Microsoft Excel is shown
      • show_tool_tips boolean -- Returns or sets if tool tips are turned on.
      • spelling_options (r/o) xlspelling_options -- Returns the default spelling options object.
      • standard_font unicode_text -- Returns or sets the name of the standard font.
      • standard_font_size float -- Returns or sets the standard font size, in points.
      • startup_dialog boolean -- Returns or sets if the startup dialog should be shown when starting up the application.
      • startup_path (r/o) unicode_text -- Returns the complete path of the startup folder, excluding the final separator.
      • status_bar unicode_text -- Returns or sets the text in the status bar.
      • templates_path (r/o) unicode_text -- Returns the local path where templates are stored.
      • this_cell (r/o) null -- Returns the cell in which the user-defined function is being called from as a Range object.
      • transition_menu_key unicode_text -- Returns or sets the alternate menu or help key.
      • transition_menu_key_action k.excel_menus -- Returns or sets the action taken when the alternate menu key is pressed.
      • two_digit_cutoff_year integer -- Returns or sets the two digit value after which year values are shown as four digits.
      • usable_height (r/o) float -- Returns the maximum height of the space that a window can occupy in points.
      • usable_width (r/o) float -- Returns the maximum width of the space that a window can occupy in points.
      • user_name unicode_text -- Returns or sets the name of the current user.
    • Elements:
  • autofilter -- Represents autofiltering for the specified worksheet.
    • Plural name:
      • autofilters
    • Inherits from:
    • Properties:
      • autofiltermode (r/o) boolean -- Returns True if filters have been defined else False.
      • range_object (r/o) range -- Returns a range object that represents the range to which the specified autofilter applies.
      • sort_object (r/o) sort -- Returns the sort object in the auto filter object.
    • Elements:
  • border -- Represents the border of an object.
    • Plural name:
      • borders
    • Inherits from:
    • Properties:
      • color RGB_color -- Returns or sets the primary color of the object.
      • color_index k.color_index_automatic / k.color_index_none / k.a_color_index_integer -- Returns or sets the color of the border. The color is specified as an index value into the current color palette.
      • line_style k.continuous / k.dash / k.dash_dot / k.dash_dot_dot / k.dot / k.double / k.slant_dash_dot / k.line_style_none -- Returns or sets the line style for the border.
      • line_weight integer -- Returns or sets the line weight of the border.
      • theme_color k.color_index_none / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color -- Returns or sets the theme color in the applied color scheme that is associated with the specified object.
      • tint_and_shade float -- Returns or sets a Single that lightens or darkens a color.
      • weight k.border_weight_hairline / k.border_weight_medium / k.border_weight_thick / k.border_weight_thin -- Returns or sets the weight of the border.
  • button -- Represents a button control.
    • Plural name:
      • buttons
    • Inherits from:
    • Properties:
      • accelerator unicode_text -- Returns or sets the accelerator character for this control.
      • add_indent boolean -- Returns or sets if text is automatically indented when the text alignment in a cell is set to equal distribution either horizontally or vertically.
      • auto_scale_font boolean -- Returns or sets if the text in the object changes font size when the object size changes.
      • auto_size boolean -- Returns or sets if the size of the specified object is changed automatically to fit text within its boundaries.
      • bottom_right_cell (r/o) range -- Returns the bottom right cell of the range the control is occupying.
      • cancel_button boolean -- Returns or sets if this button is the cancel button.
      • caption unicode_text -- Returns or sets the caption for this object.
      • control_text unicode_text -- Returns or sets the default text for the control.
      • default_button boolean -- Returns or sets if this button is the default button.
      • dismiss_button boolean -- Returns or sets if this button is the dismiss button.
      • enabled boolean -- Returns or sets if the object is enabled.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • formula unicode_text -- Returns or sets the object's formula, in A1-style notation and in the language of the macro.
      • height float -- Returns or set the height of the object.
      • help_button boolean -- Returns or sets if this button is the help button.
      • horizontal_alignment k.horizontal_align_center / k.horizontal_align_center_across_selection / k.horizontal_align_distributed / k.horizontal_align_fill / k.horizontal_align_general / k.horizontal_align_justify / k.horizontal_align_left / k.horizontal_align_right -- Returns or sets the horizontal alignment for the object.
      • left_position float -- Returns or sets the position of the specified object, in points.
      • locked boolean -- Returns or sets if the object is locked, if false the object can be modified when the sheet is protected.
      • locked_text boolean -- Returns or sets whether the control's text is locked for editing.
      • name unicode_text -- Returns or sets the name of the object.
      • on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • orientation k.orientation_downward / k.orientation_horizontal / k.orientation_upward / k.orientation_vertical -- May also be a number value from -90 to 90 degrees.
      • phonetic_accelerator unicode_text -- Returns or sets the link to a range.
      • placement k.placement_free_floating / k.placement_move / k.placement_move_and_size -- Returns or sets how the object is placed on the worksheet.
      • print_object boolean -- Returns or sets if this object is printed.
      • reading_order k.left_to_right / k.right_to_left / k.context -- Returns or sets the reading order for the specified object.
      • top float -- Returns the top position of the specified object, in points.
      • top_left_cell (r/o) range -- Returns a range object that represents the cell that lies under the upper-left corner of the specified object.
      • vertical_alignment k.vertical_alignment_top / k.vertical_alignment_center / k.vertical_alignment_bottom / k.vertical_alignment_justify / k.vertical_alignment_distributed -- Returns or sets the vertical alignment of the object.
      • visible boolean -- Returns or sets if the object is visible.
      • width float -- Returns or sets the width of the object.
      • wrap_auto_text boolean -- Returns or sets if the auto text is wrapped.
      • z_order_position (r/o) integer -- Returns the z-order position of the object.
    • Elements:
  • calculated_field
    • Plural name:
      • calculated_fields
    • Inherits from:
  • calculated_item
    • Plural name:
      • calculated_items
    • Inherits from:
  • calculated_member -- Represents the calculated fields and calculated items for PivotTables with Online Analytical Processing data sources.
    • Plural name:
      • calculated_members
    • Inherits from:
    • Properties:
      • _default_ (r/o) unicode_text
      • display_folder (r/o) unicode_text -- An ST_Xstring attribute that specifies the display folder of this PivotTable named set.
      • dynamic (r/o) boolean
      • flatten_hierarchies (r/o) boolean
      • formula (r/o) unicode_text -- Returns the member's formula in multidimensional expressions syntax.
      • hierarchize_distinct (r/o) boolean
      • is_valid (r/o) boolean -- Returns a Boolean that indicates whether the specified calculated member has been successfully instantiated with the OLAP provider during the current session.
      • name (r/o) unicode_text -- Calculated Member Name.
      • solve_order (r/o) integer -- Calculated Members Solve Order.
      • source_name (r/o) unicode_text -- Returns the specified object's name as it appears in the original source data for the specified PivotTable report.
      • type (r/o) k.calculated_member / k.calculated_set
  • checkbox
    • Plural name:
      • checkboxes
    • Inherits from:
    • Properties:
      • accelerator unicode_text -- Returns or sets the accelerator character for this control.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • bottom_right_cell (r/o) range -- Returns the bottom right cell of the range the control is occupying.
      • caption unicode_text -- Returns or sets the caption for this object.
      • control_text unicode_text -- Returns or sets the default text for the control.
      • display_threeD_shading boolean
      • enabled boolean -- Returns or sets if the control is enabled
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • height float -- Returns or sets the height of the control.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • left_position float -- Returns or sets the left position of the control
      • linked_cell unicode_text
      • locked boolean -- Returns or sets whether the control is locked for editing.
      • locked_text boolean -- Returns or sets whether the control's text is locked for editing.
      • name unicode_text -- Returns or sets the name of this control
      • on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • phonetic_accelerator unicode_text -- Returns or sets the link to a range.
      • placement k.placement_free_floating / k.placement_move / k.placement_move_and_size -- Returns or sets how the object is placed on the worksheet.
      • print_object boolean -- Returns or sets if this object is printed.
      • top float -- Returns or sets the position of the top of the control.
      • top_left_cell (r/o) range -- Returns the top left cell of the range within which the control is positioned.
      • value k.checkbox_off / k.checkbox_on / k.checkbox_mixed
      • visible boolean -- Returns or sets the current value of the control
      • width float -- Returns or sets the width of the object.
      • z_order_position (r/o) integer -- Returns the most recently set z order position, bring shape to front/send shape to back/bring shape forward/send shape backward/bring shape in front of text/send shape behind text.
    • Elements:
  • child_item
    • Plural name:
      • child_items
    • Inherits from:
  • color_scale_criteria
  • color_scale_criterion
    • Inherits from:
    • Properties:
      • color_scale_criterion_index (r/o) integer -- The index of the color scale criterion. Read only.
      • color_scale_criterion_type k.condition_value_none / k.condition_value_number / k.condition_value_lowest_value / k.condition_value_highest_value / k.condition_value_percent / k.condition_value_formula / k.condition_value_percentile / k.condition_value_automatic_minimum / k.condition_value_automatic_maximum -- Returns or sets the condition value type of the color scale criterion. Read/Write.
      • color_scale_criterion_value anything
      • format_color (r/o) format_color -- Returns the FormatColor for the ColorScaleCriterion object.
  • color_scale_format_condition
    • Inherits from:
    • Properties:
      • applies_to (r/o) range -- Returns the range this format condition applies to. Read Only.
      • color_scale_criteria (r/o) color_scale_criteria -- Returns the ColorScaleCriteria for the ColorScale object.
      • color_scale_type integer
      • format_condition_priority integer -- Specifies the priority for the format condition. Read/Write.
      • format_condition_type (r/o) k.cell_value / k.expression / k.color_scale / k.databar / k.top_10 / k.icon_sets / k.unique_values / k.text_string / k.blanks_condition / k.time_period / k.above_average_condition / k.no_blanks_condition / k.errors_condition / k.no_errors_condition -- Return the conditional format type.
      • formula unicode_text -- Returns or sets the value or expression associated with the conditional format or data validation.
      • pivot_condition_scope_type k.pivot_condition_selection_scope / k.pivot_condition_fields_scope / k.pivot_condition_data_field_scope -- Returns or sets the part of the pivot table that the pivot table format condition is scoped to
      • pivot_table_condition (r/o) boolean -- Tells whether this format condition is a pivot table condition.
      • stop_if_true (r/o) boolean -- Tells whether the processing of format conditions stops if this condition is true. Read Only.
  • colorstop -- Represents the color stop point for a gradient fill in an range or selection.
    • Inherits from:
    • Properties:
      • color RGB_color -- Returns or sets the primary color of the object.
      • colorstop_position float -- Returns or sets the position of the ColorStop.
      • theme_color k.color_index_none / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color -- Returns or sets the theme color in the applied color scheme that is associated with the specified object.
      • tint_and_shade float -- Returns or sets a Single that lightens or darkens a color.
  • colorstops -- A collection of all the ColorStop objects for the specified series.
  • column_field
    • Plural name:
      • column_fields
    • Inherits from:
  • column_item
    • Plural name:
      • column_items
    • Inherits from:
  • condition_value
    • Inherits from:
    • Properties:
      • condition_value_type (r/o) k.condition_value_none / k.condition_value_number / k.condition_value_lowest_value / k.condition_value_highest_value / k.condition_value_percent / k.condition_value_formula / k.condition_value_percentile / k.condition_value_automatic_minimum / k.condition_value_automatic_maximum
      • condition_value_value (r/o) anything
  • cube_field -- Represents a hierarchy or measure field from an OLAP cube
    • Plural name:
      • cube_fields
    • Inherits from:
    • Properties:
      • all_items_visible (r/o) boolean -- The AllItemsVisible property checks whether manual filtering is applied to a PivotField or CubeField.
      • caption unicode_text -- The label text for the cube field.
      • cube_field_sub_type (r/o) k.cube_hierarchy / k.cube_measure / k.cube_set / k.cube_attribute / k.cube_calculated_measure / k.cube_KPI_value / k.cube_KPI_goal / k.cube_KPI_status / k.cube_KPI_trend / k.cube_KPI_weight -- Specifies the type of a CubeField.
      • cube_field_type (r/o) k.hierarchy / k.measure / k.set -- Indicates whether the OLAP cube field is a hierarchy field or a measure field.
      • current_page_name unicode_text -- Returns or sets the page name for a CubeField.
      • drag_to_column boolean -- True if the specified field can be dragged to the column position.
      • drag_to_data boolean -- True if the specified field can be dragged to the data position.
      • drag_to_hide boolean -- True if the specified field can be dragged to the column position.
      • drag_to_page boolean -- True if the field can be dragged to the page position.
      • drag_to_row boolean -- True if the field can be dragged to the row position.
      • enable_multiple_page_items boolean -- True to allow multiple items in the page field area for OLAP PivotTables to be selected.
      • flatten_hierarchies boolean
      • has_member_properties (r/o) boolean -- Returns True when there are member properties specified to be displayed for the cube field.
      • hierarchize_distinct boolean
      • include_new_items_in_filter boolean -- The IncludeNewItemsInFilter property is used to track included or excluded items in OLAP PivotTables.
      • is_date (r/o) boolean -- Returns True if the CubeField is a date.
      • layout_form (r/o) k.tabular / k.outline -- Returns or sets the way the specified PivotTable items appear -- in table format or in outline format.
      • layout_subtotal_location k.at_top / k.at_bottom -- Returns or sets the position of the PivotTable field subtotals in relation to, either above or below, the specified field.
      • name (r/o) unicode_text -- Returns the name of the object.
      • orientation k.orient_as_column_field / k.orient_as_data_field / k.orient_as_hidden / k.orient_as_page_field / k.orient_as_row_field -- The location of the field in the specified PivotTable report.
      • position integer -- Position of the item in its field if the item is currently showing.
      • show_in_field_list boolean -- When set to True, a CubeField object will be shown in the field list.
      • treeview_control (r/o) treeview_control
      • value (r/o) unicode_text -- Returns the name of the specified field.
    • Elements:
  • custom_view -- Represents a custom workbook view.
    • Plural name:
      • custom_views
    • Inherits from:
    • Properties:
      • custom_view_print_settings (r/o) boolean -- True if print settings are included in the custom view.
      • name (r/o) unicode_text -- Returns the name of this object.
      • row_col_settings (r/o) boolean -- Returns true if the custom view includes settings for hidden rows and columns, including filter information.
  • data_field
  • databar_border
    • Inherits from:
    • Properties:
      • databar_border_color (r/o) format_color
      • databar_border_type k.databar_border_none / k.databar_border_solid -- Returns or sets the type of border of the databar
  • databar_format_condition
    • Inherits from:
    • Properties:
      • applies_to (r/o) range -- Returns the range this format condition applies to. Read Only.
      • databar_axis_color (r/o) format_color
      • databar_axis_position k.databar_axis_automatic / k.databar_axis_midpoint / k.databar_axis_none -- Returns or sets the position of the databar axis
      • databar_bar_color (r/o) format_color
      • databar_border (r/o) databar_border -- Returns the DataBarBorder for the Databar object.
      • databar_direction integer -- Specifies the direction of the databar. Read/Write.
      • databar_fill_type k.databar_fill_solid / k.databar_fill_gradient -- Returns or sets the type of fill of the databar
      • format_condition_priority integer -- Specifies the priority for the format condition. Read/Write.
      • format_condition_show_value boolean -- Specifies whether to show the cell value along with the databar. Read/Write.
      • format_condition_type (r/o) k.cell_value / k.expression / k.color_scale / k.databar / k.top_10 / k.icon_sets / k.unique_values / k.text_string / k.blanks_condition / k.time_period / k.above_average_condition / k.no_blanks_condition / k.errors_condition / k.no_errors_condition -- Return the conditional format type.
      • formula unicode_text -- Returns or sets the value or expression associated with the conditional format or data validation.
      • max_point_condition_value (r/o) condition_value -- Returns the ConditionValue for the maximum point of the DataBar object.
      • max_point_percent integer -- Specifies the percentage of the data bar to draw at the maximum point. Read/Write.
      • min_point_condition_value (r/o) condition_value -- Returns the ConditionValue for the minimum point of the DataBar object.
      • min_point_percent integer -- Specifies the percentage of the data bar to draw at the minimum point. Read/Write.
      • negative_bar_format (r/o) negative_bar_format -- Returns the NegativeBarFormat for the Databar object.
      • pivot_condition_scope_type k.pivot_condition_selection_scope / k.pivot_condition_fields_scope / k.pivot_condition_data_field_scope -- Returns or sets the part of the pivot table that the pivot table format condition is scoped to
      • pivot_table_condition (r/o) boolean -- Tells whether this format condition is a pivot table condition.
      • stop_if_true (r/o) boolean -- Tells whether the processing of format conditions stops if this condition is true. Read Only.
  • default_web_options -- Contains global application-level attributes used by Microsoft Excel when you save a document as a Web page or open a Web page.
    • Inherits from:
    • Properties:
      • allow_png boolean -- Returns or sets if PNG, Portable Network Graphics, is allowed as an image format when you save documents as a Web page.
      • always_save_in_default_encoding boolean -- Returns or sets if the default encoding is used when you save a Web page or plain text document, independent of the file's original encoding when opened.
      • encoding k.encoding_Thai / k.encoding_Japanese_ShiftJIS / k.encoding_simplified_Chinese / k.encoding_Korean / k.encoding_Big5_traditional_Chinese / k.encoding_little_endian / k.encoding_big_endian / k.encoding_central_European / k.encoding_Cyrillic / k.encoding_Western / k.encoding_Greek / k.encoding_Turkish / k.encoding_Hebrew / k.encoding_Arabic / k.encoding_Baltic / k.encoding_Vietnamese / k.encoding_ISO88591_Latin1 / k.encoding_ISO88592_central_Europe / k.encoding_ISO88593_Latin3 / k.encoding_ISO88594_Baltic / k.encoding_ISO88595_Cyrillic / k.encoding_ISO88596_Arabic / k.encoding_ISO88597_Greek / k.encoding_ISO88598_Hebrew / k.encoding_ISO88599_Turkish / k.encoding_ISO885915_Latin9 / k.encoding_ISO2022_Japanese_no_half_width_Katakana / k.encoding_ISO2022_Japanese_JISX02021984 / k.encoding_ISO2022_Japanese_JISX02011989 / k.encoding_ISO2022KR / k.encoding_ISO2022CN_traditional_Chinese / k.encoding_ISO2022CN_simplified_Chinese / k.encoding_Mac_Roman / k.encoding_Mac_Japanese / k.encoding_Mac_traditional_Chinese / k.encoding_Mac_Korean / k.encoding_Mac_Arabic / k.encoding_Mac_Hebrew / k.encoding_Mac_Greek1 / k.encoding_Mac_Cyrillic / k.encoding_Mac_simplified_Chinese_GB2312 / k.encoding_Mac_Romania / k.encoding_Mac_Ukraine / k.encoding_Mac_Latin2 / k.encoding_Mac_Icelandic / k.encoding_Mac_Turkish / k.encoding_Mac_Croatia / k.encoding_EBCDIC_US_Canada / k.encoding_EBCDIC_International / k.encoding_EBCDIC_multilingual_ROECE_Latin2 / k.encoding_EBCDIC_Greek_modern / k.encoding_EBCDIC_Turkish_Latin5 / k.encoding_EBCDIC_Germany / k.encoding_EBCDIC_Denmark_Norway / k.encoding_EBCDIC_Finland_Sweden / k.encoding_EBCDIC_Italy / k.encoding_EBCDIC_Latin_America_Spain / k.encoding_EBCDIC_United_Kingdom / k.encoding_EBCDIC_Japanese_Katakana_extended / k.encoding_EBCDIC_France / k.encoding_EBCDIC_Arabic / k.encoding_EBCDIC_Greek / k.encoding_EBCDIC_Hebrew / k.encoding_EBCDIC_Korean_extended / k.encoding_EBCDIC_Thai / k.encoding_EBCDIC_Icelandic / k.encoding_EBCDIC_Turkish / k.encoding_EBCDIC_Russian / k.encoding_EBCDIC_Serbian_Bulgarian / k.encoding_EBCDIC_Japanese_Katakana_extended_and_Japanese / k.encoding_EBCDIC_US_Canada_and_Japanese / k.encoding_EBCDIC_extended_and_Korean / k.encoding_EBCDIC_simplified_Chinese_extended_and_simplified_Chinese / k.encoding_EBCDIC_US_Canada_and_traditional_Chinese / k.encoding_EBCDIC_Japanese_Latin_extended_and_Japanese / k.encoding_OEM_United_States / k.encoding_OEM_Greek / k.encoding_OEM_Baltic / k.encoding_OEM_multilingual_LatinI / k.encoding_OEM_multilingual_LatinII / k.encoding_OEM_Cyrillic / k.encoding_OEM_Turkish / k.encoding_OEM_Portuguese / k.encoding_OEM_Icelandic / k.encoding_OEM_Hebrew / k.encoding_OEM_Canadian_French / k.encoding_OEM_Arabic / k.encoding_OEM_Nordic / k.encoding_OEM_CyrillicII / k.encoding_OEM_modern_Greek / k.encoding_EUC_Japanese / k.encoding_EUC_Chinese_simplified_Chinese / k.encoding_EUC_Korean / k.encoding_EUC_Taiwanese_traditional_Chinese / k.encoding_Devanagari / k.encoding_Bengali / k.encoding_Tamil / k.encoding_Telugu / k.encoding_Assamese / k.encoding_Oriya / k.encoding_Kannada / k.encoding_Malayalam / k.encoding_Gujarati / k.encoding_Punjabi / k.encoding_Arabic_ASMO / k.encoding_Arabic_transparent_ASMO / k.encoding_Korean_Johab / k.encoding_Taiwan_CNS / k.encoding_Taiwan_TCA / k.encoding_Taiwan_Eten / k.encoding_Taiwan_IBM5550 / k.encoding_Taiwan_teletext / k.encoding_Taiwan_Wang / k.encoding_IA5IRV / k.encoding_IA5_German / k.encoding_IA5_Swedish / k.encoding_IA5_Norwegian / k.encoding_US_ASCII / k.encoding_T61 / k.encoding_ISO6937_nonspacing_accent / k.encoding_KOI8R / k.encoding_Ext_alpha_lowercase / k.encoding_KOI8U / k.encoding_Europa3 / k.encoding_HZGB_simplified_Chinese / k.encoding_UTF7 / k.encoding_UTF8 -- Returns or sets the document encoding, code page or character set, to be used by the Web browser when you view the saved document.
      • location_of_components unicode_text -- Returns or sets the central URL, on the intranet or Web, or path, local or network, to the location from which authorized users can download Microsoft Office Web components when viewing your saved document.
      • pixels_per_inch integer -- Returns or sets the density, pixels per inch, of graphics images and table cells on a Web page. The range of settings is usually from 19 to 480, and common settings for popular screen sizes are 72, 96, and 120.
      • screen_size k.resolution544x376 / k.resolution640x480 / k.resolution720x512 / k.resolution800x600 / k.resolution1024x768 / k.resolution1152x882 / k.resolution1152x900 / k.resolution1280x1024 / k.resolution1600x1200 / k.resolution1800x1440 / k.resolution1920x1200 -- Returns or sets the ideal minimum screen size, width by height, in pixels, that you should use when viewing the saved document in a Web browser.
      • update_links_on_save boolean -- Returns or sets if hyperlinks and paths to all supporting files are automatically updated before you save the document as a Web page, ensuring that the links are up-to-date at the time the document is saved. If false, the links are not updated.
  • dialog -- Represents a built-in Microsoft Excel dialog box.
  • display_format -- Represents the formatting shown to the user.
    • Inherits from:
    • Properties:
      • add_indent (r/o) boolean -- Returns or sets if text is automatically indented when the text alignment in a cell is set to equal distribution either horizontally or vertically.
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • formula_hidden (r/o) boolean -- Returns or sets if the formula will be hidden when the workbook or worksheet is protected.
      • horizontal_alignment (r/o) k.horizontal_align_center / k.horizontal_align_center_across_selection / k.horizontal_align_distributed / k.horizontal_align_fill / k.horizontal_align_general / k.horizontal_align_justify / k.horizontal_align_left / k.horizontal_align_right -- Returns or sets the horizontal alignment for the range.
      • indent_level (r/o) integer -- Returns or sets the indent level for the range or style. Can be an integer from 0 to 15.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • locked (r/o) boolean -- Returns or sets if the range is locked.
      • merge_cells (r/o) boolean -- Returns or sets if the range contains merged cells.
      • number_format (r/o) unicode_text -- Returns or sets the format code for the object.
      • reading_order (r/o) k.left_to_right / k.right_to_left / k.context -- Returns or sets the reading order for the specified object.
      • shrink_to_fit (r/o) boolean -- Returns or sets if text automatically shrinks to fit in the available column width.
      • style_object (r/o) style -- Returns or sets a style object that represents the style of the specified range.
      • text_orientation (r/o) k.orientation_downward / k.orientation_horizontal / k.orientation_upward / k.orientation_vertical -- The text orientation. Can be a number value from -90 to 90 degrees.
      • vertical_alignment (r/o) k.vertical_alignment_top / k.vertical_alignment_center / k.vertical_alignment_bottom / k.vertical_alignment_justify / k.vertical_alignment_distributed -- Returns or sets the vertical alignment of the range.
      • wrap_text (r/o) boolean -- Returns or sets if Microsoft Excel wraps the text in the object.
  • document
    • Plural name:
      • documents
    • Inherits from:
  • dropdown
    • Plural name:
      • dropdowns
    • Inherits from:
    • Properties:
      • bottom_right_cell (r/o) range -- Returns the bottom right cell of the range the control is occupying.
      • caption unicode_text -- Returns or sets the caption for the control.
      • control_text unicode_text -- Returns or sets the default text for the control.
      • display_threeD_shading boolean -- Returns or sets whether a 3-d effect will be employed when displaying the control
      • drop_down_lines integer -- Returns or sets the number of dropdown items.
      • enabled boolean -- Returns or sets if the control is enabled
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • height float -- Returns or sets the height of the control.
      • left_position float -- Returns or sets the left position of the control
      • linked_cell unicode_text -- Returns or sets reference to a call which contains the value of the control.
      • list_fill_range unicode_text -- Returns or sets the items which are contained in the drop down.
      • list_index integer -- Returns or sets the selected item.
      • locked boolean -- Returns or sets whether the control is locked for editing.
      • name unicode_text -- Returns or sets the name of this control.
      • number_of_items_in_list (r/o) integer -- Returns the number of total items in the list.
      • on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • placement k.placement_free_floating / k.placement_move / k.placement_move_and_size -- Returns or sets how the object is placed on the worksheet.
      • print_object boolean -- Returns or sets if this object is printed.
      • top float -- Returns or sets the position of the top of the control.
      • top_left_cell (r/o) range -- Returns the top left cell of the range within which the control is positioned.
      • value integer -- Returns or sets the current value of the control
      • visible boolean -- Returns or sets if the control is visible.
      • width float -- Returns or sets the width of the object.
      • z_order_position (r/o) integer -- Returns the most recently set z order position, bring shape to front/send shape to back/bring shape forward/send shape backward/bring shape in front of text/send shape behind text.
    • Elements:
  • filter -- Represents a filter for a single column.
    • Plural name:
      • filters
    • Inherits from:
    • Properties:
      • criteria1 (r/o) anything -- Returns the first filtered value for the specified column in a filtered range.
      • criteria2 (r/o) anything -- Returns the second filtered value for the specified column in a filtered range.
      • filter_on (r/o) boolean -- Returns true if the specified filter is on.
      • operator k.autofilter_and / k.bottom_10_items / k.bottom_10_percent / k.autofilter_or / k.top_10_items / k.top_10_percent / k.filter_by_value / k.filter_by_cell_color / k.filter_by_font_color / k.filter_by_icon / k.filter_dynamic / k.filter_no_fill / k.filter_by_automatic_font_color / k.filter_by_no_icon -- set or return the operator that associates the two criteria applied by the specified filter.
  • format_color -- Represents a color that a format condition can be colored with.
    • Inherits from:
    • Properties:
      • color RGB_color -- Returns or sets the primary color of the object.
      • color_index k.color_index_automatic / k.color_index_none / k.a_color_index_integer
      • theme_color k.color_index_none / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color -- Returns or sets the theme color in the applied color scheme that is associated with the specified object.
      • tint_and_shade float -- Returns or sets a Single that lightens or darkens a color.
  • format_condition_icon_object
    • Inherits from:
    • Properties:
      • format_condition_icon_index (r/o) integer -- The index of the icon. Read only.
  • format_condition_icon_set
    • Inherits from:
    • Properties:
      • icon_set_id (r/o) k.icon_set_custom / k.icon_set_3_arrows / k.icon_set_3_arrows_gray / k.icon_set_3_flags / k.icon_set_3_traffic_lights_1 / k.icon_set_3_traffic_lights_2 / k.icon_set_3_signs / k.icon_set_3_symbols / k.icon_set_3_symbols_2 / k.icon_set_4_arrows / k.icon_set_4_arrows_gray / k.icon_set_4_red_to_black / k.icon_set_4_CRV / k.icon_set_4_traffic_lights / k.icon_set_5_arrows / k.icon_set_5_arrows_gray / k.icon_set_5_CRV / k.icon_set_5_quarters / k.icon_set_3_stars / k.icon_set_3_triangles / k.icon_set_5_boxes
  • format_condition_icon_sets
  • format_condition -- Represents a conditional format.
    • Plural name:
      • format_conditions
    • Inherits from:
    • Properties:
      • applies_to (r/o) range -- Returns the range this format condition applies to. Read Only.
      • condition_operator (r/o) k.operator_between / k.operator_not_between / k.operator_equal / k.operator_not_equal / k.operator_greater / k.operator_less / k.operator_greater_equal / k.operator_less_equal -- Returns the operator for the conditional format.
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • format_condition_date_operator k.date_is_today / k.date_is_yesterday / k.date_is_within_the_last_seven_days / k.date_is_this_week / k.date_is_last_week / k.date_is_last_month / k.date_is_tomorrow / k.date_is_next_week / k.date_is_next_month / k.date_is_this_month
      • format_condition_priority integer -- Specifies the priority for the format condition. Read/Write.
      • format_condition_text unicode_text -- Returns or sets the text for the specified object.
      • format_condition_text_operator k.text_contains / k.text_does_not_contain / k.text_begins_with / k.text_ends_with
      • format_condition_type (r/o) k.cell_value / k.expression / k.color_scale / k.databar / k.top_10 / k.icon_sets / k.unique_values / k.text_string / k.blanks_condition / k.time_period / k.above_average_condition / k.no_blanks_condition / k.errors_condition / k.no_errors_condition -- Return the conditional format type.
      • formula_1 (r/o) unicode_text -- Returns the value or expression associated with the conditional format or data validation.
      • formula_2 (r/o) unicode_text -- Returns the value or expression associated with the second part of a conditional format or data validation. Used only when the data validation conditional format Operator property is operator between or operator not between.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • number_format unicode_text -- Returns or sets the format code for the object.
      • pivot_condition_scope_type k.pivot_condition_selection_scope / k.pivot_condition_fields_scope / k.pivot_condition_data_field_scope -- Returns or sets the part of the pivot table that the pivot table format condition is scoped to
      • pivot_table_condition (r/o) boolean -- Tells whether this format condition is a pivot table condition.
      • stop_if_true boolean -- Tells whether the processing of format conditions stops if this condition is true. Read/Write.
  • graphic -- Contains properties that apply to header and footer picture objects.
    • Plural name:
      • graphics
    • Inherits from:
    • Properties:
      • brightness short_float -- Returns or sets the brightness of the specified picture. The value for this property must be a number from 0.0, dimmest, to 1.0, brightest.
      • color_type k.picture_color_type_unset / k.picture_color_automatic / k.picture_color_gray_scale / k.picture_color_black_and_white / k.picture_color_watermark -- Returns or sets the type of color transformation applied to the specified picture.
      • contrast short_float -- Returns or sets the contrast for the specified picture. The value for this property must be a number from 0.0, the least contrast, to 1.0, the greatest contrast.
      • crop_bottom short_float -- Returns or sets the number of points that are cropped off the bottom of the specified picture.
      • crop_left short_float -- Returns or sets the number of points that are cropped off the left side of the specified picture.
      • crop_right short_float -- Returns or sets the number of points that are cropped off the right side of the specified picture.
      • crop_top short_float -- Returns or sets the number of points that are cropped off the top of the specified picture.
      • file_name unicode_text -- Returns or sets the URL, on the intranet or the Web, or path, local or network, to the location where the specified source object was saved.
      • height short_float -- Returns or sets the height of the object.
      • lock_aspect_ratio boolean -- Returns or sets if the specified shape retains its original proportions when you resize it. False if you can change the height and width of the shape independently of one another when you resize it.
      • width short_float -- Returns or sets the width of the object.
  • groupbox
    • Plural name:
      • groupboxes
    • Inherits from:
    • Properties:
      • accelerator unicode_text -- Returns or sets the accelerator character for this control.
      • bottom_right_cell (r/o) range -- Returns the bottom right cell of the range the control is occupying.
      • caption unicode_text -- Returns or sets the caption for this object.
      • control_text unicode_text -- Returns or sets the default text for the control.
      • display_threeD_shading boolean
      • enabled boolean -- Returns or sets if the object is enabled.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • height float -- Returns or set the height of the object.
      • left_position float -- Returns or sets the position of the specified object, in points.
      • locked boolean -- Returns or sets if the object is locked, if false the object can be modified when the sheet is protected.
      • locked_text boolean -- Returns or sets whether the control's text is locked for editing.
      • name unicode_text -- Returns or sets the name of the object.
      • on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • phonetic_accelerator unicode_text -- Returns or sets the link to a range.
      • placement k.placement_free_floating / k.placement_move / k.placement_move_and_size -- Returns or sets how the object is placed on the worksheet.
      • print_object boolean -- Returns or sets if this object is printed.
      • top float -- Returns or sets the position of the top of the control.
      • top_left_cell (r/o) range -- Returns the top left cell of the range within which the control is positioned.
      • visible boolean -- Returns or sets if the control is visible
      • width float -- Returns or sets the width of the object.
      • z_order_position (r/o) integer -- Returns the most recently set z order position, bring shape to front/send shape to back/bring shape forward/send shape backward/bring shape in front of text/send shape behind text.
    • Elements:
  • hidden_field
    • Plural name:
      • hidden_fields
    • Inherits from:
  • hidden_item
    • Plural name:
      • hidden_items
    • Inherits from:
  • horizontal_page_break -- Represents a horizontal page break.
    • Plural name:
      • horizontal_page_breaks
    • Inherits from:
    • Properties:
      • extent (r/o) k.page_break_full / k.page_break_partial -- Returns the type of the specified page break: full-screen or only within a print area.
      • horizontal_page_break_type k.page_break_automatic / k.page_break_manual / k.page_break_none -- Returns or sets the type of horizontal page break.
      • location range -- Returns or sets where this horizontal page break is located.
  • hyperlink -- Represents a hyperlink.
    • Plural name:
      • hyperlinks
    • Inherits from:
    • Properties:
      • address unicode_text -- Returns or sets the address of the target document.
      • email_subject unicode_text -- Returns or sets the text string of the specified hyperlink's e-mail subject line. The subject line is appended to the hyperlink's address.
      • hyperlink_type (r/o) k.hyperlink_type_text_range / k.hyperlink_type_shape / k.hyperlink_type_inline_shape -- Returns the hyperlink type, what the hyperlink is associated with.
      • name (r/o) unicode_text -- Returns the name of the object.
      • range_object (r/o) range -- Returns a range object that represents the range the specified hyperlink is attached to.
      • screen_tip unicode_text -- Returns or sets the screen tip text for the specified hyperlink.
      • shape_object (r/o) shape -- Returns a shape object that represents the shape attached to the specified hyperlink.
      • sub_address unicode_text -- Returns or sets the location within the document associated with the hyperlink.
      • text_to_display unicode_text -- Returns or sets the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.
  • icon_criteria
  • icon_criterion
    • Inherits from:
    • Properties:
      • condition_operator k.operator_between / k.operator_not_between / k.operator_equal / k.operator_not_equal / k.operator_greater / k.operator_less / k.operator_greater_equal / k.operator_less_equal -- Returns the operator for the conditional format.
      • icon_criterion_icon k.format_condition_icon_no_cell_icon / k.format_condition_icon_green_up_arrow / k.format_condition_icon_yellow_side_arrow / k.format_condition_icon_red_down_arrow / k.format_condition_icon_gray_up_arrow / k.format_condition_icon_gray_side_arrow / k.format_condition_icon_gray_down_arrow / k.format_condition_icon_green_flag / k.format_condition_icon_yellow_flag / k.format_condition_icon_red_flag / k.format_condition_icon_green_circle / k.format_condition_icon_yellow_circle / k.format_condition_icon_red_circle_with_border / k.format_condition_icon_black_circle_with_border / k.format_condition_icon_green_traffic_light / k.format_condition_icon_yellow_traffic_light / k.format_condition_icon_red_traffic_light / k.format_condition_icon_yellow_triangle / k.format_condition_icon_red_diamond / k.format_condition_icon_green_check_symbol / k.format_condition_icon_yellow_exclamation_symbol / k.format_condition_icon_red_cross_symbol / k.format_condition_icon_green_check / k.format_condition_icon_yellow_exclamation / k.format_condition_icon_red_cross / k.format_condition_icon_yellow_up_incline_arrow / k.format_condition_icon_yellow_down_incline_arrow / k.format_condition_icon_gray_up_incline_arrow / k.format_condition_icon_gray_down_incline_arrow / k.format_condition_icon_red_circle / k.format_condition_icon_pink_circle / k.format_condition_icon_gray_circle / k.format_condition_icon_black_circle / k.format_condition_icon_circle_with_one_white_quarter / k.format_condition_icon_circle_with_two_white_quarters / k.format_condition_icon_circle_with_three_white_quarters / k.format_condition_icon_white_circle_all_white_quarters / k.format_condition_icon_0_bars / k.format_condition_icon_1_bar / k.format_condition_icon_2_bars / k.format_condition_icon_3_bars / k.format_condition_icon_4_bars / k.format_condition_icon_gold_star / k.format_condition_icon_half_gold_star / k.format_condition_icon_silver_star / k.format_condition_icon_green_up_triangle / k.format_condition_icon_yellow_dash / k.format_condition_icon_red_down_triangle / k.format_condition_icon_4_filled_boxes / k.format_condition_icon_3_filled_boxes / k.format_condition_icon_2_filled_boxes / k.format_condition_icon_1_filled_box / k.format_condition_icon_0_filled_boxes
      • icon_criterion_index (r/o) integer -- The index of the icon criterion. Read only.
      • icon_criterion_type k.condition_value_none / k.condition_value_number / k.condition_value_lowest_value / k.condition_value_highest_value / k.condition_value_percent / k.condition_value_formula / k.condition_value_percentile / k.condition_value_automatic_minimum / k.condition_value_automatic_maximum -- Returns or sets the condition value type of the icon criterion. Read/Write.
      • icon_criterion_value anything
  • icon_set_format_condition
    • Inherits from:
    • Properties:
      • applies_to (r/o) range -- Returns the range this format condition applies to. Read Only.
      • format_condition_icon_set format_condition_icon_set
      • format_condition_priority integer -- Specifies the priority for the format condition. Read/Write.
      • format_condition_type (r/o) k.cell_value / k.expression / k.color_scale / k.databar / k.top_10 / k.icon_sets / k.unique_values / k.text_string / k.blanks_condition / k.time_period / k.above_average_condition / k.no_blanks_condition / k.errors_condition / k.no_errors_condition -- Return the conditional format type.
      • formula unicode_text -- Returns or sets the value or expression associated with the conditional format or data validation.
      • icon_criteria (r/o) icon_criteria -- Returns the IconCriteria for the IconSetCondition object.
      • percentile_values boolean
      • pivot_condition_scope_type k.pivot_condition_selection_scope / k.pivot_condition_fields_scope / k.pivot_condition_data_field_scope -- Returns or sets the part of the pivot table that the pivot table format condition is scoped to
      • pivot_table_condition (r/o) boolean -- Tells whether this format condition is a pivot table condition.
      • reverse_icon_set_order boolean
      • show_icon_only boolean
      • stop_if_true (r/o) boolean -- Tells whether the processing of format conditions stops if this condition is true. Read Only.
  • international_macro_sheet
    • Plural name:
      • international_macro_sheets
    • Inherits from:
    • Properties:
      • enable_selection k.no_restrictions / k.unlocked_cells / k.no_selection -- Returns or sets what can be selected on the sheet.
  • label
    • Plural name:
      • labels
    • Inherits from:
    • Properties:
      • accelerator unicode_text -- Returns or sets the accelerator character for this control.
      • bottom_right_cell (r/o) range -- Returns the bottom right cell of the range the control is occupying.
      • caption unicode_text -- Returns or sets the caption for the control.
      • control_text unicode_text -- Returns or sets the default text for the control.
      • enabled boolean -- Returns or sets if the control is enabled
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • height float -- Returns or sets the height of the control.
      • left_position float -- Returns or sets the left position of the control
      • locked boolean -- Returns or sets whether the control is locked for editing.
      • locked_text boolean -- Returns or sets whether the control's text is locked for editing.
      • name unicode_text -- Returns or sets the name of this control
      • on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • phonetic_accelerator unicode_text -- Returns or sets the link to a range.
      • placement k.placement_free_floating / k.placement_move / k.placement_move_and_size -- Returns or sets how the object is placed on the worksheet.
      • print_object boolean -- Returns or sets if this object is printed.
      • top float -- Returns or sets the position of the top of the control.
      • top_left_cell (r/o) range -- Returns the top left cell of the range within which the control is positioned.
      • visible boolean -- Returns or sets if the control is visible
      • width float -- Returns or sets the width of the object.
      • z_order_position (r/o) integer -- Returns the most recently set z order position, bring shape to front/send shape to back/bring shape forward/send shape backward/bring shape in front of text/send shape behind text.
    • Elements:
  • linear_gradient -- The LinearGradient object transitions through a series of colors in a linear manner along a specific angle.
    • Inherits from:
    • Properties:
      • colorstops (r/o) colorstops -- Returns the ColorStops for the LinearGradient object.
      • linear_gradient_degree float -- The angle of the linear gradient fill within a selection.
  • list_column -- Represents a column in a list object.
    • Plural name:
      • list_columns
    • Inherits from:
    • Properties:
      • cell_table (r/o) cell -- Returns the cell table from a specified list column.
      • index (r/o) integer
      • name unicode_text -- Returns or sets the name of the object.
      • range_object (r/o) range -- Returns a range object that represents the range to which the specified list column.
      • total_row (r/o) range -- Returns the totals row, if any, from a specified list column.
      • totals_calculation k.none_totals_calc / k.average_totals_calc / k.count_totals_calc / k.count_number_totals_calc / k.max_totals_calc / k.min_totals_calc / k.sum_totals_calc / k.deviation_totals_calc / k.var_totals_calc / k.custom_totals_calc
  • list_object -- Represents a list object on a worksheet.
    • Plural name:
      • list_objects
    • Inherits from:
    • Properties:
      • active (r/o) boolean
      • autofilter_object (r/o) autofilter -- Returns the autofilter object associated with this list object.
      • cell_table (r/o) cell -- Returns the cell table from a specified list object.
      • comment unicode_text -- Returns or sets the comment of the object.
      • default (r/o) unicode_text
      • display_name unicode_text -- Returns or sets the display name of the object.
      • display_right_to_left (r/o) boolean
      • header_row (r/o) range -- Returns a range object that represents the used range on the specified worksheet.
      • insert_row (r/o) range
      • name unicode_text -- Returns or sets the name of the object.
      • query_table (r/o) query_table -- Returns a query table object that represents the query table that intersects the specified range.
      • range_object range -- Returns or sets a range object that represents the range to which the specified list column, object, or row applies.
      • show_autofilter boolean -- Returns or sets if the autofilter is implemented in a list object.
      • show_headers boolean -- Returns or sets if headers is implemented in a list object.
      • show_table_style_column_stripes boolean -- The ShowTableStyleColumnStripes property displays banded columns in which even columns are formatted differently from odd columns.
      • show_table_style_first_column boolean -- Returns or sets if the first column is displayed for the specified ListObject object.
      • show_table_style_last_column boolean -- Returns or sets if the last column is displayed for the specified ListObject object.
      • show_table_style_row_stripes boolean -- The ShowTableStyleRowStripes property displays banded rows in which even rows are formatted differently from odd rows.
      • sort_object (r/o) sort -- Returns the sort object associated with this list object.
      • source_type (r/o) k.src_none / k.src_range / k.src_external
      • table_style null -- Returns or sets the style used in the table body.
      • total boolean -- Returns or sets if a totals row be implemented in a list object.
      • total_row (r/o) range -- Returns the totals row, if any, from a specified list object.
    • Elements:
  • list_row -- Represents a row in a list object.
    • Plural name:
      • list_rows
    • Inherits from:
    • Properties:
      • index (r/o) integer
      • range_object (r/o) range -- Returns a range object that represents the range to which the specified list row applies.
  • listbox
    • Plural name:
      • listboxes
    • Inherits from:
    • Properties:
      • bottom_right_cell (r/o) range -- Returns the bottom right cell of the range the control is occupying.
      • display_threeD_shading boolean -- Returns or sets whether a 3-d effect will be employed when displaying the control
      • enabled boolean -- Returns or sets if the control is enabled
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • height float -- Returns or sets the height of the control.
      • left_position float -- Returns or sets the left position of the control
      • linked_cell unicode_text -- Returns or sets reference to a call which contains the value of the control.
      • list_fill_range unicode_text -- Returns or sets the items which are contained in the control.
      • list_index integer -- Returns or sets the selected item.
      • locked boolean -- Returns or sets whether the control is locked for editing.
      • multi_select k.select_none / k.select_simple / k.select_extended -- Returns or sets the multiple selection setting.
      • name unicode_text -- Returns or sets the name of this control
      • number_of_items_in_list (r/o) integer
      • on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • placement k.placement_free_floating / k.placement_move / k.placement_move_and_size -- Returns or sets how the object is placed on the worksheet.
      • print_object boolean -- Returns or sets if this object is printed.
      • top float -- Returns or sets the position of the top of the control.
      • top_left_cell (r/o) range -- Returns the top left cell of the range within which the control is positioned.
      • value integer -- Returns or sets the current value of the control.
      • visible boolean -- Returns or sets if the control is visible
      • width float -- Returns or sets the width of the object.
      • z_order_position (r/o) integer -- Returns the most recently set z order position, bring shape to front/send shape to back/bring shape forward/send shape backward/bring shape in front of text/send shape behind text.
  • macro_sheet
    • Plural name:
      • macro_sheets
    • Inherits from:
    • Properties:
      • enable_selection k.no_restrictions / k.unlocked_cells / k.no_selection -- Returns or sets what can be selected on the sheet.
  • named_item -- Represents a defined name for a range of cells. Named items can be either built-in names, such as Database, Print_Area, and Auto_Open, or custom names.
    • Plural name:
      • named_items
    • Inherits from:
    • Properties:
      • category unicode_text -- Returns or sets the category for the specified name in the language of the macro.
      • category_local unicode_text -- Returns or sets the category for the specified name, in the language of the user, if the name refers to a custom function or command.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • macro_type k.macro_type_command / k.macro_type_function / k.macro_type_not_XLM -- Returns or sets what the name refers to.
      • name unicode_text -- Returns or sets the name of the object.
      • name_local unicode_text -- Returns or sets the name of the object, in the language of the user.
      • reference_local unicode_text -- Returns or sets the formula that the name refers to. The formula is in the language of the user, and it's in A1-style notation, beginning with an equal sign.
      • reference_local_r1c1 unicode_text -- Returns or sets the formula that the name refers to. This formula is in the language of the user, and it's in R1C1-style notation, beginning with an equal sign.
      • reference_r1c1 unicode_text -- Returns or sets the formula that the name refers to. The formula is in the language of the macro, and it's in R1C1-style notation, beginning with an equal sign.
      • reference_range (r/o) range -- Returns the range object referred to by this object.
      • references unicode_text -- Returns or sets the formula that the name is defined to refer to, in the language of the macro and in A1-style notation, beginning with an equal sign.
      • shortcut_key unicode_text -- Returns or sets the shortcut key for a name defined as a custom Microsoft Excel 4.0 macro command.
      • value unicode_text -- Returns or sets a string containing the formula that the name is defined to refer to. The string is in A1-style notation in the language of the macro, and it begins with an equal sign.
      • visible boolean -- Returns or sets if the object is visible.
  • negative_bar_format
    • Inherits from:
    • Properties:
      • databar_bar_color (r/o) format_color
      • databar_border_color (r/o) format_color -- Returns the DataBarBorder for the Databar object.
      • negative_bar_border_color_type k.databar_color_type_color / k.databar_color_type_same_as_positive -- Returns or sets the type of border of the databar
      • negative_bar_color_type k.databar_color_type_color / k.databar_color_type_same_as_positive -- Returns or sets the type of fill of the databar
  • option_button
    • Plural name:
      • option_buttons
    • Inherits from:
    • Properties:
      • accelerator unicode_text -- Returns or sets the accelerator character for this control.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • bottom_right_cell (r/o) range -- Returns the bottom right cell of the range the control is occupying.
      • caption unicode_text -- Returns or sets the caption for this object.
      • control_text unicode_text -- Returns or sets the default text for the control.
      • display_threeD_shading boolean
      • enabled boolean -- Returns or sets if the object is enabled.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • group_box (r/o) groupbox
      • height float -- Returns or set the height of the object.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • left_position float -- Returns or sets the position of the specified object, in points.
      • linked_cell unicode_text
      • locked boolean -- Returns or sets if the object is locked, if false the object can be modified when the sheet is protected.
      • locked_text boolean -- Returns or sets whether the control's text is locked for editing.
      • name unicode_text -- Returns or sets the name of the object.
      • on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • phonetic_accelerator unicode_text -- Returns or sets the link to a range.
      • placement k.placement_free_floating / k.placement_move / k.placement_move_and_size -- Returns or sets how the object is placed on the worksheet.
      • print_object boolean -- Returns or sets if this object is printed.
      • top float -- Returns the top position of the specified object, in points.
      • top_left_cell (r/o) range -- Returns a range object that represents the cell that lies under the upper-left corner of the specified object.
      • value k.checkbox_off / k.checkbox_on / k.checkbox_mixed
      • visible boolean -- Returns or sets if the object is visible.
      • width float -- Returns or sets the width of the object.
      • z_order_position (r/o) integer -- Returns the z-order position of the object.
    • Elements:
  • outline -- Represents an outline on a worksheet.
    • Plural name:
      • outlines
    • Inherits from:
    • Properties:
      • automatic_styles boolean -- Returns or sets if the outline uses automatic styles.
      • summary_column k.summary_on_left / k.summary_on_right -- Returns or sets the location of the summary columns in the outline, as shown in the following table.
      • summary_row k.summary_above / k.summary_below -- Returns or sets the location of the summary rows in the outline, as shown in the following table.
  • page_field
  • page_setup -- Represents the page setup description. The page setup object contains all page setup attributes, left margin, bottom margin, paper size, and so on, as properties.
    • Plural name:
      • page_setups
    • Inherits from:
    • Properties:
      • black_and_white boolean -- Returns or sets if elements of the document will be printed in black and white.
      • bottom_margin float -- Returns or sets the size of the bottom margin, in points.
      • center_footer unicode_text -- Returns or sets the center part of the footer.
      • center_footer_picture (r/o) graphic -- Returns or sets a graphic object that represents the picture for the center section of the footer. Used to set attributes about the picture.
      • center_header unicode_text -- Returns or sets the center part of the header.
      • center_header_picture (r/o) graphic -- Returns or sets a graphic object that represents the picture for the center section of the footer. Used to set attributes about the picture.
      • center_horizontally boolean -- Returns or sets if the sheet is centered horizontally on the page when it's printed.
      • center_vertically boolean -- Returns or sets if the sheet is centered vertically on the page when it's printed.
      • chart_size k.fit_to_page / k.full_page / k.full_screen -- Returns or sets the way a chart is scaled to fit on a page.
      • draft boolean -- Returns or sets if the sheet will be printed without graphics.
      • first_page_number integer -- Returns or sets the first page number that will be used when this sheet is printed.
      • fit_to_pages_tall integer -- Returns or sets the number of pages tall the worksheet will be scaled to when it's printed. Applies only to worksheets.
      • fit_to_pages_wide integer -- Returns or sets the number of pages wide the worksheet will be scaled to when it's printed. Applies only to worksheets.
      • footer_margin float -- Returns or sets the distance from the bottom of the page to the footer, in points.
      • header_margin float -- Returns or sets the distance from the top of the page to the header, in points.
      • left_footer unicode_text -- Returns or sets the left part of the footer.
      • left_footer_picture (r/o) graphic -- Returns or sets a graphic object that represents the picture for the left section of the footer. Used to set attributes about the picture.
      • left_header unicode_text -- Returns or sets the left part of the header.
      • left_header_picture (r/o) graphic -- Returns or sets a graphic object that represents the picture for the left section of the header. Used to set attributes about the picture.
      • left_margin float -- Returns or sets the size of the left margin, in points.
      • order k.down_then_over / k.over_then_down -- Returns or sets the order that Microsoft Excel uses to number pages when printing a large worksheet.
      • page_orientation k.landscape / k.portrait -- Returns or set if the printing mode will be portrait or landscape.
      • print_Excel_comments k.print_sheet_end / k.print_in_place / k.print_no_comments -- Returns or sets the way comments are printed with the sheet.
      • print_area unicode_text -- Returns or sets the range to be printed, as a string using A1-style references in the language of the macro.
      • print_gridlines boolean -- Returns or sets if cell gridlines are printed on the page. Applies only to worksheets.
      • print_headings boolean -- Returns or sets if row and column headings are printed with this page. Applies only to worksheets.
      • print_notes boolean -- Returns or sets if cell notes are printed as end notes with the sheet. Applies only to worksheets.
      • print_quality list -- Set/Gets a two element list where 1 is the horizontal print quality and 2 is the vertical print quality
      • print_title_columns unicode_text -- Returns or sets the columns that contain the cells to be repeated on the left side of each page, as a string in A1-style notation in the language of the macro.
      • print_title_rows unicode_text -- Returns or sets the rows that contain the cells to be repeated at the top of each page, as a string in A1-style notation in the language of the macro.
      • right_footer unicode_text -- Returns or sets the right part of the footer.
      • right_footer_picture (r/o) graphic -- Returns or sets a graphic object that represents the picture for the right section of the footer. Used to set attributes about the picture.
      • right_header unicode_text -- Returns or sets the right part of the header.
      • right_header_picture (r/o) graphic -- Returns or sets a graphic object that represents the picture for the right section of the header. Used to set attributes about the picture.
      • right_margin float -- Returns or sets the size of the right margin, in points.
      • top_margin float -- Returns or sets the size of the top margin, in points.
      • zoom k.percentable / k.a_bool -- Returns or sets a percentage, between 10 and 400 percent, by which Microsoft Excel will scale the worksheet for printing. Applies only to worksheets.
  • pane -- Represents a pane of a window. Pane objects exist only for worksheets and Microsoft Excel 4.0 macro sheets.
    • Plural name:
      • panes
    • Inherits from:
    • Properties:
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • scroll_column integer -- Returns or sets the number of the leftmost column in the pane
      • scroll_row integer -- Returns or sets the number of the row that appears at the top of the pane.
      • visible_range (r/o) range -- Returns a Range object that represents the range of cells that are visible in the pane. If a column or row is partially visible, it's included in the range.
  • parent_item
    • Plural name:
      • parent_items
    • Inherits from:
  • phonetic -- Contains information about a specific phonetic text string in a cell.
    • Plural name:
      • phonetics
    • Inherits from:
    • Properties:
      • character_type k.phonetic_character_half_width_katakana / k.phonetic_character_full_width_katakana / k.phonetic_character_hiragana / k.no_phonetic_character_conversion -- Returns or sets the type of phonetic text in the specified cell.
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • phonetic_alignment k.phonetic_align_no_control / k.phonetic_align_left / k.phonetic_align_center / k.phonetic_align_distributed -- Returns or sets the alignment for the specified phonetic text.
      • phonetic_text unicode_text -- Returns or sets the text for the specified object.
      • visible boolean -- Returns or sets if the object is visible
  • pivot_axis -- Used as the base class for the PivotDataAxis, PivotFilterAxis, and PivotGroupAxis objects. There are no properties or methods which with you can use the PivotAxis object directly.
  • pivot_cache -- Represents the memory cache for a PivotTable report.
    • Plural name:
      • pivot_caches
    • Inherits from:
    • Properties:
      • ADO_connection (r/o) null -- Returns an ADO connection object if the PivotTable cache is connected to an OLE DB data source.
      • OLAP (r/o) boolean -- Returns True if the PivotTable cache is connected to an Online Analytical Processing server.
      • SQL_query unicode_text -- Returns or sets the SQL query string used with the specified ODBC data source.
      • background_query boolean -- Returns or sets if queries for the pivot table report or query table are performed asynchronously, in the background.
      • command_text unicode_text -- Returns or sets the command string for the specified data source.
      • command_type k.cmd_cube / k.cmd_sql / k.cmd_table / k.cmd_default / k.cmd_list -- Returns or sets a constant describing the value type of the CommandText property.
      • connection unicode_text -- Returns or sets a string that contains one of the following. ODBC settings that enable Microsoft Excel to connect to an ODBC data source, a URL that enables Microsoft Excel to connect to a Web data source, or a file that specifies a database or Web query.
      • enable_refresh boolean -- Returns or sets if the pivot table cache can be refreshed by the user.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • is_connected (r/o) boolean -- Returns True if the MaintainConnection property is True and the PivotTable cache is currently connected to its source.
      • local_connection unicode_text -- Returns or sets the connection string to an offline cube file.
      • maintain_connection boolean -- True if the connection to the specified data source is maintained after the refresh and until the workbook is closed.
      • memory_used (r/o) integer -- Returns the amount of memory currently being used by the object, in bytes.
      • missing_items_limit k.missing_items_default / k.missing_items_none / k.missing_items_max / k.missing_items_max2 -- Returns or sets the maximum quantity of unique items per PivotTable field that are retained even when they have no supporting data in the cache records.
      • optimize_cache boolean -- Returns or set if the pivot table cache is optimized when it's constructed.
      • query_type (r/o) k.ODBC_query / k.DAO_record_set / k.web_query / k.OLE_DB_query / k.text_import / k.ADO_recordset / k.FileMaker_query -- Indicates the type of query used by Microsoft Excel to populate the PivotTable cache.
      • record_count (r/o) integer -- Returns the number of records in the pivot table cache or the number of cache records that contain the specified item.
      • refresh_date (r/o) date -- Returns the date on which the pivot cache was last refreshed.
      • refresh_name (r/o) unicode_text -- Returns the name of the person who last refreshed the pivot cache.
      • refresh_on_file_open boolean -- Returns or sets if the pivot table cache or query table is automatically updated each time the workbook is opened.
      • refresh_period integer -- Returns or sets the number of minutes between refreshes.
      • robust_connect k.as_required / k.always / k.never -- Returns or sets how the PivotTable cache connects to its data source.
      • save_password boolean -- Returns or set if password information in an ODBC connection string is saved with the specified query. if false, the password is removed.
      • source_connection_file unicode_text -- Returns or sets a String indicating the Microsoft Office Data Connection file or similar file that was used to create the PivotTable.
      • source_data k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_strings -- Returns or sets the data source for the pivot table.
      • source_type (r/o) k.consolidation / k.database / k.external / k.pivot_table -- Returns a value that identifies the type of item being published.
      • upgrade_on_refresh boolean -- Contains information on whether to upgrade the PivotCache and all connected PivotTables on the next refresh.
      • use_local_connection boolean -- True if the LocalConnection property is used to specify the string that enables Microsoft Excel to connect to a data source.
      • version_ (r/o) k.pivot_table_version_2000 / k.pivot_table_version_10 / k.pivot_table_version_11 / k.pivot_table_version_12 / k.pivot_table_version_14 / k.pivot_table_version_current -- Returns the version of Microsoft Excel in which the PivotCache was created.
      • workbook_connection (r/o) null -- Establishes a connection between the current workbook and the PivotCache object.
  • pivot_cell -- Represents a cell in a PivotTable report.
    • Inherits from:
    • Properties:
      • MDX (r/o) unicode_text
      • cell_changed (r/o) k.cell_not_changed / k.cell_changed / k.cell_change_applied
      • custom_subtotal_function (r/o) k.do_average / k.do_count / k.do_count_numbers / k.do_maximum / k.do_minimum / k.do_product / k.do_standard_deviation / k.do_standard_deviation_p / k.do_sum / k.do_var / k.do_var_p -- Returns the custom subtotal function field setting of a PivotCell object.
      • data_field (r/o) pivot_field -- Returns a PivotField object that corresponds to the selected data field.
      • data_source_value (r/o) null
      • pivot_cell_type (r/o) k.pivot_cell_value / k.pivot_cell_pivot_item / k.pivot_cell_subtotal / k.pivot_cell_grand_total / k.pivot_cell_data_field / k.pivot_cell_pivot_field / k.pivot_cell_page_field_item / k.pivot_cell_custom_subtotal / k.pivot_cell_data_pivot_field / k.pivot_cell_blank_cell -- Returns a constant that identifies the PivotTable entity the cell corresponds to.
      • pivot_column_line (r/o) pivot_line -- Returns the PivotLine on a column for a specific PivotCell object.
      • pivot_field (r/o) pivot_field -- Returns a PivotField object that represents the PivotTable field containing the upper-left corner of the specified range.
      • pivot_item (r/o) pivot_item -- Returns a PivotItem object that represents the PivotTable item containing the upper-left corner of the specified range.
      • pivot_row_line (r/o) pivot_line -- Returns the PivotLine on a row for a specific PivotCell object.
      • pivot_table (r/o) pivot_table -- Returns a PivotTable object that represents the PivotTable report associated with the PivotCell.
      • range (r/o) range -- Returns a Range object that represents the range the specified PivotCell applies to.
      • row_items null -- Returns a PivotItemList collection that corresponds to the items on the category axis that represent the selected cell.
  • pivot_field -- Represents a field in a pivot table.
    • Plural name:
      • pivot_fields
    • Inherits from:
    • Inherited by:
    • Properties:
      • all_items_visible (r/o) boolean -- Used to retrieve a Boolean value that indicates whether or not any manual filtering is applied to the PivotField.
      • auto_show_count (r/o) integer -- Returns the number of top or bottom items that are automatically shown in the pivot field.
      • auto_show_field (r/o) unicode_text -- Returns the name of the data field used to determine the top or bottom items that are automatically shown in the pivot field.
      • auto_show_range (r/o) k.position_top / k.position_bottom -- Returns position top if the top items are shown automatically in the pivot field, returns position bottom if the bottom items are shown.
      • auto_show_type (r/o) k.type_automatic / k.type_manual -- Returns type_automatic if auto show is enabled for the pivot field, or returns type_manual if auto show is disabled.
      • auto_sort_custom_subtotal (r/o) integer -- Returns the name of the custom subtotal used to sort the specified PivotTable field automatically.
      • auto_sort_field (r/o) unicode_text -- Returns the name of the data field used to sort the pivot field automatically.
      • auto_sort_order (r/o) k.sort_ascending / k.sort_descending / k.sort_manual -- Returns the order used to sort the pivot field automatically.
      • auto_sort_pivot_line (r/o) pivot_line -- Returns the name of the PivotLine used to sort the specified PivotTable field automatically.
      • base_field unicode_text -- Returns or sets the base field for a custom calculation.
      • base_item unicode_text -- Returns or sets the item in the base field for a custom calculation.
      • calculation k.pivot_field_calculation_difference_from / k.pivot_field_calculation_index / k.pivot_field_calculation_no_additional_calculation / k.pivot_field_calculation_percent_difference_from / k.pivot_field_calculation_percent_of / k.pivot_field_calculation_percent_of_column / k.pivot_field_calculation_percent_of_row / k.pivot_field_calculation_percent_of_total / k.pivot_field_calculation_running_total -- Returns or sets the type of calculation done by the specified pivot field.
      • caption unicode_text -- The label text for the pivot field.
      • child_field (r/o) pivot_field -- Returns a pivot field object that represents the child pivot field for the specified field, if the field is grouped and has a child field.
      • cube_field (r/o) cube_field -- Returns the CubeField object from which the specified PivotTable field is descended.
      • current_page unicode_text -- Returns or sets the current page showing for the page field, only valid for page fields.
      • current_page_list null -- Returns or sets an array of strings corresponding to the list of items included in a multiple-item page field of a PivotTable report.
      • current_page_name unicode_text -- Returns or sets the currently displayed page of the specified PivotTable report.
      • data_range (r/o) range -- Returns a range object. For a data field the range is the data contained in the field, for a row, column or page field it is the items in the field.
      • database_sort boolean -- When set to True, manual repositioning of items in a PivotTable field is allowed.
      • display_as_caption (r/o) boolean -- This property is used to display member properties of PivotFields as captions.
      • display_as_tooltip boolean -- This property is used to specify whether or not a specific member property PivotField is displayed in tooltips.
      • display_in_report boolean -- This property is used to specify whether the specified member property PivotField is displayed in the PivotTable or not.
      • drag_to_column boolean -- Returns or sets if the pivot field can be dragged to the column position.
      • drag_to_data boolean -- Returns or sets if the field can be dragged to the data position.
      • drag_to_hide boolean -- Returns or sets if the field can be hidden by being dragged off the pivot table.
      • drag_to_page boolean -- Returns or sets if the field can be dragged to the page position.
      • drag_to_row boolean -- Returns or sets if the field can be dragged to the row position.
      • drilled_down boolean -- True if the flag for the specified PivotTable field or PivotTable item is set to drilled.
      • enable_item_selection boolean -- When set to False, disables the ability to use the field dropdown in the user interface.
      • enable_multiple_page_items boolean -- Used for specifying whether or not check boxes are present in the filter drop-down list for fields in the page area.
      • formula unicode_text -- Returns or sets the object's formula, in A1-style notation and in the language of the macro.
      • function k.do_average / k.do_count / k.do_count_numbers / k.do_maximum / k.do_minimum / k.do_product / k.do_standard_deviation / k.do_standard_deviation_p / k.do_sum / k.do_var / k.do_var_p -- Returns or sets the function used to summarize the pivot field.
      • group_level (r/o) integer -- Returns the placement of the specified field within a group of fields, if the field is a member of a grouped set of fields.
      • hidden boolean -- This property is used to hide the individual levels of an OLAP hierarchy.
      • hidden_items_list null -- Returns or sets an Object specifying an array of strings that are hidden items for a PivotTable field.
      • include_new_items_in_filter boolean -- Allows developers to specify whether excluded or included items should be tracked when manual filtering is applied to the PivotField.
      • is_calculated (r/o) boolean -- Returns true if the pivot field or item is a calculated field or item.
      • is_member_property (r/o) boolean -- Returns True when the PivotField contains member properties.
      • label_range (r/o) range -- Returns a range object that represents the cell, or cells, that contain the field label.
      • layout_blank_line boolean -- True if a blank row is inserted after the specified row field in a PivotTable report.
      • layout_compact_row boolean -- Specifies whether or not a PivotField is compacted , items of multiple PivotFields are displayed in a single column, when rows are selected.
      • layout_form k.tabular / k.outline -- Returns or sets the way the specified PivotTable items appear.
      • layout_pagebreak boolean -- True if a page break is inserted after each field.
      • layout_subtotal_location k.at_top / k.at_bottom -- Returns or sets the position of the PivotTable field subtotals in relation to either above or below the specified field.
      • member_property_caption unicode_text -- Setting the MemberPropertyCaption property controls which member property is used as caption for a given level.
      • memory_used (r/o) integer -- Returns the amount of memory currently being used by the object, in bytes.
      • name unicode_text -- Returns or sets the name of the pivot field.
      • number_format unicode_text -- Returns or sets the format code for the pivot field.
      • parent_field (r/o) pivot_field -- Returns a pivot field object that represents the pivot field that's the group parent of the object. The field must be grouped and have a parent field.
      • pivot_field_data_type (r/o) k.pivot_field_type_date / k.pivot_field_type_number / k.pivot_field_type_text -- Returns an enumeration describing the type of data in the pivot field.
      • pivot_field_orientation k.orient_as_column_field / k.orient_as_data_field / k.orient_as_hidden / k.orient_as_page_field / k.orient_as_row_field -- The location of the field in the pivot table.
      • position integer -- Position of the field, first, second, third, and so on, among all the fields in its orientation, rows, columns, pages, data.
      • property_order integer -- Valid only for PivotTable fields that are member property fields.
      • property_parent_field (r/o) pivot_field -- Returns a PivotField object representing the field to which the properties in this field pertain.
      • repeat_labels boolean
      • server_based boolean -- Returns or sets if the pivot table's data source is external and only the items matching the page field selection are retrieved.
      • show_all_items boolean -- Returns or sets if all items in the pivot table are displayed, even if they don't contain summary data.
      • show_detail boolean -- Gets or sets whether the specified PivotField is showing detail.
      • showing_in_axis (r/o) boolean -- Indicates if the PivotField is currently visible in the PivotTable or not.
      • source_caption (r/o) unicode_text -- The SourceCaption property is applicable only for OLAP PivotTables, and returns the original caption from the OLAP server for a PivotField.
      • source_name (r/o) unicode_text -- Return the specified object's name, as it appears in the original source data for the pivot table. This might be different from the current item name if the user renamed the item after creating the pivot table.
      • standard_formula unicode_text -- Returns or sets a String specifying formulas with standard English formatting.
      • subtotal_name unicode_text -- Returns or sets the text string label displayed in the subtotal column or row heading in the specified PivotTable report.
      • total_levels (r/o) integer -- Returns the total number of fields in the current field group. If the field isn't grouped, or if the data source is OLAP-based, TotalLevels returns the value 1.
      • use_member_property_as_caption boolean -- This property is used to control whether member property captions are used for PivotItem captions of the PivotField.
      • value unicode_text -- Returns or sets the name of the specified field in the pivot table.
      • visible_items (r/o) list -- Returns a list of all the visible pivot items in the specified field.
      • visible_items_list null -- Returns or sets an array of strings corresponding to the list of items included in a multiple-item page field of a PivotTable report.
    • Elements:
  • pivot_filter -- PivotTable Advanced Filter.
    • Plural name:
      • pivot_filters
    • Inherits from:
    • Inherited by:
    • Properties:
      • active (r/o) boolean -- Returns whether the specified PivotFilter is active.
      • data_cube_field (r/o) cube_field -- This property is applicable only to non-OLAP PivotTables and provides the Value field ,PivotField in the Values area, being filtered by for a value filter.
      • data_field (r/o) pivot_field -- This property is applicable only to non-OLAP PivotTables and provides the Value field ,PivotField in the Values area, being filtered by for a value filter.
      • description (r/o) unicode_text -- Provides an optional description for the PivotFilter object.
      • filter_type (r/o) k.pivot_top_count / k.pivot_bottom_count / k.pivot_top_percent / k.pivot_bottom_percent / k.pivot_top_sum / k.pivot_bottom_sum / k.pivot_value_equals / k.pivot_value_is_not_equal / k.pivot_value_is_greater_than / k.pivot_value_is_greater_than_or_equal_to / k.pivot_value_is_less_than / k.pivot_value_is_less_than_or_equal_to / k.pivot_value_is_between / k.pivot_value_is_not_between / k.pivot_caption_equals / k.pivot_caption_does_not_equal / k.pivot_caption_begins_with / k.pivot_caption_does_not_begin_with / k.pivot_caption_ends_with / k.pivot_caption_does_not_end_with / k.pivot_caption_contains / k.pivot_caption_does_not_contain / k.pivot_caption_is_greater_than / k.pivot_caption_is_greater_than_or_equal_to / k.pivot_caption_is_less_than / k.pivot_caption_is_less_than_or_equal_to / k.pivot_caption_is_between / k.pivot_caption_is_now_between / k.pivot_specific_date / k.pivot_not_specific_date / k.pivot_before / k.pivot_before_or_equal_to / k.pivot_after / k.pivot_after_or_equal_to / k.pivot_between / k.pivot_not_between / k.pivot_tomorrow / k.pivot_today / k.pivot_yesterday / k.pivot_next_week / k.pivot_this_week / k.pivot_last_week / k.pivot_next_month / k.pivot_this_month / k.pivot_last_month / k.pivot_next_quarter / k.pivot_this_quarter / k.pivot_last_quarter / k.pivot_next_year / k.pivot_this_year / k.pivot_last_year / k.pivot_year_to_date / k.pivot_all_dates_in_period_quarter1 / k.pivot_all_dates_in_period_quarter2 / k.pivot_all_dates_in_period_quarter3 / k.pivot_all_dates_in_period_quarter4 / k.pivot_all_dates_in_period_January / k.pivot_all_dates_in_period_Feberary / k.pivot_all_dates_in_period_March / k.pivot_all_dates_in_period_April / k.pivot_all_dates_in_period_May / k.pivot_all_dates_in_period_June / k.pivot_all_dates_in_period_July / k.pivot_all_dates_in_period_August / k.pivot_all_dates_in_period_September / k.pivot_all_dates_in_period_October / k.pivot_all_dates_in_period_November / k.pivot_all_dates_in_period_December -- Specifies the type of filter to be applied.
      • is_member_property_filter (r/o) boolean -- Specifies whether the label filter is based on the PivotItem captions of a member property of the field or on the PivotItem captions of the PivotField itself.
      • member_property_field (r/o) pivot_field -- This property specifies the member property PivotField on which the label filter is based.
      • name (r/o) unicode_text -- This property provides the option of naming filters for reference.
      • order integer -- Specifies the evaluation order of the filter among all Value filters applied to the entire PivotTable.
      • pivot_field (r/o) pivot_field -- Specifies the PivotField to which the filter is applied.
      • value1 (r/o) null -- This property is a user-supplied parameter to define a filter for a PivotField.
      • value2 (r/o) null -- This property is a user-supplied parameter to define a filter for a PivotField.
  • pivot_formula -- Represents a formula used to calculate results in a pivot table report.
    • Plural name:
      • pivot_formulas
    • Inherits from:
    • Properties:
      • entry_index integer -- Returns the index number of the object within the elements of the parent object.
      • formula unicode_text -- Returns or sets the object's formula, in A1-style notation and in the language of the macro.
      • standard_formula unicode_text -- Returns or sets a String specifying formulas with standard English formatting.
      • value unicode_text -- Returns or sets the name of the specified formula in the pivot table formula.
  • pivot_item -- Represents an item in a pivot field. The items are the individual data entries in a field category.
    • Plural name:
      • pivot_items
    • Inherits from:
    • Inherited by:
    • Properties:
      • caption unicode_text -- The label text for the pivot item.
      • data_range (r/o) range -- Returns a range object specifying the data qualified by the item.
      • drilled_down boolean -- True if the flag for the specified PivotTable field or PivotTable item is set to
      • formula unicode_text -- Returns or sets the pivot item's formula, in A1-style notation and in the language of the macro.
      • is_calculated (r/o) boolean -- Returns true if the pivot item is a calculated item.
      • label_range (r/o) range -- Returns a range object that represents all the pivot table cells that contain the item.
      • name unicode_text -- Returns or sets the name of the pivot item.
      • parent_item (r/o) parent_item -- Returns a pivot item object that represents the parent pivot item in the parent pivot field object, the field must be grouped so that it has a parent.
      • parent_show_detail (r/o) boolean -- Return true if the specified item is showing because one of its parents is showing detail. False if the specified item isn't showing because one of its parents is hiding detail. This property is available only if the item is grouped.
      • position integer -- Returns or sets the position of the item in its field, if the item is currently showing.
      • record_count (r/o) integer -- Returns the number of records in the pivot table cache or the number of cache records that contain the specified item.
      • show_detail boolean -- Returns or sets if the pivot item is showing detail.
      • source_name (r/o) unicode_text -- Return the specified object's name, as it appears in the original source data for the pivot table. This might be different from the current item name if the user renamed the item after creating the pivot table.
      • source_name_standard (r/o) unicode_text -- Returns a String that represents the PivotTable item's source name in standard English format settings.
      • standard_formula unicode_text -- Returns or sets a String specifying formulas with standard English formatting.
      • value unicode_text -- Returns or sets set the name of the specified item in the pivot table field.
      • visible boolean -- Returns or sets if the pivot item is visible.
    • Elements:
  • pivot_line -- The PivotLines object is a collection of lines in a PivotTable, containing all lines on rows or columns of the pivot.
    • Plural name:
      • pivot_lines
    • Inherits from:
    • Properties:
      • line_type (r/o) k.pivot_line_regular / k.pivot_line_subtotal / k.pivot_line_grandtotal / k.pivot_line_blank -- Returns an XlPivotLineType constant that indicates the type of PivotLine.
      • pivot_line_cells (r/o) null -- Returns a collection of PivotCell objects in a PivotLine.
      • position (r/o) integer -- Returns or sets the position of the PivotLine object.
  • pivot_table -- Represents a pivot table on a worksheet.
    • Plural name:
      • pivot_tables
    • Inherits from:
    • Properties:
      • CompactRowIndent integer -- Returns or sets the indent increment for PivotItems when compact row layout form is turned on.
      • allocation k.manual_allocation / k.automatic_allocation
      • allocation_method k.equal_allocation / k.weight_allocation
      • allocation_value k.allocate_value / k.allocate_increment
      • allocation_weight_expression unicode_text
      • allow_multiple_filters boolean -- Sets or retrieves a value that indicates whether a PivotField can have multiple filters applied to it at the same time.
      • alternative_text unicode_text -- Returns or sets the descriptive alternative text string for a ShapeRange object when the object is saved to a Web page.
      • cache_index integer -- Returns or sets the index number of the pivot table cache.
      • calculated_members_in_filters boolean
      • change_list (r/o) null
      • column_grand boolean -- Returns or sets if the pivot table shows grand totals for columns.
      • column_range (r/o) range -- Returns a range object that represents the range that contains the pivot table column area.
      • compact_layout_column_header unicode_text -- Specifies the caption that is displayed in the column header of a PivotTable when in compact row layout form.
      • compact_layout_row_header unicode_text -- Specifies the caption that is displayed in the row header of a PivotTable when in compact row layout form.
      • data_body_range (r/o) range -- Returns a range object that represents the range that contains the pivot table data area.
      • data_label_range (r/o) range -- Returns a range object that represents the range that contains the labels for the pivot table data fields.
      • data_pivot_field (r/o) pivot_field -- Returns a PivotField object that represents all the data fields in a PivotTable.
      • display_context_tooltips boolean -- Controls whether or not tooltips are displayed for PivotTable cells.
      • display_empty_column boolean -- Returns True when the nonempty MDX keyword is included in the query to the OLAP provider for the value axis.
      • display_empty_row boolean -- Returns True when the nonempty MDX keyword is included in the query to the OLAP provider for the category axis.
      • display_error_string boolean -- Returns or sets if the pivot table displays a custom error string in cells that contain errors.
      • display_field_captions boolean -- Controls whether or not filter buttons and PivotField captions for rows and columns are displayed in the grid.
      • display_immediate_items boolean -- Returns or sets a Boolean that indicates whether items in the row and column areas are visible when the data area of the PivotTable is empty.
      • display_member_property_tooltips boolean -- Controls whether or not to display member properties in tooltips.
      • display_null_string boolean -- Returns or sets if the pivot table displays a custom string in cells that contain null values.
      • enable_data_value_editing boolean -- True to disable the alert for when the user overwrites values in the data area of the PivotTable.
      • enable_drilldown boolean -- Returns or sets if drilldown is enabled.
      • enable_field_dialog boolean -- Returns or sets if the pivot table field dialog box is available when the user double-clicks the pivot table field.
      • enable_field_list boolean -- False to disable the ability to display the field well for the PivotTable.
      • enable_wizard boolean -- Returns or sets if the pivot table wizard is available.
      • enable_writeback boolean
      • error_string unicode_text -- Returns or sets the string displayed in cells that contain errors when the display error string property is true. The default value is an empty string.
      • file_list_sort_ascending boolean -- Controls the sort order of fields in the PivotTable Field List.
      • grand_total_name unicode_text -- Returns or sets the text string label that is displayed in the grand total column or row heading in the specified PivotTable report
      • has_autoformat boolean -- Returns or sets if the pivot table is automatically formatted when it's refreshed or when fields are moved.
      • in_grid_drop_zones boolean -- This property is used to toggle in-grid drop zones for a PivotTable object.
      • inner_detail unicode_text -- Returns or sets the name of the field that will be shown as detail when the show detail property is true for the innermost row or column field.
      • layout_row_default k.compact_row / k.tabular_row / k.outline_row -- This property specifies the layout settings for PivotFields when they are added to the PivotTable for the first time.
      • location unicode_text -- Gets or sets a String that represents the top-left cell in the body of the specified PivotTable.
      • manual_update boolean -- Returns or sets if the pivot table is recalculated only at the user's request.
      • mdx (r/o) unicode_text -- Returns a String indicating the MDX, Multidimensional-Expression, that would be sent to the provider to populate the current PivotTable view.
      • merge_labels boolean -- Returns or sets if pivot table outer-row item, column item, subtotal, and grand total labels use merged cells.
      • name unicode_text -- Returns or sets the name of the object.
      • null_string unicode_text -- Returns or sets the string displayed in cells that contain null values when the display null string property is true. The default value is an empty string.
      • page_field_order k.down_then_over / k.over_then_down -- Returns or sets the order in which page fields are added to the pivot table layout.
      • page_field_style unicode_text -- Returns or sets the style used in the bound page field area.
      • page_field_wrap_count integer -- Returns or sets the number of pivot table page fields in each column or row.
      • page_range (r/o) range -- Returns a range object that represents the range that contains the pivot table page area.
      • page_range_cells (r/o) range -- Returns a range object that represents the cells in the pivot table containing only the page fields and item drop-down lists.
      • pivot_cache (r/o) pivot_cache -- Returns a pivot cache object that represents the cache for the specified pivot table
      • pivot_column_axis (r/o) pivot_axis -- Returns a PivotAxis object representing the entire column axis
      • pivot_row_axis (r/o) pivot_axis -- Returns a PivotAxis object representing the entire row axis
      • pivot_selection unicode_text -- Returns or sets the pivot table selection, in standard pivot table selection format.
      • pivot_selection_standard unicode_text -- Returns or sets a String indicating the PivotTable selection in standard PivotTable report format using English settings.
      • preserve_formatting boolean -- Returns or sets if pivot table formatting is preserved when the pivot table is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items.
      • print_drill_indicators boolean -- Specifies whether or not drill indicators are printed with the PivotTable.
      • print_titles boolean -- set/get whether the print titles for the worksheet are set based on the PivotTable report.
      • refresh_date (r/o) date -- Returns the date on which the pivot table was last refreshed.
      • refresh_name (r/o) unicode_text -- Returns the name of the person who last refreshed the pivot table data.
      • repeat_items_on_each_printed_page boolean -- True if row, column, and item labels appear on the first row of each page when the specified PivotTable report is printed. False if labels are printed only on the first page.
      • row_grand boolean -- Returns or sets if the pivot table shows grand totals for rows.
      • row_range (r/o) range -- Returns a range object that represents the range including the pivot table row area.
      • save_data boolean -- Returns or sets if data for the pivot table is saved with the workbook. If false only the pivot table definition is saved.
      • selection_mode k.selection_mode_label_only / k.selection_mode_data_and_label / k.selection_mode_data_only / k.selection_mode_origin / k.selection_mode_button / k.selection_mode_blanks -- Returns or sets the pivot table structured selection mode.
      • show_drill_indicators boolean -- When the ShowDrillIndicators property is set to False, the PrintDrillIndicators property has no effect.
      • show_page_multiple_label boolean -- When set to True, Multiple Items will appear in the PivotTable cell on the worksheet whenever items are hidden and an aggregate of nonhidden items is shown in the PivotTable view.
      • show_table_style_column_headers boolean -- The ShowTableStyleColumnHeaders property is set to True if the coulmn headers should be displayed in the PivotTable.
      • show_table_style_column_stripes boolean -- The ShowTableStyleColumnStripes property displays banded columns in which even columns are formatted differently from odd columns.
      • show_table_style_last_column boolean -- Returns or sets if the last column is displayed for the specified ListObject object.
      • show_table_style_row_headers boolean -- The ShowTableStyleRowHeaders property is set to True if the row headers should be displayed in the PivotTable.
      • show_table_style_row_stripes boolean -- The ShowTableStyleRowStripes property displays banded rows in which even rows are formatted differently from odd rows.
      • show_values_row boolean
      • small_grid boolean -- Returns or sets if Microsoft Excel uses a grid that's two cells wide and two cells deep for a newly created pivot table report. False if Excel uses a blank stencil outline.
      • sort_using_custom_lists boolean -- The SortUsingCustomLists property controls whether custom lists are used for sorting items of fields.
      • source_data k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_strings -- Either a range reference as a string or a list of SQL commands
      • subtotal_hidden_page_items boolean -- Returns or sets if hidden page field items in the pivot table are included in row and column subtotals, block totals, and grand totals.
      • summary unicode_text
      • table_range1 (r/o) range -- Returns a range object that represents the range containing the entire pivot table, but doesn't include page fields.
      • table_range2 (r/o) range -- Returns a range object that represents the range containing the entire pivot table, including page fields.
      • table_style unicode_text -- Returns or sets the style used in the pivot table body.
      • table_style2 null -- The TableStyle2 property specifies the PivotTable style currently applied to the PivotTable.
      • tag unicode_text -- Returns or sets a string saved with the pivot table.
      • totals_annotation boolean -- True if an asterisk is displayed next to each subtotal and grand total value in the specified PivotTable report if the report is based on an OLAP data source.
      • vacated_style unicode_text -- Returns or sets the style applied to cells vacated when the pivot table is refreshed.
      • value unicode_text -- Returns or set the name of the pivot table.
      • version_ (r/o) k.pivot_table_version_2000 / k.pivot_table_version_10 / k.pivot_table_version_11 / k.pivot_table_version_12 / k.pivot_table_version_14 / k.pivot_table_version_current
      • view_calculated_members boolean -- When set to True, calculated members for Online Analytical Processing, OLAP, PivotTables can be viewed.
      • visual_totals boolean -- True to enable Online Analytical Processing, OLAP, PivotTables to retotal after an item has been hidden from view.
      • visual_totals_for_sets boolean
    • Elements:
  • query_table -- Represents a worksheet table built from data returned from an external data source, such as an SQL server.
    • Plural name:
      • query_tables
    • Inherits from:
    • Properties:
      • FileMaker_fields list
      • FileMaker_num_criteria integer
      • FileMaker_use_table boolean -- Returns or sets if the query uses a table rather than a layout. Only applicable for FileMaker 7 or above
      • adjust_column_width boolean -- Returns or sets if the column widths are automatically adjusted for the best fit each time you refresh the specified query table.
      • background_query boolean -- Returns or sets if queries for the query table are performed asynchronously.
      • command_type k.cmd_cube / k.cmd_sql / k.cmd_table / k.cmd_default / k.cmd_list -- Returns or sets one of the XlCmdType constants listed in the following table in the remarks section.
      • connection unicode_text -- Returns or sets a string that contains one of the following: ODBC settings that enable Microsoft Excel to connect to an ODBC data source; a URL that enables Microsoft Excel to connect to a Web data source; or a file that specifies a database or Web query.
      • destination (r/o) range -- Returns the cell in the upper-left corner of the query table destination range, the range where the resulting query table will be placed. The destination range must be on the worksheet that contains the query table object.
      • enable_editing boolean -- Returns or sets if the user can edit the specified query table. False if the user can only refresh the query table.
      • enable_refresh boolean -- Returns or sets if the query table can be refreshed by the user.
      • fetched_row_overflow (r/o) boolean -- Returns true if the number of rows returned by the last use of the refresh method is greater than the number of rows available on the worksheet.
      • field_names boolean -- Returns or sets if field names from the data source appear as column headings for the returned data.
      • fill_adjacent_formulas boolean -- Returns or sets if formulas to the right of the specified query table are automatically updated whenever the query table is refreshed.
      • has_autoformat boolean -- Returns or sets if the query table is automatically formatted when it's refreshed or when fields are moved.
      • name unicode_text -- Returns or sets the name of the object.
      • post_text unicode_text -- Returns or sets the string used with the post method of inputting data into a Web server to return data from a Web query.
      • query_type (r/o) k.ODBC_query / k.DAO_record_set / k.web_query / k.OLE_DB_query / k.text_import / k.ADO_recordset / k.FileMaker_query -- Returns the type of query used by Microsoft Excel to populate the query table.
      • refresh_on_file_open boolean -- Returns or sets if the query table is automatically updated each time the workbook is opened.
      • refresh_style k.overwrite_cells / k.insert_delete_cells / k.insert_entire_rows -- Returns or sets the way rows on the specified worksheet are added or deleted to accommodate the number of rows in a recordset returned by a query.
      • refreshing (r/o) boolean -- Returns true if there's a background query in progress for the specified query table.
      • result_range (r/o) range -- Returns a range object that represents the area of the worksheet occupied by the specified query table.
      • row_numbers boolean -- Returns or sets if row numbers are added as the first column of the specified query table.
      • save_data boolean -- Returns or sets if data for the query table is saved with the workbook.
      • save_password boolean -- Returns or sets if password information in an ODBC connection string is saved with the specified query.
      • sql unicode_text -- Returns or sets the SQL query string used with the specified ODBC data source.
      • tables_only_from_html boolean -- Returns or sets if only the HTML tables in the document are read when a query table is refreshed. False if the entire HTML document is read when a query table is refreshed. This property has an effect only when the query table is using a URL connection.
      • text_file_column_data_types list -- A list of enums: general format, text format, MDY format, DMY format, YMD format, MYD format, DYM format, YDM format, skip column
      • text_file_comma_delimiter boolean -- Returns or sets if the comma character is the delimiter when you import a text file into a query table.
      • text_file_consecutive_delimiter boolean -- Returns or sets if consecutive delimiters are treated as a single delimiter when you import a text file into a query table.
      • text_file_decimal_separator unicode_text -- Returns or sets the decimal separator character that Microsoft Excel uses when you import a text file into a query table. The default is the system decimal separator character.
      • text_file_fixed_column_widths list -- Returns or sets a list of numbers that correspond to the widths of the columns in the text file that you are importing into a query table. Valid widths are from 1 through 32767 characters.
      • text_file_other_delimiter unicode_text -- Returns or sets the character used as the delimiter when you import a text file into a query table.
      • text_file_parse_type k.delimited / k.fixed_width -- Returns or sets the column format for the data in the text file that you're importing into a query table.
      • text_file_platform k.Macintosh / k.MSDos / k.MSWindows -- Returns or sets the origin of the text file you're importing into the query table. This property determines which code page is used during the data import.
      • text_file_prompt_on_refresh boolean -- Returns or sets if you want to specify the name of the imported text file each time the query table is refreshed.
      • text_file_semicolon_delimiter boolean -- Returns or sets if the semicolon character is the delimiter when you import a text file into a query table.
      • text_file_space_delimiter boolean -- Returns or sets if the space character is the delimiter when you import a text file into a query table.
      • text_file_start_row integer -- Returns or sets the row number at which text parsing will begin when you import a text file into a query table. Valid values are integers from 1 through 32767. The default value is 1.
      • text_file_tab_delimiter boolean -- Returns or sets if the tab character is the delimiter when you import a text file into a query table.
      • text_file_text_qualifier k.text_qualifier_double_quote / k.text_qualifier_none / k.text_qualifier_single_quote -- Returns or sets the text qualifier when you import a text file into a query table. The text qualifier specifies that the enclosed data is in text format.
      • text_file_thousands_separator unicode_text -- Returns or sets the thousands separator character thatMicrosoft Excel uses when you import a text file into a query table. The default is the system thousands separator character.
      • use_list_object boolean
  • recent_file -- Represents a file in the list of recently used files.
    • Plural name:
      • recent_files
    • Inherits from:
    • Properties:
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • name (r/o) unicode_text -- Returns the name of the object.
      • path (r/o) unicode_text -- Returns the complete path to the file, excluding the final separator and name of the file.
  • rectangular_gradient -- The RectangularGradient object transitions through a series of colors from the center to one or more sides.
    • Inherits from:
    • Properties:
      • colorstops (r/o) colorstops -- Returns the ColorStops for the LinearGradient object.
      • rectangular_gradient_bottom float -- Represents the point or vector that the gradient fill converges to.
      • rectangular_gradient_left float -- Represents the point or vector that the gradient fill converges to.
      • rectangular_gradient_right float -- Represents the point or vector that the gradient fill converges to.
      • rectangular_gradient_top float -- Represents the point or vector that the gradient fill converges to.
  • row_field
  • row_item
    • Plural name:
      • row_items
    • Inherits from:
  • scenario -- Represents a scenario on a worksheet. Represents a scenario on a worksheet. A scenario is a group of input values, called changing cells, that's named and saved.
    • Plural name:
      • scenarios
    • Inherits from:
    • Properties:
      • Excel_comment unicode_text -- Returns or sets the comment associated with the scenario. The comment text cannot exceed 255 characters.
      • changing_cells (r/o) range -- Returns a range object that represents the changing cells for a scenario.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • hidden boolean -- Returns or sets if the scenario is hidden.
      • locked boolean -- Returns or sets if the object is locked.
      • name unicode_text -- Returns or sets the name of the object.
  • scrollbar
    • Plural name:
      • scrollbars
    • Inherits from:
    • Properties:
      • bottom_right_cell (r/o) range -- Returns the bottom right cell of the range the control is occupying.
      • display_threeD_shading boolean
      • enabled boolean -- Returns or sets if the object is enabled.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • height float -- Returns or set the height of the object.
      • large_change integer
      • left_position float -- Returns or sets the position of the specified object, in points.
      • linked_cell unicode_text
      • locked boolean -- Returns or sets if the object is locked, if false the object can be modified when the sheet is protected.
      • maximum_value integer
      • minimum_value integer
      • name unicode_text -- Returns or sets the name of the object.
      • on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • placement k.placement_free_floating / k.placement_move / k.placement_move_and_size -- Returns or sets how the object is placed on the worksheet.
      • print_object boolean -- Returns or sets if this object is printed.
      • small_change integer
      • top float -- Returns the top position of the specified object, in points.
      • top_left_cell (r/o) range -- Returns a range object that represents the cell that lies under the upper-left corner of the specified object.
      • value integer
      • visible boolean -- Returns or sets if the object is visible.
      • width float -- Returns or sets the width of the object.
      • z_order_position (r/o) integer -- Returns the z-order position of the object.
  • sheet -- Represents a worksheet.
    • Plural name:
      • sheets
    • Inherits from:
    • Inherited by:
    • Properties:
      • autofilter_mode boolean -- Returns or sets if the autofilter drop-down arrows are currently displayed on the sheet. This property is independent of the filter mode property.
      • autofilter_object (r/o) autofilter -- Returns the autofilter object associated with this sheet.
      • circular_reference (r/o) range -- Returns a range object that represents the range containing the first circular reference on the sheet, or returns missing value if there's no circular reference on the sheet.
      • consolidation_function (r/o) k.do_average / k.do_count / k.do_count_numbers / k.do_maximum / k.do_minimum / k.do_product / k.do_standard_deviation / k.do_standard_deviation_p / k.do_sum / k.do_var / k.do_var_p -- Returns the function code used for the current consolidation.
      • consolidation_options (r/o) list -- Returns a three-element list of boolean values. If the element is true, that option is set. Element 1 is use labels in top row, element 2 is use labels in left column, and element 3 is create links to source data.
      • consolidation_sources (r/o) list -- Returns an list of string values that name the source sheets for the worksheet's current consolidation.
      • display_page_breaks boolean -- Returns or sets if page breaks, both automatic and manual, on the specified worksheet are displayed.
      • enable_autofilter boolean -- Returns or sets if autofilter arrows are enabled when user-interface-only protection is turned on.
      • enable_calculation boolean -- Returns or sets if Microsoft Excel automatically recalculates the worksheet when necessary. If false, the user cannot request a recalculation, Microsoft Excel never recalculates the sheet automatically.
      • enable_outlining boolean -- Returns or sets if outlining symbols are enabled when user-interface-only protection is turned on.
      • enable_pivot_table boolean -- Returns or sets if pivot table controls and actions are enabled when user-interface-only protection is turned on.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • filter_mode (r/o) boolean -- Returns true if the worksheet is in filter mode.
      • name unicode_text -- Returns or sets the name of the object.
      • next_ (r/o) sheet -- Returns a worksheet object that represents the next sheet.
      • outline_object (r/o) outline -- Returns an outline object that represents the outline for the specified worksheet.
      • page_setup_object (r/o) page_setup -- Returns the page setup object associated with this chart.
      • previous_ (r/o) sheet -- Returns a worksheet object that represents the previous sheet.
      • protect_contents (r/o) boolean -- Returns true if the contents of the sheet are protected.
      • protect_drawing_objects (r/o) boolean -- Returns true if shapes are protected.
      • protection_mode (r/o) boolean -- Returns true if user-interface-only protection is turned on. To turn on user interface protection, use the protect method with the user interface only argument set to true.
      • protection_object (r/o) Protection -- Returns a Protection object that represents the protection options of the worksheet.
      • scroll_area unicode_text -- Returns or sets the range where scrolling is allowed, as an A1-style range reference. Cells outside the scroll area cannot be selected.
      • sheet_tab (r/o) tab -- Returns the sheet tab of the work sheet
      • sort_object (r/o) sort -- Returns the sort object in the sheet.
      • standard_height (r/o) float -- Returns the standard default height of all the rows in the worksheet, in points.
      • standard_width float -- Returns or sets the standard default width of all the columns in the worksheet.
      • transition_expression_evaluation boolean -- Returns or sets if Microsoft Excel uses Lotus 1-2-3 expression evaluation rules for the worksheet.
      • used_range (r/o) range -- Returns a range object that represents the used range on the specified worksheet.
      • visible k.sheet_visible / k.sheet_hidden / k.sheet_very_hidden -- Returns or sets if the worksheet is visible.
      • worksheet_type (r/o) k.sheet_type_chart / k.sheet_type_dialog_sheet / k.sheet_type_excel_4_intl_macro_sheet / k.sheet_type_excel_4_macro_sheet / k.sheet_type_worksheet -- Returns the type of this worksheet.
    • Elements:
  • slicer -- A slicer is a mechanism for filtering data in PivotTable views and cube functions.
  • sort -- Represents a sort of a range of data.
    • Inherits from:
    • Properties:
      • match_case boolean -- Set to true to perform a case-sensitive sort or set to false to perform non-case sensitive sort. Read/Write.
      • sort_header k.header_guess / k.header_no / k.header_yes -- Specifies whether the first row contains header information. Read/Write.
      • sort_method k.pin_yin / k.stroke -- Specifies the sort method for Chinese/Japanese languages. Read/Write.
      • sort_orientation k.sort_rows / k.sort_columns -- Specifies the orientation for the sort. Read/Write.
      • sortfields (r/o) null -- Stores the sort state for workbooks, lists, and autofilters. Read-Only.
      • sortrange (r/o) range -- Returns a range object that represents the range to which the specified sort applies. Read Only.
  • sortfield -- The sortfield object contains all the sort information for the worksheet, lists, and autofilter object.
    • Inherits from:
    • Properties:
      • custom_order null -- Specifies a custom order to sort the fields. Read/Write.
      • sort_data_option k.sort_normal / k.sort_text_as_numbers -- Specifies how to sort text in the range specified in sortfield object. Read/Write.
      • sort_key (r/o) range -- Specifies the range that is currently being sorted on. Read only.
      • sort_on k.sort_on_cell_value / k.sort_on_cell_color / k.sort_on_font_color / k.sort_on_icon -- Returns or sets what attribute of the cell to sort on. Read/Write.
      • sort_on_values (r/o) null -- Return the value on which the sort is performed for the specified sortfield object.Read Only.
      • sort_order k.sort_ascending / k.sort_descending / k.sort_manual -- Determines the sort order for the values specified in the key. Read/Write.
      • sort_priority integer -- Specifies the priority for the sortfield. Read/Write.
  • sortfields -- The sortfields collection is a collection of sortfield objects. It allows developers to store a sort state on worksheets, lists, and autofilters.
  • spinner
    • Plural name:
      • spinners
    • Inherits from:
    • Properties:
      • bottom_right_cell (r/o) range -- Returns the bottom right cell of the range the control is occupying.
      • display_threeD_shading boolean -- Returns or sets whether a 3-d effect will be employed when displaying the control
      • enabled boolean -- Returns or sets if the control is enabled
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • height float -- Returns or sets the height of the control.
      • left_position float -- Returns or sets the left position of the control
      • linked_cell unicode_text -- Returns or sets reference to a call which contains the value of the control.
      • locked boolean -- Returns or sets whether the control is locked for editing.
      • maximum_value integer -- Returns or sets the maximum value allowed
      • minimum_value integer -- Returns or sets the minimum value allowed
      • name unicode_text -- Returns or sets the name of this control
      • on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • placement k.placement_free_floating / k.placement_move / k.placement_move_and_size -- Returns or sets how the object is placed on the worksheet.
      • print_object boolean -- Returns or sets if this object is printed.
      • small_change integer -- Returns or sets the change in value of one click on the spinner control.
      • top float -- Returns or sets the position of the top of the control.
      • top_left_cell (r/o) range -- Returns the top left cell of the range within which the control is positioned.
      • value integer -- Returns or sets the current value of the control
      • visible boolean -- Returns or sets if the control is visible
      • width float -- Returns or sets the width of the object.
      • z_order_position (r/o) integer -- Returns the most recently set z order position, bring shape to front/send shape to back/bring shape forward/send shape backward/bring shape in front of text/send shape behind text.
  • tab -- Represents the sheet tab of a work sheet or chart sheet.
    • Inherits from:
    • Properties:
      • color RGB_color
      • color_index k.color_index_automatic / k.color_index_none / k.a_color_index_integer
      • theme_color k.color_index_none / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color
      • tint_and_shade float
  • table_style_element -- Represents a table style element
    • Plural name:
      • table_style_elements
    • Inherits from:
    • Properties:
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • has_format (r/o) boolean -- Returns or sets if table style element has format.
      • interior_object (r/o) interior -- Returns a interior object that represents the interior for the specified table style element.
  • table_style -- Represents a table style
    • Plural name:
      • table_styles
    • Inherits from:
    • Properties:
      • built_in (r/o) boolean -- if this is a built in table style or not
      • default (r/o) unicode_text
      • name (r/o) unicode_text -- Returns or sets the name of the object.
      • namelocal (r/o) unicode_text -- Returns or sets the local name of the object.
      • show_as_available_pivot_table_style boolean -- whether to show as avaliable pivot table style
      • show_as_available_table_style boolean -- whether to show as avaliable table style
    • Elements:
  • textbox
    • Plural name:
      • textboxes
    • Inherits from:
    • Properties:
      • add_indent boolean -- Returns or sets if text is automatically indented when the text alignment in a cell is set to equal distribution either horizontally or vertically.
      • auto_scale_font boolean -- Returns or sets if the text in the object changes font size when the object size changes.
      • auto_size boolean -- Returns or sets if the size of the specified object is changed automatically to fit text within its boundaries.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • bottom_right_cell (r/o) range -- Returns the bottom right cell of the range the control is occupying.
      • caption unicode_text -- Returns or sets the caption for this object.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • formula unicode_text -- Returns or sets the object's formula, in A1-style notation and in the language of the macro.
      • height float -- Returns or set the height of the object.
      • horizontal_alignment k.horizontal_align_center / k.horizontal_align_center_across_selection / k.horizontal_align_distributed / k.horizontal_align_fill / k.horizontal_align_general / k.horizontal_align_justify / k.horizontal_align_left / k.horizontal_align_right -- Returns or sets the horizontal alignment for the object.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • left_position float -- Returns or sets the position of the specified object, in points.
      • locked boolean -- Returns or sets if the object is locked, if false the object can be modified when the sheet is protected.
      • locked_text boolean -- Returns or sets whether the control's text is locked for editing.
      • name unicode_text -- Returns or sets the name of the object.
      • on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • orientation k.orientation_downward / k.orientation_horizontal / k.orientation_upward / k.orientation_vertical -- May also be a number value from -90 to 90 degrees.
      • placement k.placement_free_floating / k.placement_move / k.placement_move_and_size -- Returns or sets how the object is placed on the worksheet.
      • print_object boolean -- Returns or sets if this object is printed.
      • reading_order k.left_to_right / k.right_to_left / k.context -- Returns or sets the reading order for the specified object.
      • rounded_corners boolean
      • shadow boolean
      • string_value unicode_text -- Returns or sets the text of the specified object.
      • top float -- Returns the top position of the specified object, in points.
      • top_left_cell (r/o) range -- Returns a range object that represents the cell that lies under the upper-left corner of the specified object.
      • vertical_alignment k.vertical_alignment_top / k.vertical_alignment_center / k.vertical_alignment_bottom / k.vertical_alignment_justify / k.vertical_alignment_distributed -- Returns or sets the vertical alignment of the object.
      • visible boolean -- Returns or sets if the object is visible.
      • width float -- Returns or sets the width of the object.
      • wrap_auto_text boolean -- Returns or sets if the auto text is wrapped.
      • z_order_position (r/o) integer -- Returns the z-order position of the object.
    • Elements:
  • top_10_format_condition
    • Inherits from:
    • Properties:
      • applies_to (r/o) range -- Returns the range this format condition applies to. Read Only.
      • calc_for k.calc_for_all_values / k.calc_for_row_groups / k.calc_for_col_groups
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • format_condition_priority integer -- Specifies the priority for the format condition. Read/Write.
      • format_condition_type (r/o) k.cell_value / k.expression / k.color_scale / k.databar / k.top_10 / k.icon_sets / k.unique_values / k.text_string / k.blanks_condition / k.time_period / k.above_average_condition / k.no_blanks_condition / k.errors_condition / k.no_errors_condition -- Return the conditional format type.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • number_format unicode_text -- Returns or sets the format code for the object.
      • pivot_condition_scope_type k.pivot_condition_selection_scope / k.pivot_condition_fields_scope / k.pivot_condition_data_field_scope -- Returns or sets the part of the pivot table that the pivot table format condition is scoped to
      • pivot_table_condition (r/o) boolean -- Tells whether this format condition is a pivot table condition.
      • stop_if_true (r/o) boolean -- Tells whether the processing of format conditions stops if this condition is true. Read Only.
      • top_10_percentage boolean
      • top_10_rank integer
      • top_or_bottom k.top_10_top / k.top_10_bottom
  • treeview_control -- Represents the hierarchical member-selection control of a cube field.
    • Inherits from:
    • Properties:
      • drilled null
      • hidden null
  • unique_values_format_condition
    • Inherits from:
    • Properties:
      • applies_to (r/o) range -- Returns the range this format condition applies to. Read Only.
      • duplicate_or_unique k.format_unique_values / k.format_duplicate_values
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • format_condition_priority integer -- Specifies the priority for the format condition. Read/Write.
      • format_condition_type (r/o) k.cell_value / k.expression / k.color_scale / k.databar / k.top_10 / k.icon_sets / k.unique_values / k.text_string / k.blanks_condition / k.time_period / k.above_average_condition / k.no_blanks_condition / k.errors_condition / k.no_errors_condition -- Return the conditional format type.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • number_format unicode_text -- Returns or sets the format code for the object.
      • pivot_condition_scope_type k.pivot_condition_selection_scope / k.pivot_condition_fields_scope / k.pivot_condition_data_field_scope -- Returns or sets the part of the pivot table that the pivot table format condition is scoped to
      • pivot_table_condition (r/o) boolean -- Tells whether this format condition is a pivot table condition.
      • stop_if_true (r/o) boolean -- Tells whether the processing of format conditions stops if this condition is true. Read Only.
  • validation -- Represents data validation for a worksheet range.
    • Plural name:
      • validations
    • Inherits from:
    • Properties:
      • IME_mode k.IME_mode_no_control / k.IME_mode_on / k.IME_mode_off / k.IME_mode_disable / k.IME_mode_hiragana / k.IME_mode_katakana / k.IME_mode_katakana_half / k.IME_mode_alpha_full / k.IME_mode_alpha / k.IME_mode_hangul_full / k.IME_mode_hangul -- Returns or sets the description of the Japanese input rules.
      • alert_style (r/o) k.valid_alert_none / k.valid_alert_stop / k.valid_alert_warning / k.valid_alert_information -- Returns the validation alert style.
      • error_message unicode_text -- Returns or sets the data validation error message.
      • error_title unicode_text -- Returns or sets the title of the data-validation error dialog box.
      • formula1 (r/o) unicode_text -- Returns the value or expression associated with the conditional format or data validation.
      • formula2 (r/o) unicode_text -- Returns the value or expression associated with the second part of a conditional format or data validation. Used only when the data validation conditional format Operator property is operator between or operator not between.
      • ignore_blank boolean -- Returns or sets if blank values are permitted by the range data validation.
      • in_cell_dropdown boolean -- Returns or sets if data validation displays a drop-down list that contains acceptable values.
      • input_message unicode_text -- Returns or sets the data validation input message.
      • input_title unicode_text -- Returns or sets the title of the data-validation input dialog box.
      • show_error boolean -- Returns or sets if the data validation error message will be displayed whenever the user enters invalid data.
      • show_input boolean -- Returns or sets if the data validation input message will be displayed whenever the user selects a cell in the data validation range.
      • validation_operator (r/o) k.operator_between / k.operator_not_between / k.operator_equal / k.operator_not_equal / k.operator_greater / k.operator_less / k.operator_greater_equal / k.operator_less_equal -- Returns the operator for the conditional format or data validation.
      • validation_type (r/o) k.validate_input_only / k.validate_whole_number / k.validate_decimal / k.validate_list / k.validated_date / k.validate_time / k.validate_text_length / k.validate_custom -- Returns the data validation type.
      • value (r/o) boolean -- Returns true if all the validation criteria are met, that is, if the range contains valid data.
  • value_change
    • Inherits from:
    • Properties:
      • allocation_method (r/o) k.equal_allocation / k.weight_allocation
      • allocation_value (r/o) k.allocate_value / k.allocate_increment
      • allocation_weight_expression (r/o) unicode_text
      • order (r/o) integer
      • pivot_cell (r/o) pivot_cell
      • tuple (r/o) unicode_text
      • value (r/o) float
      • visible_in_pivot_table (r/o) boolean
  • vertical_page_break -- Represents a vertical page break.
    • Plural name:
      • vertical_page_breaks
    • Inherits from:
    • Properties:
      • extent (r/o) k.page_break_full / k.page_break_partial -- Returns the type of the specified page break: full-screen or only within a print area.
      • location range -- Returns or sets where this vertical page break is located.
      • vertical_page_break_type k.page_break_automatic / k.page_break_manual / k.page_break_none -- Returns or sets the type of vertical page break.
  • web_options -- Contains workbook-level attributes used by Microsoft Excel when you save a document as a Web page or open a Web page.
    • Inherits from:
    • Properties:
      • allow_png boolean -- Returns or sets if PNG, Portable Network Graphics, is allowed as an image format when you save documents as a Web page.
      • encoding k.encoding_Thai / k.encoding_Japanese_ShiftJIS / k.encoding_simplified_Chinese / k.encoding_Korean / k.encoding_Big5_traditional_Chinese / k.encoding_little_endian / k.encoding_big_endian / k.encoding_central_European / k.encoding_Cyrillic / k.encoding_Western / k.encoding_Greek / k.encoding_Turkish / k.encoding_Hebrew / k.encoding_Arabic / k.encoding_Baltic / k.encoding_Vietnamese / k.encoding_ISO88591_Latin1 / k.encoding_ISO88592_central_Europe / k.encoding_ISO88593_Latin3 / k.encoding_ISO88594_Baltic / k.encoding_ISO88595_Cyrillic / k.encoding_ISO88596_Arabic / k.encoding_ISO88597_Greek / k.encoding_ISO88598_Hebrew / k.encoding_ISO88599_Turkish / k.encoding_ISO885915_Latin9 / k.encoding_ISO2022_Japanese_no_half_width_Katakana / k.encoding_ISO2022_Japanese_JISX02021984 / k.encoding_ISO2022_Japanese_JISX02011989 / k.encoding_ISO2022KR / k.encoding_ISO2022CN_traditional_Chinese / k.encoding_ISO2022CN_simplified_Chinese / k.encoding_Mac_Roman / k.encoding_Mac_Japanese / k.encoding_Mac_traditional_Chinese / k.encoding_Mac_Korean / k.encoding_Mac_Arabic / k.encoding_Mac_Hebrew / k.encoding_Mac_Greek1 / k.encoding_Mac_Cyrillic / k.encoding_Mac_simplified_Chinese_GB2312 / k.encoding_Mac_Romania / k.encoding_Mac_Ukraine / k.encoding_Mac_Latin2 / k.encoding_Mac_Icelandic / k.encoding_Mac_Turkish / k.encoding_Mac_Croatia / k.encoding_EBCDIC_US_Canada / k.encoding_EBCDIC_International / k.encoding_EBCDIC_multilingual_ROECE_Latin2 / k.encoding_EBCDIC_Greek_modern / k.encoding_EBCDIC_Turkish_Latin5 / k.encoding_EBCDIC_Germany / k.encoding_EBCDIC_Denmark_Norway / k.encoding_EBCDIC_Finland_Sweden / k.encoding_EBCDIC_Italy / k.encoding_EBCDIC_Latin_America_Spain / k.encoding_EBCDIC_United_Kingdom / k.encoding_EBCDIC_Japanese_Katakana_extended / k.encoding_EBCDIC_France / k.encoding_EBCDIC_Arabic / k.encoding_EBCDIC_Greek / k.encoding_EBCDIC_Hebrew / k.encoding_EBCDIC_Korean_extended / k.encoding_EBCDIC_Thai / k.encoding_EBCDIC_Icelandic / k.encoding_EBCDIC_Turkish / k.encoding_EBCDIC_Russian / k.encoding_EBCDIC_Serbian_Bulgarian / k.encoding_EBCDIC_Japanese_Katakana_extended_and_Japanese / k.encoding_EBCDIC_US_Canada_and_Japanese / k.encoding_EBCDIC_extended_and_Korean / k.encoding_EBCDIC_simplified_Chinese_extended_and_simplified_Chinese / k.encoding_EBCDIC_US_Canada_and_traditional_Chinese / k.encoding_EBCDIC_Japanese_Latin_extended_and_Japanese / k.encoding_OEM_United_States / k.encoding_OEM_Greek / k.encoding_OEM_Baltic / k.encoding_OEM_multilingual_LatinI / k.encoding_OEM_multilingual_LatinII / k.encoding_OEM_Cyrillic / k.encoding_OEM_Turkish / k.encoding_OEM_Portuguese / k.encoding_OEM_Icelandic / k.encoding_OEM_Hebrew / k.encoding_OEM_Canadian_French / k.encoding_OEM_Arabic / k.encoding_OEM_Nordic / k.encoding_OEM_CyrillicII / k.encoding_OEM_modern_Greek / k.encoding_EUC_Japanese / k.encoding_EUC_Chinese_simplified_Chinese / k.encoding_EUC_Korean / k.encoding_EUC_Taiwanese_traditional_Chinese / k.encoding_Devanagari / k.encoding_Bengali / k.encoding_Tamil / k.encoding_Telugu / k.encoding_Assamese / k.encoding_Oriya / k.encoding_Kannada / k.encoding_Malayalam / k.encoding_Gujarati / k.encoding_Punjabi / k.encoding_Arabic_ASMO / k.encoding_Arabic_transparent_ASMO / k.encoding_Korean_Johab / k.encoding_Taiwan_CNS / k.encoding_Taiwan_TCA / k.encoding_Taiwan_Eten / k.encoding_Taiwan_IBM5550 / k.encoding_Taiwan_teletext / k.encoding_Taiwan_Wang / k.encoding_IA5IRV / k.encoding_IA5_German / k.encoding_IA5_Swedish / k.encoding_IA5_Norwegian / k.encoding_US_ASCII / k.encoding_T61 / k.encoding_ISO6937_nonspacing_accent / k.encoding_KOI8R / k.encoding_Ext_alpha_lowercase / k.encoding_KOI8U / k.encoding_Europa3 / k.encoding_HZGB_simplified_Chinese / k.encoding_UTF7 / k.encoding_UTF8 -- Returns or sets the document encoding, code page or character set, to be used by the Web browser when you view the saved document.
      • location_of_components unicode_text -- Returns or sets the central URL, on the intranet or Web, or path, local or network, to the location from which authorized users can download Microsoft Office Web components when viewing your saved document.
      • pixels_per_inch integer -- Returns or sets the density, pixels per inch, of graphics images and table cells on a Web page. The range of settings is usually from 19 to 480, and common settings for popular screen sizes are 72, 96, and 120.
      • screen_size (r/o) k.resolution544x376 / k.resolution640x480 / k.resolution720x512 / k.resolution800x600 / k.resolution1024x768 / k.resolution1152x882 / k.resolution1152x900 / k.resolution1280x1024 / k.resolution1600x1200 / k.resolution1800x1440 / k.resolution1920x1200 -- Returns the ideal minimum screen size, width by height, in pixels, that you should use when viewing the saved document in a Web browser.
      • web_page_keywords unicode_text -- Returns or sets the keywords for the Web page.
      • web_page_title unicode_text -- Returns or sets the title for the web page.
  • window -- Represents a window. Many worksheet characteristics, such as scroll bars and gridlines, are actually properties of the window.
    • Plural name:
      • windows
    • Inherits from:
    • Properties:
      • active_cell (r/o) cell -- Returns a range object that represents the active cell in the active window, the window on top, or in the specified window. If the window isn't displaying a worksheet, this property fails.
      • active_chart (r/o) chart -- Returns a chart object that represents the active chart, either an embedded chart or a chart sheet. An embedded chart is considered active when it's either selected or activated.
      • active_pane (r/o) pane -- Returns a pane object that represents the active pane in the active window, the window on top, or in the specified window. If the window isn't displaying a worksheet, this property fails.
      • active_sheet (r/o) sheet -- Returns an object that represents the active sheet, the sheet on top, in the active workbook or in the specified window or workbook.
      • caption unicode_text -- Returns or sets the name that appears in the title bar of the document window.
      • date_grouping boolean -- Returns or sets the date grouping flag in the window.
      • display_formulas boolean -- Returns or set if the window is displaying formulas. If false, the window is displaying values.
      • display_gridlines boolean -- Returns or sets if gridlines are displayed.
      • display_headings boolean -- Returns or sets if both row and column headings are displayed.
      • display_horizontal_scroll_bar boolean -- Returns or sets if the horizontal scroll bar is displayed.
      • display_outline boolean -- Returns or sets if outline symbols are displayed.
      • display_vertical_scroll_bar boolean -- Returns or sets if the vertical scroll bar is displayed.
      • display_workbook_tabs boolean -- Returns or sets if the workbook tabs are displayed.
      • display_zeros boolean -- Returns or sets if zero values are displayed.
      • enable_resize boolean -- Returns or sets if the window can be resized.
      • entry_index (r/o) integer -- Returns the index of this item in the element list of windows.
      • freeze_panes boolean -- Returns or sets if split panes are frozen. It's possible for freeze panes to be true and split to be false, or vice versa. This property applies only to worksheets and macro sheets.
      • gridline_color RGB_color -- Returns or sets the gridline color as an RGB value.
      • gridline_color_index k.color_index_automatic / k.color_index_none / k.a_color_index_integer -- Returns or sets the gridline color as an index into the current color palette.
      • height float -- Returns or sets the height of the window. Use the usable height property to determine the maximum size for the window. You cannot set this property if the window is maximized or minimized. Use the window state property to determine the window state.
      • left_position float -- Returns or sets the distance from the left edge of the client area to the left edge of the window.
      • range_selection (r/o) range -- Returns a range object that represents the selected cells on the worksheet in the specified window even if a graphic object is active or selected on the worksheet.
      • scroll_column integer -- Returns or sets the number of the leftmost column in the window.
      • scroll_row integer -- Returns or sets the number of the row that appears at the top of the window.
      • selected_sheets (r/o) list -- Returns a list of sheet objects that represents all the selected sheets in the specified window.
      • selection (r/o) range -- Returns the selected range object in the specified window.
      • split boolean -- Returns or sets if the window is split.
      • split_column integer -- Returns or sets the column number where the window is split into panes, the number of columns to the left of the split line.
      • split_horizontal float -- Returns or sets the location of the horizontal window split, in points.
      • split_row integer -- Returns or sets the row number where the window is split into panes, the number of rows above the split.
      • split_vertical float -- Returns or sets the location of the vertical window split, in points.
      • tab_ratio float -- Returns or sets the ratio of the width of the workbook's tab area to the width of the window's horizontal scroll bar, as a number between 0 and 1, the default value is 0.75.
      • top float -- The distance from the top edge of the window to the top edge of the usable area, below the menus, any toolbars docked at the top, and the formula bar. You cannot set this property for a maximized window.
      • usable_height (r/o) float -- Returns the maximum height of the space that a window can occupy in points.
      • usable_width (r/o) float -- Returns the maximum width of the space that a window can occupy in the application window area, in points.
      • view k.normal_view / k.page_layout_view -- Returns or sets the view showing in the window.
      • visible boolean -- Returns or sets if the window is visible.
      • visible_range (r/o) range -- Returns a range object that represents the range of cells that are visible in the window or pane. If a column or row is partially visible, it's included in the range.
      • width float -- Returns or sets the width of the window.
      • window_number (r/o) integer -- Returns the window number. For example, a window named Book1.xls:2 has 2 as its window number. Most windows have the window number 1.
      • window_state k.window_state_maximized / k.window_state_minimized / k.window_state_normal -- Returns or sets the state of the window.
      • window_type (r/o) k.window_type_chart_as_window / k.window_type_chart_in_place / k.window_type_clipboard / k.window_type_info / k.window_type_workbook -- Returns the window type.
      • zoom k.a_number / k.a_bool -- Returns or sets the display size of the window, as a percentage,100 equals normal size, 200 equals double size, and so on.
    • Elements:
      • panes -- by index, test
  • workbook_connection -- A connection is a set of information needed to obtain data from an external data source other than an 1st_Excel12 workbook.
    • Inherits from:
    • Properties:
      • _default_ (r/o) unicode_text
      • description (r/o) unicode_text -- Returns or sets a brief description for a WorkbookConnection object.
      • name (r/o) unicode_text -- Returns or sets the name of the workbook connection object.
      • ranges (r/o) null -- Returns the range of object for the specified WorkbookConnection object.
      • type (r/o) k.connection_type_OLEDB / k.connection_type_ODBC / k.connection_type_XMLMAP / k.connection_type_TEXT / k.connection_type_WEB
  • workbook -- Represents a Microsoft Excel workbook.
    • Plural name:
      • workbooks
    • Inherits from:
    • Inherited by:
    • Properties:
      • accept_labels_in_formulas boolean -- Returns or sets if labels can be used in worksheet formulas.
      • accuracy_version integer -- Returns or sets the accuracy version for this workbook.
      • active_chart (r/o) chart -- Returns a chart object that represents the active chart, either an embedded chart or a chart sheet. An embedded chart is considered active when it's either selected or activated.
      • active_sheet (r/o) sheet -- Returns an object that represents the active sheet, the sheet on top, in the specified window.
      • auto_update_frequency integer -- Returns or sets the number of minutes between automatic updates to the shared workbook. If this property is set to zero updates occur only when the workbook is saved.
      • auto_update_save_changes boolean -- Returns or sets if current changes to the shared workbook are posted to other users whenever the workbook is automatically updated. if false changes aren't posted, this workbook is still synchronized with changes made by other users.
      • calculation_version (r/o) integer -- Returns a number whose rightmost four digits are the minor calculation engine version number, and whose other digits, on the left, are the major version of Microsoft Excel.
      • change_history_duration integer -- Returns or sets the number of days shown in the shared workbook's change history.
      • conflict_resolution k.local_session_changes / k.other_session_changes / k.user_resolution -- Returns or sets the way conflicts are to be resolved whenever a shared workbook is updated.
      • create_backup (r/o) boolean -- Returns true if a backup file is created when this file is saved.
      • date_1904 boolean -- Returns or sets if the workbook uses the 1904 date system.
      • default_pivottable_style null -- Set or get the default pivot table style for the current workbook
      • default_table_style null -- Set or get the default table style for the current workbook
      • display_drawing_objects k.display_shapes / k.hide / k.placeholders -- Returns or sets how shapes are displayed.
      • enable_auto_recover boolean -- Gets or sets a value that indicates whether Microsoft Office Excel saves changed files, of all formats, on a timed interval.
      • excel_8_compatibility_mode (r/o) boolean -- Gets a value that indicates whether the workbook is in compatibility mode.
      • file_format (r/o) k.CSV_file_format / k.CSV_Mac_file_format / k.CSV_MSDos_file_format / k.CSV_Windows_file_format / k.DBF3_file_format / k.DBF4_file_format / k.DIF_file_format / k.Excel2_file_format / k.Excel_2_east_asian_file_format / k.Excel3_file_format / k.Excel4_file_format / k.Excel5_file_format / k.Excel7_file_format / k.Excel_4_workbook_file_format / k.international_add_in_file_format / k.international_macro_file_format / k.workbook_normal_file_format / k.SYLK_file_format / k.current_platform_text_file_format / k.text_Mac_file_format / k.text_MSDos_file_format / k.text_printer_file_format / k.text_windows_file_format / k.HTML_file_format / k.XML_spreadsheet_file_format / k.PDF_file_format / k.Excel_binary_file_format / k.Excel_XML_file_format / k.macro_enabled_XML_file_format / k.macro_enabled_template_file_format / k.template_file_format / k.add_in_file_format / k.Excel98to2004_file_format / k.Excel98to2004_template_file_format / k.Excel98to2004_add_in_file_format -- Returns the file format of the workbook.
      • full_name (r/o) unicode_text -- Returns the name of the workbook, including its path on disk, as a string.
      • full_name_urlencoded (r/o) unicode_text -- Returns a String indicating the name of the object, including its path on disk, as a string.
      • has_password (r/o) boolean -- Returns true if the workbook has a protection password.
      • has_vb_project (r/o) boolean -- Gets a value that indicates whether a workbook has an attached Microsoft Visual Basic for Applications <VBA> project.
      • highlight_changes_on_screen boolean -- Returns or sets if changes to the shared workbook are highlighted on-screen.
      • inactive_list_border_visible boolean -- Gets or sets a value that indicates whether list borders are visible when a list is not active.
      • is_add_in boolean -- Returns or sets if the workbook is running as an add in.
      • keep_change_history boolean -- Returns or sets if change tracking is enabled for the shared workbook.
      • list_changes_on_new_sheet boolean -- Returns or sets if changes to the shared workbook are shown on a separate worksheet.
      • multi_user_editing (r/o) boolean -- Returns true if the workbook is open as a shared list.
      • name (r/o) unicode_text -- Returns or sets the name of the workbook.
      • password unicode_text -- Returns or sets the password that must be supplied to open the specified workbook.
      • path (r/o) unicode_text -- Returns the complete path of the object, excluding the final separator and name of the object.
      • personal_view_list_settings boolean -- Returns or sets if filter and sort settings for lists are included in the user's personal view of the shared workbook.
      • personal_view_print_settings boolean -- Returns or sets if print settings are included in the user's personal view of the shared workbook.
      • precision_as_displayed boolean -- Returns or sets if calculations in this workbook will be done using only the precision of the numbers as they're displayed.
      • protect_structure (r/o) boolean -- Returns true if the order of the sheets in the workbook is protected.
      • protect_windows (r/o) boolean -- Returns true if the windows of the workbook are protected.
      • read_only (r/o) boolean -- Returns true if the workbook has been opened as read-only.
      • read_only_recommended boolean -- Returns or sets if the workbook was saved as read-only recommended.
      • remove_personal_information boolean -- Returns or sets if personal information can be removed from the specified workbook.
      • revision_number (r/o) integer -- Returns the number of times the workbook has been saved while open as a shared list. If the workbook is open in exclusive mode, this property returns zero.
      • save_link_values boolean -- Returns or sets if Microsoft Excel saves external link values with the workbook.
      • saved boolean -- Returns or sets if no changes have been made to the specified workbook since it was last saved.
      • show_conflict_history boolean -- Returns or sets if the conflict history worksheet is visible in the workbook that's open as a shared list.
      • template_remove_external_data boolean -- Returns or sets if external data references are removed when the workbook is saved as a template.
      • theme (r/o) office_theme
      • update_remote_references boolean -- Returns or sets if Microsoft Excel updates remote references in for the workbook.
      • user_status (r/o) list -- Returns a list of lists that provides information about each user who has the workbook open as a shared list. The list is name of user, date and time user opened the workbook, and a number 1 for exclusive, 2 for shared access.
      • web_options (r/o) web_options -- Returns the web options object, which contains workbook-level attributes used by Microsoft Excel when you save a document as a Web page or open a Web page.
      • workbook_comments unicode_text -- Returns or sets the comment string for this workbook.
      • write_password unicode_text -- Returns or sets a string for the write password of a workbook.
      • write_reserved (r/o) boolean -- Return true if the workbook is write-reserved
      • write_reserved_by (r/o) unicode_text -- Returns the name of the user who currently has write permission for the workbook.
    • Elements:
  • worksheet
    • Plural name:
      • worksheets
    • Inherits from:
    • Properties:
      • enable_selection k.no_restrictions / k.unlocked_cells / k.no_selection -- Returns or sets what can be selected on the sheet.
      • protect_scenarios (r/o) boolean -- Returns true if the worksheet scenarios are protected.
  • xlspelling_options -- Contains global application-level spelling options
    • Inherits from:
    • Properties:
      • dictionary_lang k.Basque / k.Catalan / k.Chinese / k.Chinese_Taiwan / k.Czech / k.Danish / k.Dutch / k.English_US / k.English_AUS / k.English_British / k.English_CAN / k.Finnish / k.French / k.French_Canadian / k.German / k.German_Austria / k.Swiss_German / k.Greek / k.Hungarian / k.Italian / k.Japanese / k.Korean / k.Malaysian / k.Norwegian_Bokmal / k.Norwegian / k.Polish / k.Portuguese_Brazil / k.Portuguese_Iberian / k.Russian / k.Slovak / k.Slovenian / k.Spanish / k.Swedish / k.Turkish -- Returns or sets the LCID used by the proofing tools

Drawing Suite

Classes and Methods used for Graphic Objects

Commands

  • apply -- Applies to the specified shape formatting that's been copied by using the pick up method.
  • automatic_length -- Specifies that the first segment of the callout line, the segment attached to the text callout box, be scaled automatically when the callout is moved.
  • begin_connect -- Attaches the beginning of the specified connector to a specified shape. If there's already a connection between the beginning of the connector and another shape, that connection is broken.
    • connector_format
    • connected_shape shape -- The shape to attach the beginning of the connector to.
    • connection_site integer -- A connection site on the shape specified by connected shape. Must be an integer between 1 and the integer returned by the connection site count property of the specified shape.
  • begin_disconnect -- Detaches the beginning of the specified connector from the shape it's attached to. This method doesn't alter the size or position of the connector: the beginning of the connector remains positioned at a connection site but is no longer connected.
  • bring_to_front -- Bring the object to the front of the z-order of objects.
    • k.line / k.rectangle / k.oval / k.arc
  • check_spelling -- Checks the spelling of an object.
    • k.rectangle / k.oval / k.arc
    • [custom_dictionary unicode_text] -- A string that indicates the file name of the custom dictionary to examine if the word isn't found in the main dictionary. If this argument is omitted, the currently specified dictionary is used.
    • [ignore_uppercase boolean] -- Set to true to have Microsoft Excel ignore words that are all uppercase. False to have Microsoft Excel check words that are all uppercase.
    • [always_suggest boolean] -- Set to true to have Microsoft Excel display a list of suggested alternate spellings when an incorrect spelling is found. False to have Microsoft Excel wait for you to input the correct spelling.
  • copy_object -- Copies the object to the clipboard.
    • k.line / k.rectangle / k.oval / k.arc / k.shape
  • copy_picture -- Copies the selected object to the clipboard as a picture.
    • k.line / k.rectangle / k.oval / k.arc / k.shape
    • [appearance k.printer / k.screen] -- Specifies how the picture should be copied.
    • [format k.bitmap / k.picture] -- The format of the picture.
  • custom_drop -- Sets the vertical distance in points from the edge of the text bounding box to the place where the callout line attaches to the text box.
    • k.callout_format / k.callout
    • drop short_float -- The drop distance, in points.
  • custom_length -- Specifies that the first segment of the callout line, the segment attached to the text callout box, retain a fixed length whenever the callout is moved.
    • k.callout_format / k.callout
    • length short_float -- The length of the first segment of the callout, in points.
  • cut -- Cuts the object to the clipboard.
    • k.line / k.rectangle / k.oval / k.arc / k.shape
  • delete_gradient_stop -- Removes a gradient stop.
    • fill_format
    • stop_index integer -- The index number of the stop.
  • end_connect -- Attaches the end of the specified connector to a specified shape. If there's already a connection between the end of the connector and another shape, that connection is broken.
    • connector_format
    • connected_shape shape -- The shape to attach the end of the connector to.
    • connection_site integer -- A connection site on the shape specified by connected shape. Must be an integer between 1 and the integer returned by the connection site count property of the specified shape.
  • end_disconnect -- Detaches the end of the specified connector from the shape it's attached to. This method doesn't alter the size or position of the connector: the end of the connector remains positioned at a connection site but is no longer connected.
  • flip -- Flips the specified shape around its horizontal or vertical axis.
    • shape
    • flip_cmd k.flip_horizontal / k.flip_vertical
  • get_custom_color -- Returns the custom color for the specified Microsoft Office theme.
  • insert_gradient_stop -- Adds a stop to a gradient.
    • fill_format
    • custom_color RGB_color -- Sets the color of the stop within a gradient.
    • position short_float -- Sets the position of the stop within the gradient expressed as a percent.
    • [transparency short_float] -- Sets the transparency of the stop within the gradient.
    • [stop_index integer] -- The index number of the stop.
  • load_theme_color_scheme -- Loads the color scheme of a Microsoft Office theme from a file
  • load_theme_effect_scheme -- Loads the effects scheme of a Microsoft Office theme from a file
  • load_theme_font_scheme -- Loads the font scheme of a Microsoft Office theme from a file.
  • one_color_gradient -- Sets the specified fill to a one-color gradient.
    • fill_format
    • gradient_style k.gradient_unset / k.horizontal_gradient / k.vertical_gradient / k.diagonal_up_gradient / k.diagonal_down_gradient / k.from_corner_gradient / k.from_title_gradient / k.from_center_gradient -- The gradient style.
    • variant integer -- The gradient variant. Can be a value from 1 to 4, corresponding to the four variants on the gradient tab in the fill effects dialog box. If Style is from center gradient, this argument can be either 1 or 2.
    • degree short_float -- The gradient degree. Can be a value from 0.0, dark to 1.0, light.
  • patterned -- Sets the specified fill to a pattern.
    • fill_format
    • pattern k.pattern_unset / k.five_percent_pattern / k.ten_percent_pattern / k.twenty_percent_pattern / k.twenty_five_percent_pattern / k.thirty_percent_pattern / k.forty_percent_pattern / k.fifty_percent_pattern / k.sixty_percent_pattern / k.seventy_percent_pattern / k.seventy_five_percent_pattern / k.eighty_percent_pattern / k.ninety_percent_pattern / k.dark_horizontal_pattern / k.dark_vertical_pattern / k.dark_downward_diagonal_pattern / k.dark_upward_diagonal_pattern / k.small_checker_board_pattern / k.trellis_pattern / k.light_horizontal_pattern / k.light_vertical_pattern / k.light_downward_diagonal_pattern / k.light_upward_diagonal_pattern / k.small_grid_pattern / k.dotted_diamond_pattern / k.wide_downward_diagonal / k.wide_upward_diagonal_pattern / k.dashed_upward_diagonal_pattern / k.dashed_downward_diagonal_pattern / k.narrow_vertical_pattern / k.narrow_horizontal_pattern / k.dashed_vertical_pattern / k.dashed_horizontal_pattern / k.large_confetti_pattern / k.large_grid_pattern / k.horizontal_brick_pattern / k.large_checker_board_pattern / k.small_confetti_pattern / k.zig_zag_pattern / k.solid_diamond_pattern / k.diagonal_brick_pattern / k.outlined_diamond_pattern / k.plaid_pattern / k.sphere_pattern / k.weave_pattern / k.dotted_grid_pattern / k.divot_pattern / k.shingle_pattern / k.wave_pattern / k.horizontal_pattern / k.vertical_pattern / k.cross_pattern / k.downward_diagonal_pattern / k.upward_diagonal_pattern / k.diagonal_cross_pattern -- The pattern to be used for the specified fill.
  • pick_up -- Copies the formatting of the specified shape. Use the apply method to apply the copied formatting to another shape.
  • preset_drop -- Specifies whether the callout line attaches to the top, bottom, or center of the callout text box or whether it attaches at a point that's a specified distance from the top or bottom of the text box.
    • k.callout_format / k.callout
    • drop_type k.drop_unset / k.drop_custom / k.drop_top / k.drop_center / k.drop_bottom -- The starting position of the callout line relative to the text bounding box.
  • preset_gradient -- Sets the specified fill to a preset gradient.
    • fill_format
    • gradient_style k.gradient_unset / k.horizontal_gradient / k.vertical_gradient / k.diagonal_up_gradient / k.diagonal_down_gradient / k.from_corner_gradient / k.from_title_gradient / k.from_center_gradient -- Specifies the gradient style.
    • variant integer -- The gradient variant. Can be a value from 1 to 4, corresponding to the four variants on the gradient tab in the fill effects dialog box. If Style is from center gradient, this argument can be either 1 or 2.
    • preset_gradient_type k.preset_gradient_unset / k.gradient_early_sunset / k.gradient_late_sunset / k.gradient_nightfall / k.gradient_daybreak / k.gradient_horizon / k.gradient_desert / k.gradient_ocean / k.gradient_calm_water / k.gradient_fire / k.gradient_fog / k.gradient_moss / k.gradient_peacock / k.gradient_wheat / k.gradient_parchment / k.gradient_mahogany / k.gradient_rainbow / k.gradient_rainbow2 / k.gradient_gold / k.gradient_gold2 / k.gradient_brass / k.gradient_chrome / k.gradient_chrome2 / k.gradient_silver / k.gradient_sapphire -- The gradient type.
  • preset_textured -- Sets the specified fill to a preset texture.
    • fill_format
    • preset_texture k.preset_texture_unset / k.texture_papyrus / k.texture_canvas / k.texture_denim / k.texture_woven_mat / k.texture_water_droplets / k.texture_paper_bag / k.texture_fish_fossil / k.texture_sand / k.texture_green_marble / k.texture_white_marble / k.texture_brown_marble / k.texture_granite / k.texture_newsprint / k.texture_recycled_paper / k.texture_parchment / k.texture_stationery / k.texture_blue_tissue_paper / k.texture_pink_tissue_paper / k.texture_purple_mesh / k.texture_bouquet / k.texture_cork / k.texture_walnut / k.texture_oak / k.texture_medium_wood -- The preset texture.
  • reroute_connections -- Reroutes connectors so that they take the shortest possible path between the shapes they connect. To do this, the reroute connections method may detach the ends of a connector and reattach them to different connecting sites on the connected shapes.
  • reset_rotation -- Resets the extrusion rotation around the x-axis and the y-axis to zero so that the front of the extrusion faces forward. This method doesn't reset the rotation around the z-axis.
  • save_as_picture -- Saves the shape in the requested file using the stated graphic format
    • shape
    • [picture_type k.save_as_default / k.save_as_PNG_file / k.save_as_BMP_file / k.save_as_GIF_file / k.save_as_JPG_file / k.save_as_PDF_file] -- Specifies the graphic format in which the file is saved
    • [file_name unicode_text] -- The name and path for the picture being saved
  • save_theme_color_scheme -- Saves the color scheme of a Microsoft Office theme to a file.
  • save_theme_font_scheme -- Saves the font scheme of a Microsoft Office theme to a file.
  • scale_height -- Scales the height of the shape by a specified factor.
    • picture
    • factor short_float -- Specifies the ratio between the height of the shape after you resize it and the current or original height. For example, to make a rectangle 50 percent larger, specify 1.5 for this argument.
    • relative_to_original_size boolean -- Set to true to scale the shape relative to its original size. False to scale it relative to its current size.
    • [scale k.scale_from_top_left / k.scale_from_middle / k.scale_from_bottom_right] -- Specifies which part of the shape retains its position when the shape is scaled.
  • scale_width -- Scales the width of the shape by a specified factor. For pictures, you can indicate whether you want to scale the shape relative to the original size or relative to the current size.
    • picture
    • factor short_float -- Specifies the ratio between the width of the shape after you resize it and the current or original width. For example, to make a rectangle 50 percent larger, specify 1.5 for this argument.
    • relative_to_original_size boolean -- Set to true to scale the shape relative to its original size. False to scale it relative to its current size. You can specify true for this argument only if the specified shape is a picture.
    • [scale k.scale_from_top_left / k.scale_from_middle / k.scale_from_bottom_right] -- Specifies which part of the shape retains its position when the shape is scaled.
  • send_to_back -- Sends the object to the back of the z-order.
    • k.line / k.rectangle / k.oval / k.arc
  • set_bullet_picture -- Sets the graphics file to be used for bullets in a bulleted list.
  • set_shapes_default_properties -- Applies the formatting for the specified shape to the default shape. Shapes created after this method has been used will have this formatting applied by default.
  • solid -- Sets the specified fill to a uniform color. Use this method to convert a gradient, textured, patterned, or background fill back to a solid fill.
  • toggle_vertical_text
  • two_color_gradient -- Sets the specified fill to a two-color gradient.
    • fill_format
    • gradient_style k.gradient_unset / k.horizontal_gradient / k.vertical_gradient / k.diagonal_up_gradient / k.diagonal_down_gradient / k.from_corner_gradient / k.from_title_gradient / k.from_center_gradient -- The gradient style.
    • variant integer -- The gradient variant. Can be a value from 1 to 4, corresponding to the four variants on the gradient tab in the fill effects dialog box. If Style is from center gradient, this argument can be either 1 or 2.
  • ungroup
  • user_picture -- Fills the specified shape with one large image.
    • fill_format
    • picture_file unicode_text -- The name of the picture file.
  • user_textured -- Fills the specified shape with small tiles of an image.
    • fill_format
    • texture_file unicode_text -- The name of the picture file.
  • z_order -- Moves the specified shape in front of or behind other shapes in the collection, that is, changes the shape's position in the z-order.
    • shape
    • z_order_command k.bring_shape_to_front / k.send_shape_to_back / k.bring_shape_forward / k.send_shape_backward / k.bring_shape_in_front_of_text / k.send_shape_behind_text -- Specifies where to move the specified shape relative to the other shapes.

Classes

  • adjustment
    • Plural name:
      • adjustments
    • Inherits from:
    • Properties:
      • adjustment_value short_float
  • arc -- Represents an arc graphic.
    • Plural name:
      • arcs
    • Inherits from:
    • Properties:
      • add_indent integer -- Returns or sets if text is automatically indented when the text alignment in a cell is set to equal distribution either horizontally or vertically.
      • auto_scale_font boolean -- Returns or sets if the text in the object changes font size when the object size changes.
      • auto_size integer -- Returns or sets if the size of the specified object is changed automatically to fit text within its boundaries.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • bottom_right_cell (r/o) integer -- Returns the bottom right cell of the range the control is occupying.
      • caption integer -- Returns or sets the caption for this object.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • font_object (r/o) integer -- Returns a font object that represents the font of the specified object.
      • formula integer -- Returns or sets the object's formula, in A1-style notation and in the language of the macro.
      • height integer -- Returns or set the height of the object.
      • horizontal_alignment integer -- Returns or sets the horizontal alignment for the object.
      • interior_object (r/o) integer -- Returns an interior object that represents the interior of the specified object.
      • left_position integer -- Returns or sets the position of the specified object, in points.
      • locked integer -- Returns or sets if the object is locked, if false the object can be modified when the sheet is protected.
      • locked_text integer -- Returns or sets whether the control's text is locked for editing.
      • name integer -- Returns or sets the name of the object.
      • on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • orientation integer -- May also be a number value from -90 to 90 degrees.
      • placement integer -- Returns or sets how the object is placed on the worksheet.
      • print_object integer -- Returns or sets if this object is printed.
      • reading_order k.left_to_right / k.right_to_left / k.context -- Returns or sets the reading order for the specified object.
      • string_value integer -- Returns or sets the text of the specified object.
      • top integer -- Returns the top position of the specified object, in points.
      • top_left_cell (r/o) integer -- Returns a range object that represents the cell that lies under the upper-left corner of the specified object.
      • vertical_alignment integer -- Returns or sets the vertical alignment of the object.
      • visible integer -- Returns or sets if the object is visible.
      • width integer -- Returns or sets the width of the object.
      • wrap_auto_text boolean -- Returns or sets if the auto text is wrapped.
      • z_order_position (r/o) integer -- Returns the z-order position of the object.
    • Elements:
  • bullet_format
    • Inherits from:
    • Properties:
      • bullet_character string -- Returns or sets the Unicode character value that is used for bullets in the specified text.
      • bullet_font (r/o) shape_font -- Returns a font object that represents character formatting for a bullet format object.
      • bullet_number (r/o) integer -- Returns the bullet number of a paragraph.
      • bullet_start_value integer -- Gets or sets the beginning value of a bulleted list.
      • bullet_style k.numbered_bullet_style_unset / k.numbered_bullet_style_alpha_lowercase_period / k.numbered_bullet_style_alpha_uppercase_period / k.numbered_bullet_style_arabic_right_paren / k.numbered_bullet_style_arabic_period / k.numbered_bullet_style_roman_lowercase_paren_both / k.numbered_bullet_style_roman_lowercase_paren_right / k.numbered_bullet_style_roman_lowercase_period / k.numbered_bullet_style_roman_uppercase_period / k.numbered_bullet_style_alpha_lowercase_paren_both / k.numbered_bullet_style_alpha_lowercase_paren_right / k.numbered_bullet_style_alpha_uppercase_paren_both / k.numbered_bullet_style_alpha_uppercase_paren_right / k.numbered_bullet_style_arabic_paren_both / k.numbered_bullet_style_arabic_plain / k.numbered_bullet_style_roman_uppercase_paren_both / k.numbered_bullet_style_roman_uppercase_paren_right / k.numbered_bullet_style_simplified_chinese_plain / k.numbered_bullet_style_simplified_chinese_period / k.numbered_bullet_style_circle_number_plain / k.numbered_bullet_style_circle_number_white_plain / k.numbered_bullet_style_circle_number_black_plain / k.numbered_bullet_style_traditional_chinese_plain / k.numbered_bullet_style_traditional_chinese_period / k.numbered_bullet_style_arabic_alpha_dash / k.numbered_bullet_style_arabic_abjad_dash / k.numbered_bullet_style_hebrew_alpha_dash / k.numbered_bullet_style_kanji_korean_plain / k.numbered_bullet_style_kanji_korean_period / k.numbered_bullet_style_arabic_DB_plain / k.numbered_bullet_style_arabic_DB_period / k.numbered_bullet_style_thai_alpha_period / k.numbered_bullet_style_thai_alpha_paren_right / k.numbered_bullet_style_thai_alpha_paren_both / k.numbered_bullet_style_thai_number_period / k.numbered_bullet_style_thai_number_paren_right / k.numbered_bullet_style_thai_paren_both / k.numbered_bullet_style_hindi_alpha_period / k.numbered_bullet_style_hindi_number_period / k.numbered_bullet_style_kanji_simpified_chinese_DB_period / k.numbered_bullet_style_hindi_number_paren_right / k.numbered_bullet_style_hindi_alpha1_period -- Returns or sets a constant that represents the style of a bullet.
      • bullet_type k.bullet_type_unset / k.bullet_type_none / k.bullet_type_unnumbered / k.bullet_type_numbered / k.picture_bullet_type -- Returns or sets a constant that represents the type of bullet.
      • relative_size short_float -- Returns or sets the bullet size relative to the size of the first text character in the paragraph.
      • use_text_color boolean -- Determines whether the specified bullets are set to the color of the first text character in the paragraph.
      • use_text_font boolean -- Determines whether the specified bullets are set to the font of the first text character in the paragraph.
      • visible boolean -- Returns or sets a value that specifies whether the bullet is visible.
  • callout_format -- Contains properties and methods that apply to line callouts.
    • Plural name:
      • callout_formats
    • Inherits from:
    • Properties:
      • accent boolean -- Returns or sets if a vertical accent bar separates the callout text from the callout line.
      • angle k.angle_unset / k.angle_automatic / k.angle30 / k.angle45 / k.angle60 / k.angle90 -- Returns or sets the angle of the callout line. If the callout line contains more than one line segment, this property returns or sets the angle of the segment that is farthest from the callout text box.
      • auto_attach boolean -- Returns or sets if the place where the callout line attaches to the callout text box changes depending on whether the origin of the callout line, where the callout points to, is to the left or right of the callout text box.
      • auto_length (r/o) boolean -- Returns if the length of the callout line is automatically set. Use the automatic length method to set this property to true, and use the custom length method to set this property to false.
      • border boolean -- Returns or sets whether the text in the specified callout is surrounded by a border.
      • callout_format_length (r/o) short_float -- When the auto length property of the specified callout is set to false, the length property returns the length in points of the first segment of the callout line, the segment attached to the text callout box.
      • callout_format_type k.callout_unset / k.callout_one / k.callout_two / k.callout_three / k.callout_four -- Returns or sets the callout type.
      • drop (r/o) short_float -- For callouts with an explicitly set drop value, this property returns the vertical distance in points from the edge of the text bounding box to the place where the callout line attaches to the text box.
      • drop_type (r/o) k.drop_unset / k.drop_custom / k.drop_top / k.drop_center / k.drop_bottom -- Returns a value that indicates where the callout line attaches to the callout text box.
      • gap short_float -- Returns or sets the horizontal distance in points between the end of the callout line and the text bounding box.
  • callout
    • Plural name:
      • callouts
    • Inherits from:
    • Properties:
      • callout_format (r/o) callout_format -- Returns a connector format object that contains connector formatting properties.
      • callout_type (r/o) k.callout_unset / k.callout_one / k.callout_two / k.callout_three / k.callout_four -- Returns the type of callout.
  • connector_format -- Contains properties and methods that apply to connectors. A connector is a line that attaches two other shapes at points called connection sites.
    • Plural name:
      • connector_formats
    • Inherits from:
    • Properties:
      • begin_connected (r/o) boolean -- Returns true if the beginning of the specified connector is connected to a shape.
      • begin_connected_shape (r/o) shape -- Returns a shape object that represents the shape that the beginning of the specified connector is attached to.
      • begin_connection_site (r/o) integer -- Returns an integer that specifies the connection site that the beginning of a connector is connected to.
      • connector_format_type k.connector_type_unset / k.straight / k.elbow / k.curve -- Returns or sets the connector type.
      • end_connected (r/o) boolean -- Returns true if the end of the specified connector is connected to a shape.
      • end_connected_shape (r/o) shape -- Returns a shape object that represents the shape that the end of the specified connector is attached to.
      • end_connection_site (r/o) integer -- Returns an integer that specifies the connection site that the end of a connector is connected to.
  • fill_format -- Represents fill formatting for a shape. A shape can have a solid, gradient, texture, pattern, picture, or semi-transparent fill.
    • Plural name:
      • fill_formats
    • Inherits from:
    • Properties:
      • back_color RGB_color -- Returns or sets a RGB color that represents the background color for the specified fill or patterned line.
      • back_color_theme_index k.theme_color_unset / k.no_theme_color / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color / k.first_text_theme_color / k.first_background_theme_color / k.second_text_theme_color / k.second_background_theme_color -- Returns or sets the specified fill background color.
      • fill_format_type (r/o) k.fill_unset / k.fill_solid / k.fill_patterned / k.fill_gradient / k.fill_textured / k.fill_background / k.fill_picture -- Returns the shape fill format type.
      • fore_color RGB_color -- Returns or sets a RGB color that represents the foreground color for the fill, line, or shadow.
      • fore_color_theme_index k.theme_color_unset / k.no_theme_color / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color / k.first_text_theme_color / k.first_background_theme_color / k.second_text_theme_color / k.second_background_theme_color -- Returns or sets the specified foreground fill or solid color.
      • gradient_color_type (r/o) k.gradient_type_unset / k.single_shade_gradient_type / k.two_colors_gradient_type / k.preset_colors_gradient_type / k.multi_colors_gradient_type -- Returns the gradient color type for the specified fill.
      • gradient_degree (r/o) short_float -- Returns a value that indicates how dark or light a one-color gradient fill is. A value of zero means that black is mixed in with the shape's foreground color to form the gradient; a value of 1 means that white is mixed in. Values between 1 and zero blend.
      • gradient_style (r/o) k.gradient_unset / k.horizontal_gradient / k.vertical_gradient / k.diagonal_up_gradient / k.diagonal_down_gradient / k.from_corner_gradient / k.from_title_gradient / k.from_center_gradient -- Returns the gradient style for the specified fill.
      • gradient_variant (r/o) integer -- Returns the gradient variant for the specified fill as an integer value from 1 to 4 for most gradient fills. If the gradient style is from center gradient, this property returns either 1 or 2.
      • pattern (r/o) k.pattern_unset / k.five_percent_pattern / k.ten_percent_pattern / k.twenty_percent_pattern / k.twenty_five_percent_pattern / k.thirty_percent_pattern / k.forty_percent_pattern / k.fifty_percent_pattern / k.sixty_percent_pattern / k.seventy_percent_pattern / k.seventy_five_percent_pattern / k.eighty_percent_pattern / k.ninety_percent_pattern / k.dark_horizontal_pattern / k.dark_vertical_pattern / k.dark_downward_diagonal_pattern / k.dark_upward_diagonal_pattern / k.small_checker_board_pattern / k.trellis_pattern / k.light_horizontal_pattern / k.light_vertical_pattern / k.light_downward_diagonal_pattern / k.light_upward_diagonal_pattern / k.small_grid_pattern / k.dotted_diamond_pattern / k.wide_downward_diagonal / k.wide_upward_diagonal_pattern / k.dashed_upward_diagonal_pattern / k.dashed_downward_diagonal_pattern / k.narrow_vertical_pattern / k.narrow_horizontal_pattern / k.dashed_vertical_pattern / k.dashed_horizontal_pattern / k.large_confetti_pattern / k.large_grid_pattern / k.horizontal_brick_pattern / k.large_checker_board_pattern / k.small_confetti_pattern / k.zig_zag_pattern / k.solid_diamond_pattern / k.diagonal_brick_pattern / k.outlined_diamond_pattern / k.plaid_pattern / k.sphere_pattern / k.weave_pattern / k.dotted_grid_pattern / k.divot_pattern / k.shingle_pattern / k.wave_pattern / k.horizontal_pattern / k.vertical_pattern / k.cross_pattern / k.downward_diagonal_pattern / k.upward_diagonal_pattern / k.diagonal_cross_pattern -- Returns a value that represents the pattern applied to the specified fill or line.
      • preset_gradient_type (r/o) k.preset_gradient_unset / k.gradient_early_sunset / k.gradient_late_sunset / k.gradient_nightfall / k.gradient_daybreak / k.gradient_horizon / k.gradient_desert / k.gradient_ocean / k.gradient_calm_water / k.gradient_fire / k.gradient_fog / k.gradient_moss / k.gradient_peacock / k.gradient_wheat / k.gradient_parchment / k.gradient_mahogany / k.gradient_rainbow / k.gradient_rainbow2 / k.gradient_gold / k.gradient_gold2 / k.gradient_brass / k.gradient_chrome / k.gradient_chrome2 / k.gradient_silver / k.gradient_sapphire -- Returns the preset gradient type for the specified fill.
      • preset_texture (r/o) k.preset_texture_unset / k.texture_papyrus / k.texture_canvas / k.texture_denim / k.texture_woven_mat / k.texture_water_droplets / k.texture_paper_bag / k.texture_fish_fossil / k.texture_sand / k.texture_green_marble / k.texture_white_marble / k.texture_brown_marble / k.texture_granite / k.texture_newsprint / k.texture_recycled_paper / k.texture_parchment / k.texture_stationery / k.texture_blue_tissue_paper / k.texture_pink_tissue_paper / k.texture_purple_mesh / k.texture_bouquet / k.texture_cork / k.texture_walnut / k.texture_oak / k.texture_medium_wood -- Returns the preset texture for the specified fill.
      • rotate_with_object boolean -- Returns or sets whether the fill rotates with the specified shape.
      • texture_alignment k.texture_unset / k.texture_top_left / k.texture_top / k.texture_top_right / k.texture_left / k.texture_center / k.texture_right / k.texture_bottom_left / k.texture_botton / k.texture_bottom_right -- Returns or sets the texture alignment for the specified object.
      • texture_horizontal_scale short_float -- Returns or sets the texture alignment for the specified object.
      • texture_name (r/o) unicode_text -- Returns the name of the custom texture file for the specified fill.
      • texture_offset_X short_float -- Returns or sets the texture alignment for the specified object.
      • texture_offset_Y short_float -- Returns or sets the texture alignment for the specified object.
      • texture_tile boolean -- Returns the texture tile style for the specified fill.
      • texture_type (r/o) k.texture_type_texture_type_unset / k.texture_type_preset_texture / k.texture_type_user_defined_texture -- Returns the texture type for the specified fill.
      • texture_vertical_scale short_float -- Returns or sets the texture alignment for the specified object.
      • transparency short_float -- Returns or sets the degree of transparency of the specified fill, shadow, or line as a value between 0.0, opaque, and 1.0, clear.
      • visible boolean -- Returns or sets if the specified object, or the formatting applied to it, is visible.
    • Elements:
  • glow_format -- Represents the glow formatting for a shape or range of shapes
    • Inherits from:
    • Properties:
      • color RGB_color -- Returns or sets the color for the specified glow format.
      • color_theme_index k.theme_color_unset / k.no_theme_color / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color / k.first_text_theme_color / k.first_background_theme_color / k.second_text_theme_color / k.second_background_theme_color -- Returns or sets the color for the specified glow format.
      • radius short_float -- Returns or sets the length of the radius for the specified glow format.
  • gradient_stop -- Represents one gradient stop.
    • Plural name:
      • gradient_stops
    • Inherits from:
    • Properties:
      • color RGB_color -- Returns or sets the color for the specified the gradient stop.
      • color_theme_index k.theme_color_unset / k.no_theme_color / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color / k.first_text_theme_color / k.first_background_theme_color / k.second_text_theme_color / k.second_background_theme_color -- Returns or sets the color for the specified gradient stop.
      • position short_float -- Returns or sets the position for the specified gradient stop expressed as a percent.
      • transparency short_float -- Returns or sets a value representing the transparency of the gradient fill expressed as a percent.
  • line_format -- Represents line and arrowhead formatting. For a line, the line format object contains formatting information for the line itself; for a shape with a border, this object contains formatting information for the shape's border.
    • Plural name:
      • line_formats
    • Inherits from:
    • Properties:
      • back_color RGB_color -- Returns or sets a RGB color that represents the background color for the specified fill or patterned line.
      • back_color_theme_index k.theme_color_unset / k.no_theme_color / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color / k.first_text_theme_color / k.first_background_theme_color / k.second_text_theme_color / k.second_background_theme_color -- Returns or sets the background color for a patterned line.
      • begin_arrowhead_length k.arrowhead_length_unset / k.short_arrowhead / k.medium_arrowhead / k.long_arrowhead -- Returns or sets the length of the arrowhead at the beginning of the specified line.
      • begin_arrowhead_style k.arrowhead_style_unset / k.no_arrowhead / k.triangle_arrowhead / k.open_arrowhead / k.stealth_arrowhead / k.diamond_arrowhead / k.oval_arrowhead -- Returns or sets the style of the arrowhead at the beginning of the specified line.
      • begin_arrowhead_width k.arrowhead_width_unset / k.narrow_width_arrowhead / k.medium_width_arrowhead / k.wide_arrowhead -- Returns or sets the width of the arrowhead at the beginning of the specified line.
      • dash_style_ k.line_dash_style_unset / k.line_dash_style_solid / k.line_dash_style_square_dot / k.line_dash_style_round_dot / k.line_dash_style_dash / k.line_dash_style_dash_dot / k.line_dash_style_dash_dot_dot / k.line_dash_style_long_dash / k.line_dash_style_long_dash_dot / k.line_dash_style_long_dash_dot_dot / k.line_dash_style_system_dash / k.line_dash_style_system_dot / k.line_dash_style_system_dash_dot -- Returns or sets the dash style for the specified line.
      • end_arrowhead_length k.arrowhead_length_unset / k.short_arrowhead / k.medium_arrowhead / k.long_arrowhead -- Returns or sets the length of the arrowhead at the end of the specified line.
      • end_arrowhead_style k.arrowhead_style_unset / k.no_arrowhead / k.triangle_arrowhead / k.open_arrowhead / k.stealth_arrowhead / k.diamond_arrowhead / k.oval_arrowhead -- Returns or sets the style of the arrowhead at the end of the specified line.
      • end_arrowhead_width k.arrowhead_width_unset / k.narrow_width_arrowhead / k.medium_width_arrowhead / k.wide_arrowhead -- Returns or sets the width of the arrowhead at the end of the specified line.
      • fore_color RGB_color -- Returns or sets a RGB color that represents the foreground color for the fill, line, or shadow.
      • fore_color_theme_index k.theme_color_unset / k.no_theme_color / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color / k.first_text_theme_color / k.first_background_theme_color / k.second_text_theme_color / k.second_background_theme_color -- Returns or sets the foreground color for the line.
      • line_style k.line_style_unset / k.single_line / k.thin_thin_line / k.thin_thick_line / k.thick_thin_line / k.thick_between_thin_line -- Returns or sets the line format style.
      • pattern k.pattern_unset / k.five_percent_pattern / k.ten_percent_pattern / k.twenty_percent_pattern / k.twenty_five_percent_pattern / k.thirty_percent_pattern / k.forty_percent_pattern / k.fifty_percent_pattern / k.sixty_percent_pattern / k.seventy_percent_pattern / k.seventy_five_percent_pattern / k.eighty_percent_pattern / k.ninety_percent_pattern / k.dark_horizontal_pattern / k.dark_vertical_pattern / k.dark_downward_diagonal_pattern / k.dark_upward_diagonal_pattern / k.small_checker_board_pattern / k.trellis_pattern / k.light_horizontal_pattern / k.light_vertical_pattern / k.light_downward_diagonal_pattern / k.light_upward_diagonal_pattern / k.small_grid_pattern / k.dotted_diamond_pattern / k.wide_downward_diagonal / k.wide_upward_diagonal_pattern / k.dashed_upward_diagonal_pattern / k.dashed_downward_diagonal_pattern / k.narrow_vertical_pattern / k.narrow_horizontal_pattern / k.dashed_vertical_pattern / k.dashed_horizontal_pattern / k.large_confetti_pattern / k.large_grid_pattern / k.horizontal_brick_pattern / k.large_checker_board_pattern / k.small_confetti_pattern / k.zig_zag_pattern / k.solid_diamond_pattern / k.diagonal_brick_pattern / k.outlined_diamond_pattern / k.plaid_pattern / k.sphere_pattern / k.weave_pattern / k.dotted_grid_pattern / k.divot_pattern / k.shingle_pattern / k.wave_pattern / k.horizontal_pattern / k.vertical_pattern / k.cross_pattern / k.downward_diagonal_pattern / k.upward_diagonal_pattern / k.diagonal_cross_pattern -- Returns or sets a value that represents the pattern applied to the specified fill or line.
      • transparency short_float -- Returns or sets the degree of transparency of the specified fill, shadow, or line as a value between 0.0, opaque and 1.0, clear.
      • visible boolean -- Returns or sets if the specified object, or the formatting applied to it, is visible.
      • weight short_float -- Returns or sets the thickness of the specified line in points.
  • line -- Represents a line graphic object.
    • Plural name:
      • lines
    • Inherits from:
    • Properties:
      • arrowhead_length k.arrowhead_length_long / k.arrowhead_length_medium / k.arrowhead_length_short -- Returns or sets the length of an arrowhead
      • arrowhead_style k.arrowhead_style_closed / k.arrowhead_style_double_closed / k.arrowhead_style_double_open / k.arrowhead_style_none / k.arrowhead_style_open -- Returns or sets the style of an arrowhead.
      • arrowhead_width k.arrowhead_width_medium / k.arrowhead_width_narrow / k.arrowhead_width_wide -- Returns or sets the width of an arrowhead.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • bottom_right_cell (r/o) range -- Returns the bottom right cell of the range the control is occupying.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • height float -- Returns or set the height of the object.
      • left_position float -- Returns or sets the position of the specified object, in points.
      • locked boolean -- Returns or sets if the object is locked, if false the object can be modified when the sheet is protected.
      • name unicode_text -- Returns or sets the name of the object.
      • on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • placement k.placement_free_floating / k.placement_move / k.placement_move_and_size -- Returns or sets how the object is placed on the worksheet.
      • print_object boolean -- Returns or sets if this object is printed.
      • top float -- Returns the top position of the specified object, in points.
      • top_left_cell (r/o) range -- Returns a range object that represents the cell that lies under the upper-left corner of the specified object.
      • visible boolean -- Returns or sets if the object is visible.
      • width float -- Returns or sets the width of the object.
      • z_order_position (r/o) integer -- Returns the z-order position of the object.
  • major_theme_font -- Represents a container for the font schemes of a Microsoft Office theme.
    • Plural name:
      • major_theme_fonts
    • Inherits from:
  • minor_theme_font -- Represents a container for the font schemes of a Microsoft Office theme.
    • Plural name:
      • minor_theme_fonts
    • Inherits from:
  • office_theme -- Represents a Microsoft Office theme.
    • Inherits from:
    • Properties:
      • theme_color_scheme (r/o) theme_color_scheme -- Returns the color scheme of a Microsoft Office theme.
      • theme_effect_scheme (r/o) theme_effect_scheme -- Returns the effects scheme of a Microsoft Office theme.
      • theme_font_scheme (r/o) theme_font_scheme -- Returns the font scheme of a Microsoft Office theme.
  • oval -- Represents an oval graphic.
    • Plural name:
      • ovals
    • Inherits from:
    • Properties:
      • add_indent integer -- Returns or sets if text is automatically indented when the text alignment in a cell is set to equal distribution either horizontally or vertically.
      • auto_scale_font boolean -- Returns or sets if the text in the object changes font size when the object size changes.
      • auto_size integer -- Returns or sets if the size of the specified object is changed automatically to fit text within its boundaries.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • bottom_right_cell (r/o) integer -- Returns the bottom right cell of the range the control is occupying.
      • caption integer -- Returns or sets the caption for this object.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • font_object (r/o) integer -- Returns a font object that represents the font of the specified object.
      • formula integer -- Returns or sets the object's formula, in A1-style notation and in the language of the macro.
      • height integer -- Returns or set the height of the object.
      • horizontal_alignment integer -- Returns or sets the horizontal alignment for the object.
      • interior_object (r/o) integer -- Returns an interior object that represents the interior of the specified object.
      • left_position integer -- Returns or sets the position of the specified object, in points.
      • locked integer -- Returns or sets if the object is locked, if false the object can be modified when the sheet is protected.
      • locked_text integer -- Returns or sets whether the control's text is locked for editing.
      • name integer -- Returns or sets the name of the object.
      • on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • orientation integer -- May also be a number value from -90 to 90 degrees.
      • placement integer -- Returns or sets how the object is placed on the worksheet.
      • print_object integer -- Returns or sets if this object is printed.
      • reading_order k.left_to_right / k.right_to_left / k.context -- Returns or sets the reading order for the specified object.
      • shadow integer -- Returns or sets if the object has a shadow.
      • string_value integer -- Returns or sets the text of the specified object.
      • top integer -- Returns the top position of the specified object, in points.
      • top_left_cell (r/o) integer -- Returns a range object that represents the cell that lies under the upper-left corner of the specified object.
      • vertical_alignment integer -- Returns or sets the vertical alignment of the object.
      • visible integer -- Returns or sets if the object is visible.
      • width integer -- Returns or sets the width of the object.
      • wrap_auto_text boolean -- Returns or sets if the auto text is wrapped.
      • z_order_position (r/o) integer -- Returns the z-order position of the object.
    • Elements:
  • paragraph_format
    • Inherits from:
    • Properties:
      • alignment k.paragraph_alignment_unset / k.paragraph_align_left / k.paragraph_align_center / k.paragraph_align_right / k.paragraph_align_justify / k.paragraph_align_distribute / k.paragraph_align_Thai / k.paragraph_align_justify_low -- Returns or sets a value specifying the alignment of the paragraph.
      • baseline_alignment k.text_baseline_alignment_unset / k.text_baseline_align_baseline / k.text_baseline_align_top / k.text_baseline_align_center / k.text_baseline_align_east_asian50 / k.text_baseline_align_automatic -- Returns or sets a constant that represents the vertical position of fonts in a paragraph.
      • bullet (r/o) bullet_format -- Returns a bullet format object for the paragraph.
      • east_asian_line_break_level boolean -- Returns or sets the East Asian line break control level for the specified paragraph.
      • first_line_indent short_float -- Returns or sets the value, in points, for a first line or hanging indent.
      • hanging_punctuation boolean -- Determines whether hanging punctuation is enabled for the specified paragraphs.
      • indent_level integer -- Returns or sets a value representing the indent level assigned to text in the selected paragraph.
      • left_indent short_float -- Returns or sets a value that represents the left indent value, in points, for the specified paragraphs.
      • line_rule_after boolean -- Determines whether line spacing after the last line in each paragraph is set to a specific number of points or lines.
      • line_rule_before boolean -- Determines whether line spacing before the first line in each paragraph is set to a specific number of points or lines.
      • line_rule_within boolean -- Determines whether line spacing between base lines is set to a specific number of points or lines.
      • right_indent short_float -- Returns or sets the right indent, in points, for the specified paragraphs.
      • space_after short_float -- Returns or sets the amount of spacing, in points, after the specified paragraph.
      • space_before short_float -- Returns or sets the spacing, in points, before the specified paragraphs.
      • space_within short_float -- Returns or sets the amount of space between base lines in the specified paragraph, in points or lines.
      • text_direction AEType("mTxD") -- Returns or sets the text direction for the specified paragraph.
      • word_wrap boolean -- Determines whether the application wraps the Latin text in the middle of a word in the specified paragraphs.
    • Elements:
  • picture_format -- Contains properties and methods that apply to pictures.
    • Plural name:
      • picture_formats
    • Inherits from:
    • Properties:
      • brightness short_float -- Returns or sets the brightness of the specified picture . The value for this property must be a number from 0.0, dimmest to 1.0, brightest.
      • color_type k.picture_color_type_unset / k.picture_color_automatic / k.picture_color_gray_scale / k.picture_color_black_and_white / k.picture_color_watermark -- Returns or sets the type of color transformation applied to the specified picture.
      • contrast short_float -- Returns or sets the contrast for the specified picture. The value for this property must be a number from 0.0, the least contrast to 1.0, the greatest contrast.
      • crop_bottom short_float -- Returns or sets the number of points that are cropped off the bottom of the specified picture.
      • crop_left short_float -- Returns or sets the number of points that are cropped off the left side of the specified picture.
      • crop_right short_float -- Returns or sets the number of points that are cropped off the right side of the specified picture.
      • crop_top short_float -- Returns or sets the number of points that are cropped off the top of the specified picture.
      • transparency_color RGB_color -- Returns or sets the transparent color for the specified picture as aRGB color. For this property to take effect, the transparent background property must be set to true.
      • transparent_background boolean -- Returns or sets if the parts of the picture that are defined with a transparent color actually appear transparent.
  • picture
    • Plural name:
      • pictures
    • Inherits from:
    • Properties:
      • file_name (r/o) unicode_text -- Returns he name of the file that has the picture.
      • link_to_file (r/o) boolean -- Returns if the picture is lined to the file.
      • picture_format (r/o) picture_format -- Returns a picture format object for this picture.
      • save_with_document (r/o) boolean -- Returns if the picture should be saved with the document.
  • rectangle -- Represents a rectangle graphic object.
    • Plural name:
      • rectangles
    • Inherits from:
    • Properties:
      • add_indent integer -- Returns or sets if text is automatically indented when the text alignment in a cell is set to equal distribution either horizontally or vertically.
      • auto_scale_font boolean -- Returns or sets if the text in the object changes font size when the object size changes.
      • auto_size integer -- Returns or sets if the size of the specified object is changed automatically to fit text within its boundaries.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • bottom_right_cell (r/o) integer -- Returns the bottom right cell of the range the control is occupying.
      • caption integer -- Returns or sets the caption for this object.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • font_object (r/o) integer -- Returns a font object that represents the font of the specified object.
      • formula integer -- Returns or sets the object's formula, in A1-style notation and in the language of the macro.
      • height integer -- Returns or set the height of the object.
      • horizontal_alignment integer -- Returns or sets the horizontal alignment for the object.
      • interior_object (r/o) integer -- Returns an interior object that represents the interior of the specified object.
      • left_position integer -- Returns or sets the position of the specified object, in points.
      • locked integer -- Returns or sets if the object is locked, if false the object can be modified when the sheet is protected.
      • locked_text integer -- Returns or sets whether the control's text is locked for editing.
      • name integer -- Returns or sets the name of the object.
      • on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • orientation integer -- May also be a number value from -90 to 90 degrees.
      • placement integer -- Returns or sets how the object is placed on the worksheet.
      • print_object integer -- Returns or sets if this object is printed.
      • reading_order k.left_to_right / k.right_to_left / k.context -- Returns or sets the reading order for the specified object.
      • rounded_corners integer -- Returns or sets if the rectangle has rounded corners
      • shadow integer -- Returns or sets if the object has a shadow.
      • string_value integer -- Returns or sets the text of the specified object.
      • top integer -- Returns the top position of the specified object, in points.
      • top_left_cell (r/o) integer -- Returns a range object that represents the cell that lies under the upper-left corner of the specified object.
      • vertical_alignment integer -- Returns or sets the vertical alignment of the object.
      • visible integer -- Returns or sets if the object is visible.
      • width integer -- Returns or sets the width of the object.
      • z_order_position (r/o) integer -- Returns the z-order position of the object.
    • Elements:
  • reflection_format -- Represents the reflection effect in Office graphics.
    • Inherits from:
    • Properties:
      • reflection_type k.reflection_unset / k.reflection_type_none / k.reflection_type1 / k.reflection_type2 / k.reflection_type3 / k.reflection_type4 / k.reflection_type5 / k.reflection_type6 / k.reflection_type7 / k.reflection_type8 / k.reflection_type9 -- Returns or sets the type of the reflection format object.
  • ruler_level
    • Plural name:
      • ruler_levels
    • Inherits from:
    • Properties:
      • first_margin short_float -- Returns or sets the first-line indent for the specified outline level, in points.
      • left_margin short_float -- Returns or sets the left indent for the specified outline level, in points.
  • ruler -- Represents the ruler for the text in the specified shape or for all text in the specified text style. Contains tab stops and the indentation settings for text outline levels.
  • shadow_format -- Represents shadow formatting for a shape.
    • Plural name:
      • shadow_formats
    • Inherits from:
    • Properties:
      • blur short_float -- Returns or sets the blur, in points, of the specified shadow.
      • fore_color RGB_color -- Returns or sets a RGB color that represents the foreground color for the fill, line, or shadow.
      • fore_color_theme_index k.theme_color_unset / k.no_theme_color / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color / k.first_text_theme_color / k.first_background_theme_color / k.second_text_theme_color / k.second_background_theme_color -- Returns or sets the foreground color for the shadow format.
      • obscured boolean -- Returns or sets if the shadow of the specified shape appears filled in and is obscured by the shape, even if the shape has no fill. If false the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill.
      • offset_X short_float -- Returns or sets the horizontal offset in points of the shadow from the specified shape. A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left.
      • offset_Y short_float -- Returns or sets the vertical offset in points of the shadow from the specified shape. A positive value offsets the shadow below the shape; a negative value offsets it above the shape.
      • rotate_with_shape boolean -- Returns or sets whether to rotate the shadow when rotating the shape.
      • shadow_style k.shadow_style_unset / k.shadow_style_inner / k.shadow_style_outer -- Returns or sets the style of shadow formatting to apply to a shape.
      • shadow_type k.shadow_unset / k.shadow1 / k.shadow2 / k.shadow3 / k.shadow4 / k.shadow5 / k.shadow6 / k.shadow7 / k.shadow8 / k.shadow9 / k.shadow10 / k.shadow11 / k.shadow12 / k.shadow13 / k.shadow14 / k.shadow15 / k.shadow16 / k.shadow17 / k.shadow18 / k.shadow19 / k.shadow20 / k.shadow21 / k.shadow22 / k.shadow23 / k.shadow24 / k.shadow25 / k.shadow26 / k.shadow27 / k.shadow28 / k.shadow29 / k.shadow30 / k.shadow31 / k.shadow32 / k.shadow33 / k.shadow34 / k.shadow35 / k.shadow36 / k.shadow37 / k.shadow38 / k.shadow39 / k.shadow40 / k.shadow41 / k.shadow42 / k.shadow43 -- Returns or sets the shape shadow type.
      • size short_float -- Returns or sets the width of the shadow.
      • transparency short_float -- Returns or sets the degree of transparency of the specified fill, shadow, or line as a value between 0.0, opaque and 1.0, clear.
      • visible boolean -- Returns or sets if the specified object, or the formatting applied to it, is visible.
  • shape_connector
    • Plural name:
      • shape_connectors
    • Inherits from:
    • Properties:
      • connector_format (r/o) connector_format -- Returns a connector format object that contains connector formatting properties.
      • connector_type (r/o) k.connector_type_unset / k.straight / k.elbow / k.curve -- Returns the connector type.
  • shape_font -- Contains font attributes such as font name, size, and color, for an object.
    • Inherits from:
    • Properties:
      • ASCII_name unicode_text -- Returns or sets the font used for Latin text; characters with character codes from 0 through 127.
      • auto_rotate_numbers boolean -- Returns or sets a value that specifies whether the numbers in a numbered list should be rotated when the text is rotated.
      • base_line_offset short_float -- Returns or sets a value specifying the horizontaol offset of the selected font.
      • bold boolean -- Returns or sets a value specifying whether the font should be bold.
      • caps_type k.caps_unset / k.no_caps / k.small_caps / k.all_caps -- Returns or sets a value specifying how the text should be capitalized.
      • east_asian_name unicode_text -- Returns or sets the font name used for Asian text.
      • embedable (r/o) boolean -- Returns a value indicating whether the font can be embedded in a page.
      • embedded (r/o) boolean -- Returns a value specifying whether the font is embedded in a page.
      • equalize_character_height boolean -- Returns or sets a value specifying whether the text should have the same horizontal height.
      • fill_format (r/o) fill_format -- Returns a fill format object that contains fill formatting properties for the specified font.
      • font_color RGB_color
      • font_color_theme_index k.theme_color_unset / k.no_theme_color / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color / k.first_text_theme_color / k.first_background_theme_color / k.second_text_theme_color / k.second_background_theme_color -- Returns or sets the color for the specified font.
      • font_name unicode_text -- Returns or sets a value specifying the font to use for a selection.
      • font_name_other unicode_text -- Returns or sets the font used for characters whose character set numbers are greater than 127.
      • font_size short_float -- Returns or sets the font size.
      • glow_format (r/o) glow_format -- Returns the formatting properties for a glow effect.
      • highlight_color RGB_color -- Returns or sets the text highlight color for object.
      • highlight_color_theme_index k.theme_color_unset / k.no_theme_color / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color / k.first_text_theme_color / k.first_background_theme_color / k.second_text_theme_color / k.second_background_theme_color -- Returns or sets the highlight color for the specified text.
      • italic boolean -- Returns or sets a value specifying whether the text for a selection is italic.
      • kerning short_float -- Returns or sets a value specifying the amount of spacing between text characters.
      • line_format (r/o) line_format -- Returns a value specifiying the format of a line.
      • reflection_format (r/o) reflection_format -- Returns the formatting properties for a reflection effect.
      • shadow_format (r/o) shadow_format -- Returns the value specifying the type of shadow effect for the selection of text.
      • soft_edge_type k.soft_edge_unset / k.no_soft_edge / k.soft_edge_type1 / k.soft_edge_type2 / k.soft_edge_type3 / k.soft_edge_type4 / k.soft_edge_type5 / k.soft_edge_type6 -- Returns or sets the type soft edge format object.
      • spacing short_float -- Returns or sets a value specifying the spacing between characters in a selection of text.
      • strike_type k.strike_unset / k.no_strike / k.single_strike / k.double_strike -- Returns or sets a value specifying the strike format used for a selection of text.
      • subscript boolean -- Returns or sets a value specifying that the selected text should be displayed a subscript.
      • superscript boolean -- Returns or sets a value specifying that the selected text should be displayed a superscript.
      • underline_color RGB_color -- Returns a value specifying the color of the underline for the selected text.
      • underline_color_theme_index k.theme_color_unset / k.no_theme_color / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color / k.first_text_theme_color / k.first_background_theme_color / k.second_text_theme_color / k.second_background_theme_color -- Returns a value specifying the color of the underline for the selected text.
      • underline_style k.underline_unset / k.no_underline / k.underline_words_only / k.underline_single_line / k.underline_double_line / k.underline_heavy_line / k.underline_dotted_line / k.underline_heavy_dotted_line / k.underline_dash_line / k.underline_heavy_dash_line / k.underline_long_dash_line / k.underline_heavy_long_dash_line / k.underline_dot_dash_line / k.underline_heavy_dot_dash_line / k.underline_dot_dot_dash_line / k.underline_heavy_dot_dot_dash_line / k.underline_wavy_line / k.underline_heavy_wavy_line / k.underline_wavy_double_line -- Returns or sets a value specifying the text effect for the selected text.
      • word_art_styles_format k.wordart_format_unset / k.wordart_format1 / k.wordart_format2 / k.wordart_format3 / k.wordart_format4 / k.wordart_format5 / k.wordart_format6 / k.wordart_format7 / k.wordart_format8 / k.wordart_format9 / k.wordart_format10 / k.wordart_format11 / k.wordart_format12 / k.wordart_format13 / k.wordart_format14 / k.wordart_format15 / k.wordart_format16 / k.wordart_format17 / k.wordart_format18 / k.wordart_format19 / k.wordart_format20 / k.wordart_format21 / k.wordart_format22 / k.wordart_format23 / k.wordart_format24 / k.wordart_format25 / k.wordart_format26 / k.wordart_format27 / k.wordart_format28 / k.wordart_format29 / k.wordart_format30 -- Returns or sets a value specifying the text effect for the selected text.
  • shape_line -- The line shape uses begin line X, begin line Y, end line X, and end line Y when created
    • Plural name:
      • shape_lines
    • Inherits from:
    • Properties:
      • begin_line_X short_float -- Returns or sets the beginning X position of the line.
      • begin_line_Y short_float -- Returns or sets the beginning Y position of the line.
      • end_line_X short_float -- Returns or sets the ending X position of the line.
      • end_line_Y short_float -- Returns or sets the ending Y position of the line.
  • shape_text_frame -- Represents the shape text frame in a shape object. Contains the text in the text frame as well as the properties and methods that control the alignment and anchoring of the text frame.
    • Plural name:
      • shape_text_frames
    • Inherits from:
    • Properties:
      • has_text (r/o) boolean -- Returns whether the specified text frame has text.
      • horizontal_anchor k.horizontal_anchor_unset / k.horizontal_anchor_none / k.horizontal_anchor_center
      • margin_bottom short_float -- Returns or sets the distance, in points, between the bottom of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.
      • margin_left short_float -- Returns or sets the distance, in points, between the left edge of the text frame and the left edge of the inscribed rectangle of the shape that contains the text.
      • margin_right short_float -- Returns or sets the distance, in points, between the right edge of the text frame and the right edge of the inscribed rectangle of the shape that contains the text.
      • margin_top short_float -- Returns or sets the distance, in points, between the top of the text frame and the top of the inscribed rectangle of the shape that contains the text.
      • orientation k.text_orientation_unset / k.horizontal / k.upward / k.downward / k.vertical_east_asian / k.vertical / k.horizontal_rotated_east_asian -- Returns or sets the text orientation.
      • path_format k.path_type_unset / k.no_path_type / k.path_type1 / k.path_type2 / k.path_type3 / k.path_type4 -- Returns or sets the path type for the specified text frame.
      • ruler (r/o) ruler
      • text_column (r/o) text_column -- Returns the text column object that represents the columns within the text frame.
      • text_range (r/o) text_range
      • threeD_format (r/o) threeD_format -- Returns the 3-D-effect formatting properties for the specified text.
      • vertical_anchor k.vertical_anchor_unset / k.anchor_top / k.anchor_top_baseline / k.anchor_middle / k.anchor_bottom / k.anchor_bottom_baseline
      • warp_format k.warp_format_unset / k.warp_format1 / k.warp_format2 / k.warp_format3 / k.warp_format4 / k.warp_format5 / k.warp_format6 / k.warp_format7 / k.warp_format8 / k.warp_format9 / k.warp_format10 / k.warp_format11 / k.warp_format12 / k.warp_format13 / k.warp_format14 / k.warp_format15 / k.warp_format16 / k.warp_format17 / k.warp_format18 / k.warp_format19 / k.warp_format20 / k.warp_format21 / k.warp_format22 / k.warp_format23 / k.warp_format24 / k.warp_format25 / k.warp_format26 / k.warp_format27 / k.warp_format28 / k.warp_format29 / k.warp_format30 / k.warp_format31 / k.warp_format32 / k.warp_format33 / k.warp_format34 / k.warp_format35 / k.warp_format36 -- Returns or sets the warp type for the specified text frame.
      • word_art_styles_format (r/o) k.wordart_format_unset / k.wordart_format1 / k.wordart_format2 / k.wordart_format3 / k.wordart_format4 / k.wordart_format5 / k.wordart_format6 / k.wordart_format7 / k.wordart_format8 / k.wordart_format9 / k.wordart_format10 / k.wordart_format11 / k.wordart_format12 / k.wordart_format13 / k.wordart_format14 / k.wordart_format15 / k.wordart_format16 / k.wordart_format17 / k.wordart_format18 / k.wordart_format19 / k.wordart_format20 / k.wordart_format21 / k.wordart_format22 / k.wordart_format23 / k.wordart_format24 / k.wordart_format25 / k.wordart_format26 / k.wordart_format27 / k.wordart_format28 / k.wordart_format29 / k.wordart_format30 -- Returns or sets a value specifying the text effect for the selected text.
      • word_wrap boolean -- Returns or sets text break lines within or past the boundaries of the shape.
      • wordart_auto_size k.auto_size_unset / k.auto_size_none / k.shape_to_fit_text / k.text_to_fit_shape -- The size of the specified object that changes automatically to fit text within its boundaries.
      • wordart_format k.wordart_format_unset / k.wordart_format1 / k.wordart_format2 / k.wordart_format3 / k.wordart_format4 / k.wordart_format5 / k.wordart_format6 / k.wordart_format7 / k.wordart_format8 / k.wordart_format9 / k.wordart_format10 / k.wordart_format11 / k.wordart_format12 / k.wordart_format13 / k.wordart_format14 / k.wordart_format15 / k.wordart_format16 / k.wordart_format17 / k.wordart_format18 / k.wordart_format19 / k.wordart_format20 / k.wordart_format21 / k.wordart_format22 / k.wordart_format23 / k.wordart_format24 / k.wordart_format25 / k.wordart_format26 / k.wordart_format27 / k.wordart_format28 / k.wordart_format29 / k.wordart_format30 -- Returns or sets the WordArt type for the specified text frame.
  • shape_textbox
    • Plural name:
      • shape_textboxes
    • Inherits from:
    • Properties:
      • text_orientation (r/o) k.text_orientation_unset / k.horizontal / k.upward / k.downward / k.vertical_east_asian / k.vertical / k.horizontal_rotated_east_asian -- Returns the text orientation of the object.
  • shape -- Represents an object in the drawing layer.
    • Plural name:
      • shapes
    • Inherits from:
    • Inherited by:
    • Properties:
      • alternative_text unicode_text -- Returns or sets the descriptive alternative text string for a Shape object when the object is saved to a Web page.
      • auto_shape_type k.autoshape_shape_type_unset / k.autoshape_rectangle / k.autoshape_parallelogram / k.autoshape_trapezoid / k.autoshape_diamond / k.autoshape_rounded_rectangle / k.autoshape_octagon / k.autoshape_isosceles_triangle / k.autoshape_right_triangle / k.autoshape_oval / k.autoshape_hexagon / k.autoshape_cross / k.autoshape_regular_pentagon / k.autoshape_can / k.autoshape_cube / k.autoshape_bevel / k.autoshape_folded_corner / k.autoshape_smiley_face / k.autoshape_donut / k.autoshape_no_symbol / k.autoshape_block_arc / k.autoshape_heart / k.autoshape_lightning_bolt / k.autoshape_sun / k.autoshape_moon / k.autoshape_arc / k.autoshape_double_bracket / k.autoshape_double_brace / k.autoshape_plaque / k.autoshape_left_bracket / k.autoshape_right_bracket / k.autoshape_left_brace / k.autoshape_right_brace / k.autoshape_right_arrow / k.autoshape_left_arrow / k.autoshape_up_arrow / k.autoshape_down_arrow / k.autoshape_left_right_arrow / k.autoshape_up_down_arrow / k.autoshape_quad_arrow / k.autoshape_left_right_up_arrow / k.autoshape_bent_arrow / k.autoshape_U_turn_arrow / k.autoshape_left_up_arrow / k.autoshape_bent_up_arrow / k.autoshape_curved_right_arrow / k.autoshape_curved_left_arrow / k.autoshape_curved_up_arrow / k.autoshape_curved_down_arrow / k.autoshape_striped_right_arrow / k.autoshape_notched_right_arrow / k.autoshape_pentagon / k.autoshape_chevron / k.autoshape_right_arrow_callout / k.autoshape_left_arrow_callout / k.autoshape_up_arrow_callout / k.autoshape_down_arrow_callout / k.autoshape_left_right_arrow_callout / k.autoshape_up_down_arrow_callout / k.autoshape_quad_arrow_callout / k.autoshape_circular_arrow / k.autoshape_flowchart_process / k.autoshape_flowchart_alternate_process / k.autoshape_flowchart_decision / k.autoshape_flowchart_data / k.autoshape_flowchart_predefined_process / k.autoshape_flowchart_internal_storage / k.autoshape_flowchart_document / k.autoshape_flowchart_multi_document / k.autoshape_flowchart_terminator / k.autoshape_flowchart_preparation / k.autoshape_flowchart_manual_input / k.autoshape_flowchart_manual_operation / k.autoshape_flowchart_connector / k.autoshape_flowchart_offpage_connector / k.autoshape_flowchart_card / k.autoshape_flowchart_punched_tape / k.autoshape_flowchart_summing_junction / k.autoshape_flowchart_or / k.autoshape_flowchart_collate / k.autoshape_flowchart_sort / k.autoshape_flowchart_extract / k.autoshape_flowchart_merge / k.autoshape_flowchart_stored_data / k.autoshape_flowchart_delay / k.autoshape_flowchart_sequential_access_storage / k.autoshape_flowchart_magnetic_disk / k.autoshape_flowchart_direct_access_storage / k.autoshape_flowchart_display / k.autoshape_explosion_one / k.autoshape_explosion_two / k.autoshape_four_point_star / k.autoshape_five_point_star / k.autoshape_eight_point_star / k.autoshape_sixteen_point_star / k.autoshape_twenty_four_point_star / k.autoshape_thirty_two_point_star / k.autoshape_up_ribbon / k.autoshape_down_ribbon / k.autoshape_curved_up_ribbon / k.autoshape_curved_down_ribbon / k.autoshape_vertical_scroll / k.autoshape_horizontal_scroll / k.autoshape_wave / k.autoshape_double_wave / k.autoshape_rectangular_callout / k.autoshape_rounded_rectangular_callout / k.autoshape_oval_callout / k.autoshape_cloud_callout / k.autoshape_line_callout_one / k.autoshape_line_callout_two / k.autoshape_line_callout_three / k.autoshape_line_callout_four / k.autoshape_line_callout_one_accent_bar / k.autoshape_line_callout_two_accent_bar / k.autoshape_line_callout_three_accent_bar / k.autoshape_line_callout_four_accent_bar / k.autoshape_line_callout_one_no_border / k.autoshape_line_callout_two_no_border / k.autoshape_line_callout_three_no_border / k.autoshape_line_callout_four_no_border / k.autoshape_callout_one_border_and_accent_bar / k.autoshape_callout_two_border_and_accent_bar / k.autoshape_callout_three_border_and_accent_bar / k.autoshape_callout_four_border_and_accent_bar / k.autoshape_action_button_custom / k.autoshape_action_button_home / k.autoshape_action_button_help / k.autoshape_action_button_information / k.autoshape_action_button_back_or_previous / k.autoshape_action_button_forward_or_next / k.autoshape_action_button_beginning / k.autoshape_action_button_end / k.autoshape_action_button_return / k.autoshape_action_button_document / k.autoshape_action_button_sound / k.autoshape_action_button_movie / k.autoshape_balloon / k.autoshape_not_primitive / k.autoshape_flowchart_offline_storage / k.autoshape_left_right_ribbon / k.autoshape_diagonal_stripe / k.autoshape_pie / k.autoshape_non_isosceles_trapezoid / k.autoshape_Decagon / k.autoshape_Heptagon / k.autoshape_Dodecagon / k.autoshape_six_points_star / k.autoshape_seven_points_star / k.autoshape_ten_points_star / k.autoshape_twelve_points_star / k.autoshape_round_one_rectangle / k.autoshape_round_two_same_rectangle / k.autoshape_round_two_diagonal_rectangle / k.autoshape_snip_round_rectangle / k.autoshape_snip_one_rectangle / k.autoshape_snip_two_same_rectangle / k.autoshape_snip_two_diagonal_rectangle / k.autoshape_frame / k.autoshape_half_frame / k.autoshape_tear / k.autoshape_chord / k.autoshape_corner / k.autoshape_math_plus / k.autoshape_math_minus / k.autoshape_math_multiply / k.autoshape_math_divide / k.autoshape_math_equal / k.autoshape_math_not_equal / k.autoshape_corner_tabs / k.autoshape_square_tabs / k.autoshape_plaque_tabs / k.autoshape_gear_six / k.autoshape_gear_nine / k.autoshape_funnel / k.autoshape_pie_wedge / k.autoshape_left_circular_arrow / k.autoshape_left_right_circular_arrow / k.autoshape_swoosh_arrow / k.autoshape_cloud / k.autoshape_chart_x / k.autoshape_chart_star / k.autoshape_chart_plus / k.autoshape_line_inverse -- Returns or sets the shape type for the specified shape object, which must represent an auto-shape.
      • background_style k.background_unset / k.background_not_a_preset / k.background_preset1 / k.background_preset2 / k.background_preset3 / k.background_preset4 / k.background_preset5 / k.background_preset6 / k.background_preset7 / k.background_preset8 / k.background_preset9 / k.background_preset10 / k.background_preset11 / k.background_preset12 -- Returns or sets the background style.
      • black_white_mode k.black_and_white_unset / k.black_and_white_mode_automatic / k.black_and_white_mode_gray_scale / k.black_and_white_mode_light_gray_scale / k.black_and_white_mode_inverse_gray_scale / k.black_and_white_mode_gray_outline / k.black_and_white_mode_black_text_and_line / k.black_and_white_mode_high_contrast / k.black_and_white_mode_black / k.black_and_white_mode_white / k.black_and_white_mode_dont_show -- Returns or sets a value that indicates how the specified shape appears when the presentation is viewed in black-and-white mode.
      • bottom_right_cell (r/o) range -- Returns a range object that represents the cell that lies under the lower-right corner of the object.
      • chart (r/o) chart -- Returns a chart object that represents the chart contained in the shape.
      • child (r/o) boolean -- True if the shape is a child shape.
      • connection_site_count (r/o) integer -- Returns the number of connection sites on the specified shape.
      • connector (r/o) boolean -- Returns true if the specified shape is a connector.
      • connector_format (r/o) connector_format -- Returns a connector format object that contains connector formatting properties if this shape is a connector.
      • connector_type (r/o) k.connector_type_unset / k.straight / k.elbow / k.curve -- Returns the connector type if this shape is a connector.
      • fill_format (r/o) fill_format -- Returns a fill format object that contains fill formatting properties for the specified shape.
      • glow_format (r/o) glow_format -- Returns the formatting properties for a glow effect.
      • has_chart (r/o) boolean -- True if the specified shape has a chart.
      • height short_float -- Returns or sets the height of the object.
      • horizontal_flip (r/o) boolean -- Returns true if the specified shape is flipped around the horizontal axis.
      • hyperlink (r/o) hyperlink -- Returns a hyperlink object that represents the hyperlink for the shape.
      • left_position short_float -- Returns or sets the left position of the specified object, in points.
      • line_format (r/o) line_format -- Returns a line format object for this shape.
      • lock_aspect_ratio boolean -- Returns or sets if the specified shape retains its original proportions when you resize it. If false, you can change the height and width of the shape independently of one another when you resize it.
      • locked boolean -- Returns or sets if the object is locked. If false, the object can be modified when the sheet is protected.
      • name unicode_text -- Returns or sets the name of the object.
      • parentgroup (r/o) shape -- Returns a Shape object that represents the common parent shape of a child shape or a range of child shapes.
      • placement k.placement_free_floating / k.placement_move / k.placement_move_and_size -- Returns or sets how the object is placed on the worksheet.
      • reflection_format (r/o) reflection_format -- Returns the formatting properties for a reflection effect.
      • rotation_ short_float -- Returns or sets the rotation of the shape, in degrees.
      • shadow_format (r/o) shadow_format -- Returns a shadow format object for this shape.
      • shape_on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • shape_style k.shape_style_unset / k.shape_not_a_preset / k.shape_preset1 / k.shape_preset2 / k.shape_preset3 / k.shape_preset4 / k.shape_preset5 / k.shape_preset6 / k.shape_preset7 / k.shape_preset8 / k.shape_preset9 / k.shape_preset10 / k.shape_preset11 / k.shape_preset12 / k.shape_preset13 / k.shape_preset14 / k.shape_preset15 / k.shape_preset16 / k.shape_preset17 / k.shape_preset18 / k.shape_preset19 / k.shape_preset20 / k.shape_preset21 / k.shape_preset22 / k.shape_preset23 / k.shape_preset24 / k.shape_preset25 / k.shape_preset26 / k.shape_preset27 / k.shape_preset28 / k.shape_preset29 / k.shape_preset30 / k.shape_preset31 / k.shape_preset32 / k.shape_preset33 / k.shape_preset34 / k.shape_preset35 / k.shape_preset36 / k.shape_preset37 / k.shape_preset38 / k.shape_preset39 / k.shape_preset40 / k.shape_preset41 / k.shape_preset42 / k.line_preset1 / k.line_preset2 / k.line_preset3 / k.line_preset4 / k.line_preset5 / k.line_preset6 / k.line_preset7 / k.line_preset8 / k.line_preset9 / k.line_preset10 / k.line_preset11 / k.line_preset12 / k.line_preset13 / k.line_preset14 / k.line_preset15 / k.line_preset16 / k.line_preset17 / k.line_preset18 / k.line_preset19 / k.line_preset20 / k.line_preset21 -- Returns or sets the shape style corresponding to the Quick Styles.
      • shape_text_frame (r/o) shape_text_frame -- Returns a shape text frame object that contains the alignment and anchoring properties for the specified shape.
      • shape_type (r/o) k.shape_type_unset / k.shape_type_auto / k.shape_type_callout / k.shape_type_chart / k.shape_type_comment / k.shape_type_free_form / k.shape_type_group / k.shape_type_embedded_OLE_control / k.shape_type_form_control / k.shape_type_line / k.shape_type_linked_OLE_object / k.shape_type_linked_picture / k.shape_type_OLE_control / k.shape_type_picture / k.shape_type_place_holder / k.shape_type_word_art / k.shape_type_media / k.shape_type_text_box / k.shape_type_table / k.shape_type_canvas / k.shape_type_diagram / k.shape_type_ink / k.shape_type_ink_comment / k.shape_type_smartart_graphic / k.shape_type_slicer -- Returns the shape type.
      • soft_edge_format (r/o) soft_edge_format -- Returns the formatting properties for a soft edge effect.
      • text_frame (r/o) text_frame -- Returns a text frame object that contains the alignment and anchoring properties for the specified shape.
      • threeD_format (r/o) threeD_format -- Returns a threeD format object that contains 3-D-effect formatting properties for the specified shape.
      • top short_float -- Returns or sets the top position of the specified object, in points.
      • top_left_cell (r/o) range -- Returns a range object that represents the cell that lies under the upper-left corner of the specified object.
      • vertical_flip (r/o) boolean -- Returns true if the specified shape is flipped around the vertical axis.
      • visible boolean -- Returns or sets if the object is visible
      • width short_float -- Returns or sets the width of the object.
      • word_art_format (r/o) word_art_format -- Returns the formatting properties for a word art effect.
      • z_order_position (r/o) integer -- Returns the position of the specified shape in the z-order. To set the shape's position in the z-order, use the z order method.
    • Elements:
  • soft_edge_format -- Represents the soft edge formatting for a shape or range of shapes
    • Inherits from:
    • Properties:
      • soft_edge_type k.soft_edge_unset / k.no_soft_edge / k.soft_edge_type1 / k.soft_edge_type2 / k.soft_edge_type3 / k.soft_edge_type4 / k.soft_edge_type5 / k.soft_edge_type6 -- Returns or sets the type soft edge format object.
  • tab_stop -- Represents a single tab stop.
    • Plural name:
      • tab_stops
    • Inherits from:
    • Properties:
      • tab_position short_float -- Returns or sets the position of a tab stop relative to the left margin.
      • tab_stop_type k.tabstop_unset / k.tabstop_left / k.tabstop_center / k.tabstop_right / k.tabstop_decimal -- Returns or sets the type of the tab stop object.
  • text_column -- Represents a single text column.
    • Inherits from:
    • Properties:
      • column_number integer -- Returns or sets the index of the text column object.
      • spacing short_float -- Returns or sets the spacing between text columns in a text column object.
      • text_direction AEType("mTxD") -- Returns or sets the direction of text in the text column object.
  • text_frame -- Represents the text frame in a shape object. Contains the text in the text frame as well as the properties and methods that control the alignment and anchoring of the text frame.
    • Plural name:
      • text_frames
    • Inherits from:
    • Properties:
      • auto_margins boolean -- Returns or sets if Microsoft Excel automatically calculates text frame margins.
      • auto_size boolean -- Returns or sets if the size of the specified object is changed automatically to fit text within its boundaries.
      • horizontal_alignment k.horizontal_align_center / k.horizontal_align_center_across_selection / k.horizontal_align_distributed / k.horizontal_align_fill / k.horizontal_align_general / k.horizontal_align_justify / k.horizontal_align_left / k.horizontal_align_right -- Returns or sets the horizontal alignment for the object.
      • horizontal_overflow k.overflow / k.clip -- Returns or sets the horizontal overflow.
      • margin_bottom short_float -- Returns or sets the distance, in points, between the bottom of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.
      • margin_left short_float -- Returns or sets the distance, in points, between the left edge of the text frame and the left edge of the inscribed rectangle of the shape that contains the text.
      • margin_right short_float -- Returns or sets the distance, in points, between the right edge of the text frame and the right edge of the inscribed rectangle of the shape that contains the text.
      • margin_top short_float -- Returns or sets the distance, in points, between the top of the text frame and the top of the inscribed rectangle of the shape that contains the text.
      • orientation k.text_orientation_unset / k.horizontal / k.upward / k.downward / k.vertical_east_asian / k.vertical / k.horizontal_rotated_east_asian -- Returns or sets the text orientation.
      • reading_order k.left_to_right / k.right_to_left / k.context -- Returns or sets the reading order for the specified object.
      • vertical_alignment k.valign_bottom / k.valign_center / k.valign_distributed / k.valign_justify / k.valign_top -- Returns or sets the vertical alignment of the object.
      • vertical_overflow k.overflow / k.clip / k.ellipsis -- Returns or sets the vertical overflow.
      • wrap_auto_text boolean -- Returns or sets if the auto text is wrapped.
    • Elements:
  • theme_color_scheme -- Represents the color scheme of an Office Theme
  • theme_color -- Represents a color in the color scheme of a Microsoft Office 2007 theme.
    • Inherits from:
    • Properties:
      • RGB RGB_color -- Returns or sets a value of a color in the color scheme of a Microsoft Office theme.
      • theme_color_scheme_index (r/o) k.first_dark_scheme_color / k.first_light_scheme_color / k.second_dark_scheme_color / k.second_light_scheme_color / k.first_accent_scheme_color / k.second_accent_scheme_color / k.third_accent_scheme_color / k.fourth_accent_scheme_color / k.fifth_accent_scheme_color / k.sixth_accent_scheme_color / k.hyperlink_scheme_color / k.followed_hyperlink_scheme_color -- Returns the index value a color scheme of a Microsoft Office theme.
  • theme_effect_scheme -- Represents the effect scheme of a Microsoft Office theme.
  • theme_font_scheme -- Represents the font scheme of a Microsoft Office theme.
  • theme_font -- Represents a container for the font schemes of a Microsoft Office theme.
  • threeD_format -- Represents a shape's three-dimensional formatting.
    • Plural name:
      • threeD_formats
    • Inherits from:
    • Properties:
      • Z_distance short_float -- Returns or sets a Single that represents the distance from the center of an object or text.
      • bevel_bottom_depth short_float -- Returns or sets the depth/height of the bottom bevel.
      • bevel_bottom_inset short_float -- Returns or sets the inset size/width for the bottom bevel.
      • bevel_bottom_type k.bevel_type_unset / k.bevel_none / k.bevel_relaxed_inset / k.bevel_circle / k.bevel_slope / k.bevel_cross / k.bevel_angle / k.bevel_soft_round / k.bevel_convex / k.bevel_cool_slant / k.bevel_divot / k.bevel_riblet / k.bevel_hard_edge / k.bevel_art_deco -- Returns or sets the bevel type for the bottom bevel.
      • bevel_top_depth short_float -- Returns or sets the depth/height of the top bevel.
      • bevel_top_inset short_float -- Returns or sets the inset size/width for the top bevel.
      • bevel_top_type k.bevel_type_unset / k.bevel_none / k.bevel_relaxed_inset / k.bevel_circle / k.bevel_slope / k.bevel_cross / k.bevel_angle / k.bevel_soft_round / k.bevel_convex / k.bevel_cool_slant / k.bevel_divot / k.bevel_riblet / k.bevel_hard_edge / k.bevel_art_deco -- Returns or sets the bevel type for the top bevel.
      • contour_color (r/o) RGB_color -- Returns or sets the color of the contour of an object or text.
      • contour_color_theme_index k.theme_color_unset / k.no_theme_color / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color / k.first_text_theme_color / k.first_background_theme_color / k.second_text_theme_color / k.second_background_theme_color -- Returns or sets the color for the specified contour.
      • contour_width short_float -- Returns or sets the width of the contour of an object or text.
      • depth short_float -- Returns or sets the depth of the shape's extrusion.
      • extrusion_color (r/o) RGB_color -- Returns or sets a RGB color that represents the color of the shape's extrusion.
      • extrusion_color_theme_index k.theme_color_unset / k.no_theme_color / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color / k.first_text_theme_color / k.first_background_theme_color / k.second_text_theme_color / k.second_background_theme_color -- Returns or sets the color for the specified extrusion.
      • extrusion_color_type k.extrusion_color_unset / k.extrusion_color_automatic / k.extrusion_color_custom -- Returns or sets a value that indicates what will determine the extrusion color.
      • field_of_view short_float -- Returns or sets the amount of perspective for an object or text.
      • light_angle short_float -- Returns or sets the angle of the lighting.
      • perspective boolean -- Returns or sets if the extrusion appears in perspective that is, if the walls of the extrusion narrow toward a vanishing point. If false, the extrusion is a parallel, or orthographic, projection that is, if the walls don't narrow toward a vanishing point.
      • preset_camera (r/o) k.preset_camera_unset / k.camera_legacy_oblique_from_top_left / k.camera_legacy_oblique_from_top / k.camera_legacy_oblique_from_topright / k.camera_legacy_oblique_from_left / k.camera_legacy_oblique_from_front / k.camera_legacy_oblique_from_right / k.camera_legacy_oblique_from_bottom_left / k.camera_legacy_oblique_from_bottom / k.camera_legacy_oblique_from_bottom_right / k.camera_legacy_perspective_from_top_left / k.camera_legacy_perspective_from_top / k.camera_legacy_perspective_from_top_right / k.camera_legacy_perspective_from_left / k.camera_legacy_perspective_from_front / k.camera_legacy_perspective_from_right / k.camera_legacy_perspective_from_bottom_left / k.camera_legacy_perspective_from_bottom / k.camera_legacy_perspective_from_bottom_right / k.camera_orthographic / k.camera_isometric_from_top_up / k.camera_isometric_from_top_down / k.camera_isometric_from_bottom_up / k.camera_isometric_from_bottom_down / k.camera_isometric_from_left_up / k.camera_isometric_from_left_down / k.camera_isometric_from_right_up / k.camera_isometric_from_right_down / k.camera_isometric_off_axis1_from_left / k.camera_isometric_off_axis1_from_right / k.camera_isometric_off_axis1_from_top / k.camera_isometric_off_axis2_from_left / k.camera_isometric_off_axis2_from_right / k.camera_isometric_off_axis2_from_top / k.camera_isometric_off_axis3_from_left / k.camera_isometric_off_axis3_from_right / k.camera_isometric_off_axis3_from_bottom / k.camera_isometric_off_axis4_from_left / k.camera_isometric_off_axis4_from_right / k.camera_isometric_off_axis4_from_bottom / k.camera_oblique_from_top_left / k.camera_oblique_from_top / k.camera_oblique_from_top_right / k.camera_oblique_from_left / k.camera_oblique_from_right / k.camera_oblique_from_bottom_left / k.camera_oblique_from_bottom / k.camera_oblique_from_bottom_right / k.camera_perspective_from_front / k.camera_perspective_from_left / k.camera_perspective_from_right / k.camera_perspective_from_above / k.camera_perspective_from_below / k.camera_perspective_from_above_facing_left / k.camera_perspective_from_above_facing_right / k.camera_perspective_contrasting_facing_left / k.camera_perspective_contrasting_facing_right / k.camera_perspective_heroic_facing_left / k.camera_perspective_heroic_facing_right / k.camera_perspective_heroic_extreme_facing_left / k.camera_perspective_heroic_extreme_facing_right / k.camera_perspective_relaxed / k.camera_perspective_relaxed_moderately -- Returns a constant that represents the camera preset.
      • preset_extrusion_direction (r/o) k.preset_extrusion_direction_unset / k.extrude_bottom_right / k.extrude_bottom / k.extrude_bottom_left / k.extrude_right / k.extrude_none / k.extrude_left / k.extrude_top_right / k.extrude_top / k.extrude_top_left -- Returns or sets the direction taken by the extrusion's sweep path leading away from the extruded shape, the front face of the extrusion.
      • preset_lighting_direction k.preset_lighting_direction_unset / k.light_from_top_left / k.light_from_top / k.light_from_top_right / k.light_from_left / k.light_from_none / k.light_from_right / k.light_from_bottom_left / k.light_from_bottom / k.light_from_bottom_right -- Returns or sets the position of the light source relative to the extrusion.
      • preset_lighting_rig k.light_rig_unset / k.light_rig_flat1 / k.light_rig_flat2 / k.light_rig_flat3 / k.light_rig_flat4 / k.light_rig_Normal1 / k.light_rig_Normal2 / k.light_rig_Normal3 / k.light_rig_Normal4 / k.light_rig_Harsh1 / k.light_rig_Harsh2 / k.light_rig_Harsh3 / k.light_rig_Harsh4 / k.light_rig_three_point / k.light_rig_balanced / k.light_rig_soft / k.light_rig_harsh / k.light_rig_flood / k.light_rig_contrasting / k.light_rig_morning / k.light_rig_sunrise / k.light_rig_sunset / k.light_rig_chilly / k.light_rig_freezing / k.light_rig_flat / k.light_rig_two_point / k.light_rig_glow / k.light_rig_bright_room -- Returns a constant that represents the lighting preset.
      • preset_lighting_softness k.lighting_softness_unset / k.lighting_dim / k.lighting_normal / k.lighting_bright -- Returns or sets the intensity of the extrusion lighting.
      • preset_material k.preset_material_unset / k.matte / k.plastic / k.metal / k.wireframe / k.matte2 / k.plastic2 / k.metal2 / k.warm_matte / k.translucent_powder / k.powder / k.dark_edge / k.soft_edge / k.material_clear / k.flat / k.soft_metal -- Returns or sets the extrusion surface material.
      • preset_threeD_format (r/o) k.preset_threeD_format_unset / k.format1 / k.format2 / k.format3 / k.format4 / k.format5 / k.format6 / k.format7 / k.format8 / k.format9 / k.format10 / k.format11 / k.format12 / k.format13 / k.format14 / k.format15 / k.format16 / k.format17 / k.format18 / k.format19 / k.format20
      • project_text boolean -- Returns or sets whether text on a shape rotates with shape.
      • rotation_X short_float -- Returns or sets the rotation of the extruded shape around the x-axis in degrees. A positive value indicates upward rotation; a negative value indicates downward rotation.
      • rotation_Y short_float -- Returns or sets the rotation of the extruded shape around the y-axis, in degrees. A positive value indicates rotation to the left; a negative value indicates rotation to the right.
      • rotation_Z short_float -- Returns or sets the rotation of the extruded shape around the z-axis, in degrees. A positive value indicates clockwise rotation; a negative value indicates anti-clockwise rotation.
      • visible boolean -- Returns or sets if the specified object, or the formatting applied to it, is visible.
  • word_art_format -- Contains properties and methods that apply to WordArt objects.
    • Plural name:
      • word_art_formats
    • Inherits from:
    • Properties:
      • alignment k.text_effect_alignment_unset / k.left_text_effect_alignment / k.centered_text_effect_alignment / k.right_text_effect_alignment / k.justify_text_effect_alignment / k.word_justify_text_effect_alignment / k.stretch_justify_text_effect_alignment -- Returns or sets a constant that represents the alignment for the specified text effect.
      • bold boolean -- Returns if the text of the word art shape is formatted as bold.
      • font_name unicode_text -- Returns or sets the font name of the font used by this word art shape.
      • font_size short_float -- Returns or sets the font size of the font used by this word art shape.
      • italic boolean -- Returns if the text of the word art shape is formatted as italic.
      • kerned_pairs boolean -- Returns or sets if character pairs in a WordArt object have been kerned.
      • normalized_height boolean -- Returns or sets if all characters, both uppercase and lowercase, in the specified WordArt are the same height.
      • preset_shape k.text_effect_shape_unset / k.plain_text / k.stop / k.triangle_up / k.triangle_down / k.chevron_up / k.chevron_down / k.ring_inside / k.ring_outside / k.arch_up_curve / k.arch_down_curve / k.circle_curve / k.button_curve / k.arch_up_pour / k.arch_down_pour / k.circle_pour / k.button_pour / k.curve_up / k.curve_down / k.can_up / k.can_down / k.wave1 / k.wave2 / k.double_wave1 / k.double_wave2 / k.inflate / k.deflate / k.inflate_bottom / k.deflate_bottom / k.inflate_top / k.deflate_top / k.deflate_inflate / k.deflate_inflate_deflate / k.fade_right / k.fade_left / k.fade_up / k.fade_down / k.slant_up / k.slant_down / k.cascade_up / k.cascade_down -- Returns or sets the shape of the specified WordArt.
      • preset_word_art_effect k.wordart_format_unset / k.wordart_format1 / k.wordart_format2 / k.wordart_format3 / k.wordart_format4 / k.wordart_format5 / k.wordart_format6 / k.wordart_format7 / k.wordart_format8 / k.wordart_format9 / k.wordart_format10 / k.wordart_format11 / k.wordart_format12 / k.wordart_format13 / k.wordart_format14 / k.wordart_format15 / k.wordart_format16 / k.wordart_format17 / k.wordart_format18 / k.wordart_format19 / k.wordart_format20 / k.wordart_format21 / k.wordart_format22 / k.wordart_format23 / k.wordart_format24 / k.wordart_format25 / k.wordart_format26 / k.wordart_format27 / k.wordart_format28 / k.wordart_format29 / k.wordart_format30 -- Returns or sets the style of the specified WordArt.
      • rotated_chars boolean -- Returns or sets if characters in the specified WordArt are rotated 90 degrees relative to the WordArt's bounding shape. If false, characters in the specified WordArt retain their original orientation relative to the bounding shape.
      • tracking short_float -- Returns or sets the ratio of the horizontal space allotted to each character in the specified WordArt in relation to the width of the character. Can be a value from zero through 5.
      • word_art_text unicode_text -- Returns or sets the text associated with this word art shape.

Text Suite

Classes and types for scripting text manipulations

Commands

  • add_periods_to -- Adds period punctuation to the end of the text contained in text range object.
  • change_case -- Changes the case of a text range object.
    • text_range
    • to k.case_sentence / k.case_lower / k.case_upper / k.case_title / k.case_toggle
  • copy_text_range -- Copies a text range object.
  • cut_text_range -- Removes a portion or all of the text from a range of text.
  • get_border -- Returns the specified border object.
    • style
    • which_border k.inside_horizontal / k.inside_vertical / k.diagonal_down / k.diagonal_up / k.edge_bottom / k.edge_left / k.edge_right / k.edge_top / k.border_bottom / k.border_left / k.border_right / k.border_top -- This specifies which border object should be retrieved.
    • Result: border
  • get_rotated_text_bounds -- Returns back a list containing the four point of the text bounds as follows {x1, y1}, {x2, y2}, {x3, y3}, {x4, y4} }
  • insert_into -- Inserts a string preceding the selected characters.
    • character
    • string_ unicode_text -- The string to insert.
  • insert_text_text_range -- Adds new text to the text range object.
    • text_range
    • insert_where k.insert_before / k.insert_after -- Sets whether the text will be inserted before or after the text range.
    • new_text unicode_text -- Contains the text to be inserted.
  • paste_text_range -- Pastes the contents of the Clipboard into the text range object.
  • remove_periods_from -- Removes all period punctuation from the text in the text range object.

Classes

  • character -- Represents characters in an object that contains text.
    • Plural name:
      • characters
    • Inherits from:
    • Properties:
      • content unicode_text -- Returns or sets the text for the specified object.
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • phonetic_characters unicode_text -- Returns or sets the phonetic text in the specified characters object.
  • font -- Contains font attributes, such as font name, size, and color, for an object.
    • Plural name:
      • fonts
    • Inherits from:
    • Properties:
      • bold boolean -- Returns or sets if the font is formatted as bold.
      • color RGB_color -- Returns or sets the color for the font.
      • font_background k.background_automatic / k.background_opaque / k.background_transparent -- Returns or sets the text background type.
      • font_color_index k.color_index_automatic / k.color_index_none / k.a_color_index_integer -- Returns or sets the color index of the font.
      • font_size integer -- Returns or sets the font size.
      • font_style unicode_text -- Returns or sets the font style.
      • italic boolean -- Returns or sets if the font is formatted as italic.
      • name unicode_text -- Returns or sets the font name associated with this font object.
      • outline_font boolean -- Returns or sets if the specified font is formatted as outline.
      • shadow boolean -- Returns or sets if the specified font is formatted as shadowed.
      • strikethrough boolean -- Returns or sets if the font is formatted as strikethrough text.
      • subscript boolean -- Returns or sets if the font is formatted as subscript.
      • superscript boolean -- Returns or sets if the font is formatted as superscript.
      • theme_color k.color_index_none / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color -- Returns or sets the theme color in the applied color scheme that is associated with the specified object.
      • theme_font_index k.theme_font_index_none / k.theme_font_index_major / k.theme_font_index_minor -- Returns or sets the theme font in the applied font scheme that is associated with the specified object.
      • tint_and_shade float -- Returns or sets a Single that lightens or darkens a color.
      • underline k.underline_style_double / k.underline_style_double_accounting / k.underline_style_none / k.underline_style_single / k.underline_style_single_accounting -- Returns or sets the type of underline applied to the font.
  • paragraph
    • Plural name:
      • paragraphs
    • Inherits from:
  • sentence
    • Plural name:
      • sentences
    • Inherits from:
  • style -- Represents a style description for a range.
    • Plural name:
      • styles
    • Inherits from:
    • Properties:
      • add_indent boolean -- Returns or sets if text is automatically indented when the text alignment in a cell is set to equal distribution either horizontally or vertically.
      • built_in (r/o) boolean -- Returns true if the style is a built-in style.
      • font_object (r/o) font -- Returns the font object associated with this style.
      • formula_hidden boolean -- Returns or sets if the formula will be hidden when the worksheet is protected.
      • horizontal_alignment k.horizontal_align_center / k.horizontal_align_center_across_selection / k.horizontal_align_distributed / k.horizontal_align_fill / k.horizontal_align_general / k.horizontal_align_justify / k.horizontal_align_left / k.horizontal_align_right -- Returns or sets the horizontal alignment for the object.
      • include_alignment boolean -- Returns or sets if the style includes the add indent, horizontal alignment, vertical alignment, wrap text, and orientation properties.
      • include_border boolean -- Returns or sets if the style includes the color, color index, line style, and weight border properties.
      • include_font boolean -- Returns or sets if the style includes the background, bold, color, color index, font style, italic, name, outline font, shadow, size, strikethrough, subscript, superscript, and underline font properties.
      • include_number boolean -- Returns or sets if the style includes the number format property.
      • include_patterns boolean -- Returns or sets if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern color index interior properties.
      • include_protection boolean -- Returns or sets if the style includes the formula hidden and locked protection properties.
      • indent_level integer -- Returns or sets the indent level for the style. Can be an integer from 0 to 15.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified style.
      • locked boolean -- Returns or sets if the range using this style is locked.
      • merged_cells boolean -- Returns true if the style contains merged cells.
      • name (r/o) unicode_text -- Returns the name of the style.
      • name_local (r/o) unicode_text -- Returns the name of the style, in the language of the user.
      • number_format unicode_text -- Returns or sets the format code for the object.
      • number_format_local unicode_text -- Returns or sets the format code for the object as a string in the language of the user.
      • orientation k.orientation_downward / k.orientation_horizontal / k.orientation_upward / k.orientation_vertical -- May also be a number value from -90 to 90 degrees.
      • reading_order k.left_to_right / k.right_to_left / k.context -- Returns or sets the reading order for the specified object.
      • shrink_to_fit boolean -- Returns or sets if text automatically shrinks to fit in the available column width.
      • value (r/o) unicode_text -- Return the name of the specified style.
      • vertical_alignment k.valign_bottom / k.valign_center / k.valign_distributed / k.valign_justify / k.valign_top -- Returns or sets the vertical alignment of the style.
      • wrap_text boolean -- Returns or sets if Microsoft Excel wraps the text in the object.
  • text_flow
    • Plural name:
      • text_flows
    • Inherits from:
  • text_range_character
    • Plural name:
      • text_range_characters
    • Inherits from:
  • text_range_line
    • Plural name:
      • text_range_lines
    • Inherits from:
  • text_range -- Represents the text frame in a shape object.
    • Inherits from:
    • Inherited by:
    • Properties:
      • bound_height (r/o) short_float -- Returns the height, in points, of the text bounding box for the specified text.
      • bound_left (r/o) short_float -- Returns the left coordinate, in points, of the text bounding box for the specified text.
      • bound_top (r/o) short_float -- Returns the top coordinate, in points, of the text bounding box for the specified text.
      • bound_width (r/o) short_float -- Returns the width, in points, of the text bounding box for the specified text.
      • content unicode_text -- Returns or sets the text in a text range.
      • font (r/o) shape_font -- Returns the character formatting for the object.
      • paragraph_format (r/o) paragraph_format -- Returns the paragraph formatting for the specified text.
      • text_length (r/o) integer -- Returns the length of a text range.
      • text_start (r/o) integer -- Returns the starting point of the specified text range.
    • Elements:
  • word

Table Suite

Classes and types for scripting table manipulations

Commands

  • activate_object -- Activates the object.
  • add_comment -- Adds a comment to the range.
    • range
    • [comment_text unicode_text] -- The comment text.
    • Result: Excel_comment -- The newly created comment object.
  • advanced_filter -- Filters or copies data from a list based on a criteria range. If the initial selection is a single cell, that cell's current region is used.
    • range
    • action k.filter_copy / k.filter_in_place -- The filter operation.
    • [criteria_range k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_category_names] -- The criteria range. If this argument is omitted, there are no criteria.
    • [copy_to_range k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_category_names] -- The destination range for the copied rows if action is filter copy. Otherwise, this argument is ignored.
    • [unique boolean] -- Set to true to filter unique records only. False to filter all records that meet the criteria. The default value is false.
  • apply_names -- Applies names to the cells in the specified range.
    • range
    • [names list] -- A list of the names to be applied. If this argument is omitted, all names on the sheet are applied to the range.
    • [ignore_relative_absolute boolean] -- Set to true to replace references with names, regardless of the reference types of either the names or references. False to replace absolute references with absolute names, relative references with relative names, and mixed references with mixed names.
    • [use_row_column_names boolean] -- Set to true to use the names of row and column ranges that contain the specified range if names for the range cannot be found. False to ignore the omit column and omit row arguments. The default value is true.
    • [omit_column boolean] -- Set to true to replace the entire reference with the row-oriented name. The column-oriented name can be omitted only if the referenced cell is in the same column as the formula and is within a row-oriented named range. The default value is true.
    • [omit_row boolean] -- Set to true to replace the entire reference with the column-oriented name. The row-oriented name can be omitted only if the referenced cell is in the same row as the formula and is within a column-oriented named range. The default value is true.
    • [order k.column_then_row / k.row_then_column] -- Determines which range name is listed first when a cell reference is replaced by a row-oriented and column-oriented range name.
    • [append_last boolean] -- Set to true to replace the definitions of the names in names and also replace the definitions of the last names that were defined. False to replace the definitions of the names in names only. The default value is false.
  • apply_outline_styles -- Applies outlining styles to the specified range.
  • auto_outline -- Automatically creates an outline for the specified range. If the range is a single cell, Microsoft Excel creates an outline for the entire sheet. The new outline replaces any existing outline.
  • autocomplete -- Returns an AutoComplete match from the list. If there's no AutoComplete match or if more than one entry in the list matches the string to complete, this method returns an empty string.
    • range
    • string_ unicode_text -- The string to complete.
    • Result: unicode_text -- The completed string.
  • autofill -- Performs an autofill on the cells in the specified range.
    • range
    • destination k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_category_names -- The cells to be filled. The destination must include the source range.
    • [type k.fill_copy / k.fill_days / k.fill_default / k.fill_formats / k.fill_months / k.fill_series / k.fill_values / k.fill_weekdays / k.fill_years / k.growth_trend / k.linear_trend] -- Specifies the fill type.
  • autofilter_range -- Filters a list using the AutoFilter.
    • range
    • [field integer] -- The integer offset of the field on which you want to base the filter, from the left of the list, the leftmost field is field one.
    • [criteria1 anything] -- The criteria, a string, for example, 101. Use = to find blank fields, or use <> to find nonblank fields. If this argument is omitted, the criteria is all.
    • [operator k.autofilter_and / k.bottom_10_items / k.bottom_10_percent / k.autofilter_or / k.top_10_items / k.top_10_percent / k.filter_by_value / k.filter_by_cell_color / k.filter_by_font_color / k.filter_by_icon / k.filter_dynamic / k.filter_no_fill / k.filter_by_automatic_font_color / k.filter_by_no_icon] -- Specifies the operator to be used.
    • [criteria2 anything] -- The second criteria. Used with criteria1 and operator to construct compound criteria.
    • [visible_drop_down boolean] -- Set to true to display the AutoFilter drop-down arrow for the filtered field. False to hide the AutoFilter drop-down arrow for the filtered field.
  • autofit -- Changes the width of the specified column range or the height of the specified row range to achieve the best fit.
  • autoformat -- Automatically formats a range of cells, using a predefined format.
    • range
    • [format k.range_autoformat_threeD_effects_1 / k.range_autoformat_threeD_effects_2 / k.range_autoformat_accounting_1 / k.range_autoformat_accounting_2 / k.range_autoformat_accounting_3 / k.range_autoformat_accounting_4 / k.range_autoformat_classic_1 / k.range_autoformat_classic_2 / k.range_autoformat_classic_3 / k.range_autoformat_color_1 / k.range_autoformat_color_2 / k.range_autoformat_color_3 / k.range_autoformat_list_1 / k.range_autoformat_list_2 / k.range_autoformat_list_3 / k.range_autoformat_local_format_1 / k.range_autoformat_local_format_2 / k.range_autoformat_local_format_3 / k.range_autoformat_local_format_4 / k.range_autoformat_none / k.range_autoformat_simple] -- The range format to be used.
    • [include_number boolean] -- Set to true to include number formats in the autoformat. The default value is true.
    • [font boolean] -- set to true to include font formats in the autoformat. The default value is true.
    • [alignment boolean] -- Set to true to include alignment in the autoformat. The default value is true.
    • [border boolean] -- Set to true to include border formats in the autoformat. The default value is true.
    • [pattern boolean] -- set to true to include pattern formats in the autoformat. The default value is true.
    • [width boolean] -- Set to true to include column width and row height in the autoformat. The default value is true.
  • border_around -- Adds a border to a range and sets the color, line style, and weight properties for the new border.
    • range
    • [line_style k.continuous / k.dash / k.dash_dot / k.dash_dot_dot / k.dot / k.double / k.slant_dash_dot / k.line_style_none] -- The line style for the border.
    • [weight k.border_weight_hairline / k.border_weight_medium / k.border_weight_thick / k.border_weight_thin] -- The border weight.
    • [color_index k.color_index_automatic / k.color_index_none / k.a_color_index_integer] -- The border color, as an index into the current color palette.
    • [color RGB_color] -- The border color, as an RGB value.
  • calculate -- Calculates all open workbooks, a specific worksheet in a workbook, or a specified range of cells on a worksheet.
  • calculate_row_major_order -- Calculates a specfied range of cells.
  • check_spelling -- Checks the spelling of an object.
    • range
    • [custom_dictionary unicode_text] -- A string that indicates the file name of the custom dictionary to examine if the word isn't found in the main dictionary. If this argument is omitted, the currently specified dictionary is used.
    • [ignore_uppercase boolean] -- Set to true to have Microsoft Excel ignore words that are all uppercase. False to have Microsoft Excel check words that are all uppercase.
    • [always_suggest boolean] -- Set to true to have Microsoft Excel display a list of suggested alternate spellings when an incorrect spelling is found. False to have Microsoft Excel wait for you to input the correct spelling.
  • clear_Excel_comments -- Clears all cell comments from the specified range.
  • clear_contents -- Clears all cell comments from the specified range.
  • clear_hyperlinks -- clear all the hyperlinks in a range
  • clear_outline -- Clears the outline for the specified range.
  • clear_range -- Clears the entire object.
  • clear_range_formats -- Clears the formatting of the object.
  • column_differences -- Returns a range object that represents all the cells whose contents are different from the comparison cell in each column.
    • range
    • comparison k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_category_names -- . A single cell to compare to the specified range.
    • Result: range
  • consolidate -- Consolidates data from multiple ranges on multiple worksheets into a single range on a single worksheet.
    • range
    • [sources list] -- The sources of the consolidation as a list of text reference strings in R1C1-style notation. The references must include the full path of sheets to be consolidated.
    • [consolidation_function k.do_average / k.do_count / k.do_count_numbers / k.do_maximum / k.do_minimum / k.do_product / k.do_standard_deviation / k.do_standard_deviation_p / k.do_sum / k.do_var / k.do_var_p] -- The consolidation function.
    • [top_row boolean] -- Set to true to consolidate data based on column titles in the top row of the consolidation ranges. False to consolidate data by position. The default value is false.
    • [left_column boolean] -- Set to true to consolidate data based on row titles in the left column of the consolidation ranges. False to consolidate data by position. The default value is false.
    • [create_links boolean] -- Set to true to have the consolidation use worksheet links. False to have the consolidation copy the data. The default value is false.
  • copy_picture -- Copies the selected object to the clipboard as a picture.
    • range
    • [appearance k.printer / k.screen] -- Specifies how the picture should be copied.
    • [format k.bitmap / k.picture] -- The format of the picture.
  • copy_range -- Copies the range to the specified range.
  • create_names -- Creates names in the specified range, based on text labels in the sheet.
    • range
    • [top boolean] -- Set to true to create names by using labels in the top row. The default value is false.
    • [left_position boolean] -- Set to true to create names by using labels in the left column. The default value is false.
    • [bottom boolean] -- Set to true to create names by using labels in the bottom row. The default value is false.
    • [right boolean] -- Set to true to create names by using labels in the right column. The default value is false.
  • cut_range -- Cuts the range to the clipboard.
    • range
    • [destination_of_cut k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_category_names]
  • data_series -- Creates a data series in the specified range.
    • range
    • [rowcol k.by_columns / k.by_rows] -- Can be the by rows or by columns to have the data series entered in rows or columns, respectively. If this argument is omitted, the size and shape of the range is used.
    • [data_series_type k.autofill_series / k.chronological_series / k.growth_series / k.data_series_linear] -- Sets the type of the data series. The default is data series linear.
    • [date_ k.series_date_day / k.series_date_month / k.series_date_weekday / k.series_date_year] -- If the data series type argument is chronological series, the date argument indicates the step date unit. The default value is series date day.
    • [increment integer] -- The step value for the series. The default value is 1.
    • [stop integer] -- The stop value for the series. If this argument is omitted, Microsoft Excel fills to the end of the range.
    • [trend boolean] -- Set to true to create a linear trend or growth trend. False to create a standard data series. The default value is false.
  • data_table -- Creates a data table based on input values and formulas that you define on a worksheet.
    • range
    • [row_input cell] -- A single cell to use as the row input for your table.
    • [column_input cell] -- A single cell to use as the column input for your table.
  • delete_range -- Deletes the range
    • range
    • [shift k.shift_to_left / k.shift_up] -- Specifies how to shift cells to replace deleted cells.
  • dirty -- Designates a range to be recalculated when the next recalculation occurs.
  • fill_down -- Fills down from the top cell or cells in the specified range to the bottom of the range. The contents and formatting of the cell or cells in the top row of a range are copied into the rest of the rows in the range.
  • fill_left -- Fills left from the rightmost cell or cells in the specified range. The contents and formatting of the cell or cells in the rightmost column of a range are copied into the rest of the columns in the range.
  • fill_right -- Fills right from the leftmost cell or cells in the specified range. The contents and formatting of the cell or cells in the leftmost column of a range are copied into the rest of the columns in the range.
  • fill_up -- Fills up from the bottom cell or cells in the specified range to the top of the range. The contents and formatting of the cell or cells in the bottom row of a range are copied into the rest of the rows in the range.
  • find -- Finds specific information in a range, and returns a range object that represents the first cell where that information is found. Returns nothing if no match is found. Doesn't affect the selection or the active cell.
    • range
    • what unicode_text -- The data to search for.
    • [after_ k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_category_names] -- The cell after which you want to search. Note that after must be a single cell in the range. If this argument isn't specified, the search starts after the cell in the upper-left corner of the range.
    • [look_in k.formulas / k.comments / k.values] -- Specifies where the find method should look.
    • [look_at k.part / k.whole] -- Specifies the part that should be looked at.
    • [search_order k.by_columns / k.by_rows] -- Specifies if the search should be rows or columns.
    • [search_direction k.search_next / k.search_previous] -- Specifies the search direction either next or previous.
    • [match_case boolean] -- Set to true to make the search case sensitive.
    • [match_byte boolean] -- Used only in the East Asian version of Microsoft Excel. Set to true to have double-byte characters match only double-byte characters. False to have double-byte characters match their single-byte equivalents.
    • Result: range -- The range which the specified data was found.
  • find_next -- Continues a search that was begun with the find method. Finds the next cell that matches those same conditions and returns a range object that represents that cell. Doesn't affect the selection or the active cell.
    • range
    • [after_ k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_category_names] -- The cell after which you want to search. Note that after must be a single cell in the range. If this argument isn't specified, the search starts after the cell in the upper-left corner of the range.
    • Result: range -- The range which the specified data was found.
  • find_previous -- Continues a search that was begun with the find method. Finds the previous cell that matches those same conditions and returns a range object that represents that cell. Doesn't affect the selection or the active cell.
    • range
    • [after_ k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_category_names] -- The cell after which you want to search. Note that after must be a single cell in the range. If this argument isn't specified, the search starts after the cell in the upper-left corner of the range.
    • Result: range -- The range which the specified data was found.
  • function_wizard -- Starts the Function Wizard for the upper-left cell of the range.
  • get_XML_value -- Returns the value of the specified range as XML.
  • get_address -- Returns the range reference in the language of the macro.
    • range
    • [row_absolute boolean] -- Set to true to return the row part of the reference as an absolute reference. The default value is true.
    • [column_absolute boolean] -- Set to true to return the column part of the reference as an absolute reference. The default value is true.
    • [reference_style k.A1 / k.R1C1] -- Specifies what reference style should be returned. The default is A1.
    • [external boolean] -- Set to true to return an external reference. False to return a local reference. The default value is false.
    • [relative_to k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_category_names] -- If row absolute and column absolute are false, and reference style is R1C1, you must include a starting point for the relative reference. This argument is a range object that defines the starting point.
    • Result: unicode_text -- The address string
  • get_address_local -- Returns the range reference in the language of the user.
    • range
    • [row_absolute boolean] -- Set to true to return the row part of the reference as an absolute reference. The default value is true.
    • [column_absolute boolean] -- Set to true to return the column part of the reference as an absolute reference. The default value is true.
    • [reference_style k.A1 / k.R1C1] -- Specifies what reference style should be returned. The default is A1.
    • [external boolean] -- Set to true to return an external reference. False to return a local reference. The default value is false.
    • [relative_to k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_category_names] -- If row absolute and column absolute are false, and reference style is R1C1, you must include a starting point for the relative reference. This argument is a range object that defines the starting point.
    • Result: unicode_text -- The address string
  • get_border -- Returns the specified border object.
    • range
    • which_border k.inside_horizontal / k.inside_vertical / k.diagonal_down / k.diagonal_up / k.edge_bottom / k.edge_left / k.edge_right / k.edge_top / k.border_bottom / k.border_left / k.border_right / k.border_top -- This specifies which border object should be retrieved.
    • Result: border
  • get_end -- Returns a range object that represents the cell at the end of the region that contains the source range.
    • range
    • direction k.toward_the_bottom / k.toward_the_left / k.toward_the_right / k.toward_the_top -- The direction in which to move.
    • Result: range
  • get_offset -- Returns a range object that represents a range that's offset from the specified range.
    • range
    • [row_offset integer] -- The number of rows, positive, negative, or zero, by which the range is to be offset. The default value is 0.
    • [column_offset integer] -- The number of columns, positive, negative, or zero, by which the range is to be offset. The default value is 0.
    • Result: range
  • get_resize -- Resizes the specified range. Returns a Range object that represents the resized range.
    • range
    • [row_size integer] -- The number of rows in the new range. If this argument is omitted, the number of rows in the range remains the same.
    • [column_size integer] -- The number of columns in the new range. If this argument is omitted, the number of columns in the range remains the same.
    • Result: range -- A range object that represents the resized range.
  • goal_seek -- Calculates the values necessary to achieve a specific goal. If the goal is an amount returned by a formula, this calculates a value that, when supplied to your formula, causes the formula to return the number you want. Returns True if successful.
    • range
    • goal float -- The value you want returned in this cell.
    • changing_cell range -- Specifies which cell should be changed to achieve the target value.
    • Result: boolean -- Specifies if the goal was met.
  • group -- When the Range object represents a single cell in a pivot table field's data range, the group method performs numeric or date-based grouping in that field.
    • range
    • [start integer] -- The first value to be grouped. If this argument is omitted or true, the first value in the field is used.
    • [end_ integer] -- The last value to be grouped. If this argument is omitted or true, the last value in the field is used.
    • [by integer] -- If the field is numeric, this argument specifies the size of each group.
    • [periods list] -- An array of boolean values that specify the period for the group, as shown in the following list item 1 seconds, 2 minutes, 3 hours, 4 days, 5 months, 6 quarters, 7 years. It the items is set to true, a group is created for the corresponding time.
    • Result: boolean -- Specifies success or failure.
  • insert_indent -- Adds an indent to the specified range.
    • range
    • insert_amount integer -- The amount to be added to the current indent.
  • insert_into_range -- Inserts a cell or a range of cells into the worksheet or macro sheet and shifts other cells away to make space.
    • range
    • [shift k.shift_down / k.shift_to_right] -- Specifies which way to shift the cells.
  • justify -- Rearranges the text in a range so that it fills the range evenly.
  • list_names -- Pastes a list of all non-hidden names onto the worksheet, beginning with the first cell in the range.
  • merge -- Creates a merged cell from the specified Range object.
  • navigate_arrow -- Navigates a tracer arrow for the specified range to the precedent, dependent, or error-causing cell or cells. Selects the precedent, dependent, or error cells and returns a range object that represents the new selection.
    • range
    • [toward_precedent boolean] -- Specifies the direction to navigate: True to navigate toward precedents, False to navigate toward dependent.
    • [arrow_number integer] -- Specifies the arrow number to navigate, corresponds to the numbered reference in the cell's formula.
    • [link_number integer] -- If the arrow is an external reference arrow, this argument indicates which external reference to follow. If this argument is omitted, the first external reference is followed.
  • parse -- Parses a range of data and breaks it into multiple cells. Distributes the contents of the range to fill several adjacent columns; the range can be no more than one column wide.
    • range
    • [parse_line unicode_text] -- A string that contains left and right brackets to indicate where the cells should be split.
    • [destination k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_category_names] -- A range object that represents the upper-left corner of the destination range for the parsed data. If this argument is omitted, Microsoft Excel parses in place.
  • paste_special -- Pastes the contents of the Clipboard onto the sheet, using a specified format. Use this method to paste data from other applications or to paste data in a specific format.
    • range
    • [what k.paste_all / k.paste_all_using_source_theme / k.paste_all_except_borders / k.paste_formats / k.paste_formulas / k.paste_comments / k.paste_values / k.paste_column_widths / k.paste_validation / k.paste_formulas_and_number_formats / k.paste_values_and_number_formats] -- The part of the range to be pasted.
    • [operation k.paste_special_operation_add / k.paste_special_operation_divide / k.paste_special_operation_multiply / k.paste_special_operation_none / k.paste_special_operation_subtract] -- The paste operation.
    • [skip_blanks boolean] -- Set to true to have blank cells in the range on the clipboard not be pasted into the destination range. The default value is false.
    • [transpose boolean] -- set to true to transpose rows and columns when the range is pasted. The default value is false.
  • print_out -- Prints the object
    • range
    • [from_ integer] -- The number of the page at which to start printing. If this argument is omitted, printing starts at the beginning.
    • [to integer] -- The number of the last page to print. If this argument is omitted, printing ends with the last page.
    • [copies integer] -- The number of copies to print. If this argument is omitted, one copy is printed.
    • [preview boolean] -- Set to true to have Microsoft Excel invoke print preview before printing the object.
    • [active_printer unicode_text] -- Sets the name of the active printer.
    • [print_to_file boolean] -- Set to true to print to a file.
    • [collate boolean] -- Set to true to collate multiple copies.
  • print_preview -- Shows a preview of the object as it would look when printed. This function has been deprecated.
    • range
    • [enable_changes boolean] -- Controls access to the page setup dialog and the ability to change margins from the preview window by enabling or disabling the setup and margins buttons, respectively.
  • remove_duplicates -- Removes duplicate values from a range of values.
    • reference
  • remove_subtotal -- Removes subtotals from a list.
  • replace -- Finds and replaces characters in cells within a range. Doesn't change the selection or the active cell.
    • range
    • what unicode_text -- The string to search for.
    • replacement unicode_text -- The replacement string.
    • [look_at k.part / k.whole] -- Specifies the part that should be looked at.
    • [search_order k.by_columns / k.by_rows] -- Specifies if the search should be rows or columns.
    • [match_case boolean] -- Set to true to make the search case sensitive.
    • [match_byte boolean] -- Used only in the East Asian version of Microsoft Excel. Set to true to have double-byte characters match only double-byte characters. False to have double-byte characters match their single-byte equivalents.
    • [match_control_characters boolean] -- Used only in the East Asian version of Microsoft Excel. Set to true to have double-byte characters match only double-byte characters. False to have double-byte characters match their single-byte equivalents.
    • [match_diacritics boolean] -- Used only in the East Asian version of Microsoft Excel. Set to true to have double-byte characters match only double-byte characters. False to have double-byte characters match their single-byte equivalents.
    • Result: boolean -- Specifies success or failure.
  • row_differences -- Returns a range object that represents all the cells whose contents are different from those of the comparison cell in each row.
    • range
    • comparison cell -- A single cell to compare with the specified range.
    • Result: range -- The result range.
  • run_VB_macro -- Runs a macro or calls a function. This can be used to run a macro written in the Microsoft Excel 4.0 macro language, or to run a function in a DLL or XLL.
    • range
    • [arg1 anything] -- An argument to be passed to the macro.
    • [arg2 anything] -- An argument to be passed to the macro.
    • [arg3 anything] -- An argument to be passed to the macro.
    • [arg4 anything] -- An argument to be passed to the macro.
    • [arg5 anything] -- An argument to be passed to the macro.
    • [arg6 anything] -- An argument to be passed to the macro.
    • [arg7 anything] -- An argument to be passed to the macro.
    • [arg8 anything] -- An argument to be passed to the macro.
    • [arg9 anything] -- An argument to be passed to the macro.
    • [arg10 anything] -- An argument to be passed to the macro.
    • [arg11 anything] -- An argument to be passed to the macro.
    • [arg12 anything] -- An argument to be passed to the macro.
    • [arg13 anything] -- An argument to be passed to the macro.
    • [arg14 anything] -- An argument to be passed to the macro.
    • [arg15 anything] -- An argument to be passed to the macro.
    • [arg16 anything] -- An argument to be passed to the macro.
    • [arg17 anything] -- An argument to be passed to the macro.
    • [arg18 anything] -- An argument to be passed to the macro.
    • [arg19 anything] -- An argument to be passed to the macro.
    • [arg20 anything] -- An argument to be passed to the macro.
    • [arg21 anything] -- An argument to be passed to the macro.
    • [arg22 anything] -- An argument to be passed to the macro.
    • [arg23 anything] -- An argument to be passed to the macro.
    • [arg24 anything] -- An argument to be passed to the macro.
    • [arg25 anything] -- An argument to be passed to the macro.
    • [arg26 anything] -- An argument to be passed to the macro.
    • [arg27 anything] -- An argument to be passed to the macro.
    • [arg28 anything] -- An argument to be passed to the macro.
    • [arg29 anything] -- An argument to be passed to the macro.
    • [arg30 anything] -- An argument to be passed to the macro.
    • Result: unicode_text -- The result of the macro.
  • run_XLM_macro -- Runs a macro or calls a function. This can be used to run a macro written in the Microsoft Excel 4.0 macro language, or to run a function in a DLL or XLL.
    • range
    • [arg1 anything] -- An argument to be passed to the macro.
    • [arg2 anything] -- An argument to be passed to the macro.
    • [arg3 anything] -- An argument to be passed to the macro.
    • [arg4 anything] -- An argument to be passed to the macro.
    • [arg5 anything] -- An argument to be passed to the macro.
    • [arg6 anything] -- An argument to be passed to the macro.
    • [arg7 anything] -- An argument to be passed to the macro.
    • [arg8 anything] -- An argument to be passed to the macro.
    • [arg9 anything] -- An argument to be passed to the macro.
    • [arg10 anything] -- An argument to be passed to the macro.
    • [arg11 anything] -- An argument to be passed to the macro.
    • [arg12 anything] -- An argument to be passed to the macro.
    • [arg13 anything] -- An argument to be passed to the macro.
    • [arg14 anything] -- An argument to be passed to the macro.
    • [arg15 anything] -- An argument to be passed to the macro.
    • [arg16 anything] -- An argument to be passed to the macro.
    • [arg17 anything] -- An argument to be passed to the macro.
    • [arg18 anything] -- An argument to be passed to the macro.
    • [arg19 anything] -- An argument to be passed to the macro.
    • [arg20 anything] -- An argument to be passed to the macro.
    • [arg21 anything] -- An argument to be passed to the macro.
    • [arg22 anything] -- An argument to be passed to the macro.
    • [arg23 anything] -- An argument to be passed to the macro.
    • [arg24 anything] -- An argument to be passed to the macro.
    • [arg25 anything] -- An argument to be passed to the macro.
    • [arg26 anything] -- An argument to be passed to the macro.
    • [arg27 anything] -- An argument to be passed to the macro.
    • [arg28 anything] -- An argument to be passed to the macro.
    • [arg29 anything] -- An argument to be passed to the macro.
    • [arg30 anything] -- An argument to be passed to the macro.
    • Result: unicode_text -- The result of the macro.
  • set_XML_value -- Set the value of the specified range using XML.
    • range
    • range_value anything
  • show -- Scrolls through the contents of the active window to move the range into view. The range must consist of a single cell in the active document.
  • show_dependents -- Draws tracer arrows to the direct dependents of the range.
    • range
    • [remove boolean] -- Set to true to remove one level of tracer arrows to direct dependents. False to expand one level of tracer arrows. The default value is false.
  • show_errors -- Draws tracer arrows through the precedents tree to the cell that's the source of the error, and returns the range that contains that cell.
  • show_precedents -- Draws tracer arrows to the direct precedents of the range.
    • range
    • [remove boolean] -- Set to true to remove one level of tracer arrows to direct precedents. False to expand one level of tracer arrows. The default value is false.
  • sort -- Sorts a pivot table, a range, or the current region, if the specified range contains only one cell.
    • range
    • [key1 range] -- The first sort field.
    • [order1 k.sort_ascending / k.sort_descending / k.sort_manual] -- Specifies the sort order for the first sort field.
    • [key2 range] -- The second sort field.
    • [sort_type k.sort_labels / k.sort_values] -- Specifies which elements are sorted.
    • [order2 k.sort_ascending / k.sort_descending / k.sort_manual] -- Specifies the sort order for the second sort field.
    • [key3 range] -- The third sort field.
    • [order3 k.sort_ascending / k.sort_descending / k.sort_manual] -- Specifies the sort order for the third sort field.
    • [header k.header_guess / k.header_no / k.header_yes] -- Specifies whether the first row contains headers.
    • [order_custom integer] -- A 1-based integer offset into the list of custom sort orders. If this argument is omitted, 1, normal, is used.
    • [match_case boolean] -- Set to true to do a case-sensitive sort.
    • [orientation k.sort_rows / k.sort_columns] -- Specifies if the sort is done top to bottom or left to right.
    • [sort_method k.pin_yin / k.stroke] -- Specifies the type of sort. The default is pin yin.
    • [ignore_control_characters boolean] -- It is not supported any more.
    • [ignore_diacritics boolean] -- It is not supported any more.
    • [dataoption1 k.sort_normal / k.sort_text_as_numbers] -- Specifies how to sort text in the range specified in Key1. Does not apply to pivot table sorting.
    • [dataoption2 k.sort_normal / k.sort_text_as_numbers] -- Specifies how to sort text in the range specified in Key2. Does not apply to pivot table sorting.
    • [dataoption3 k.sort_normal / k.sort_text_as_numbers] -- Specifies how to sort text in the range specified in Key3. Does not apply to pivot table sorting.
  • sort_special -- Uses East Asian sorting methods to sort the range, or uses the current region if the range contains only one cell.
    • range
    • [sort_method k.pin_yin / k.stroke] -- Specifies how to sort.
    • [key1 range] -- The first sort field.
    • [order1 k.sort_ascending / k.sort_descending / k.sort_manual] -- Specifies the sort order for the first sort field.
    • [type anything] -- Specifies which elements are sorted.
    • [key2 range] -- The second sort field.
    • [order2 k.sort_ascending / k.sort_descending / k.sort_manual] -- Specifies the sort order for the second sort field.
    • [key3 range] -- The third sort field.
    • [order3 k.sort_ascending / k.sort_descending / k.sort_manual] -- Specifies the sort order for the third sort field.
    • [header k.header_guess / k.header_no / k.header_yes] -- Specifies whether the first row contains headers.
    • [order_custom integer] -- A 1-based integer offset into the list of custom sort orders. If this argument is omitted, 1, normal, is used.
    • [match_case boolean] -- Set to true to do a case-sensitive sort.
    • [orientation k.sort_rows / k.sort_columns] -- Specifies if the sort is done top to bottom or left to right.
    • [dataoption1 k.sort_normal / k.sort_text_as_numbers] -- Specifies how to sort text in the range specified in Key1. Does not apply to pivot table sorting.
    • [dataoption2 k.sort_normal / k.sort_text_as_numbers] -- Specifies how to sort text in the range specified in Key2. Does not apply to pivot table sorting.
    • [dataoption3 k.sort_normal / k.sort_text_as_numbers] -- Specifies how to sort text in the range specified in Key3. Does not apply to pivot table sorting.
  • special_cells -- Returns a Range object that represents all the cells that match the specified type and value.
    • range
    • type k.cell_type_blanks / k.cell_type_constants / k.cell_type_formulas / k.cell_type_last_cell / k.cell_type_comments / k.cell_type_visible / k.cell_type_all_format_conditions / k.cell_type_same_format_conditions / k.cell_type_all_validation / k.cell_type_same_validation -- Specifies the cells to include.
    • [value k.errors / k.logical / k.numbers / k.text_values] -- If type is either cell type constants or cell type formulas, this argument is used to determine which types of cells to include in the result. The default is to select all constants or formulas, no matter what the type.
    • Result: range -- A range containing the special cells.
  • subtotal -- Creates subtotals for the range, or the current region, if the range is a single cell.
    • range
    • group_by integer -- The field to group by, as a 1-based integer offset.
    • function k.do_average / k.do_count / k.do_count_numbers / k.do_maximum / k.do_minimum / k.do_product / k.do_standard_deviation / k.do_standard_deviation_p / k.do_sum / k.do_var / k.do_var_p -- The subtotal function.
    • total_list list -- An array of 1-based field offsets, indicating the fields to which the subtotals are added.
    • [replace boolean] -- Set to true to replace existing subtotals. The default value is false
    • [page_breaks boolean] -- Set to true to add page breaks after each group. The default value is false.
    • [summary_below_data k.summary_above / k.summary_below] -- Specifies if the summary data id placed above or below the range. The default is below.
  • text_to_columns -- Parses a column of cells that contain text into several columns.
    • range
    • [destination k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_category_names] -- A range object that specifies where Microsoft Excel will place the results. If the range is larger than a single cell, the top left cell is used.
    • [data_type k.delimited / k.fixed_width] -- The format of the text to be split into columns.
    • [text_qualifier k.text_qualifier_double_quote / k.text_qualifier_none / k.text_qualifier_single_quote] -- Specifies the text qualifier.
    • [consecutive_delimiter boolean] -- Set to true to have Microsoft Excel consider consecutive delimiters as one delimiter. The default value is false.
    • [tab boolean] -- Set to true to have data type be delimited and to have the tab character be a delimiter. The default value is false.
    • [semicolon boolean] -- Set to true to have data type be delimited and to have the semicolon character be a delimiter. The default value is false.
    • [comma boolean] -- Set to true to have data type be delimited and to have the comma character be a delimiter. The default value is false.
    • [space boolean] -- Set to true to have data type be delimited and to have the space character be a delimiter. The default value is false.
    • [use_other boolean] -- Set to true to have the character specified by the other char argument be the delimiter. The data type argument must be delimited. The default is false.
    • [other_char unicode_text] -- This is required if the use other argument is true. Specifies the delimiter character when Other is true. If more than one character is specified, only the first character of the string is used, the remaining characters are ignored.
    • [field_info list] -- A list contain parse information for the individual columns of data. Formats are general format, text format, MDY format, DMY format, YMD format, MYD format, DYM format, YDM format, skip column.
    • [decimal_separator unicode_text] -- A string specifying whether a comma or period is used in the text file as the separator for decimal numbers.
    • [thousands_separator unicode_text] -- A string specifying whether a comma, period, or apostrophe is used in the text file as the separator for thousands.
  • ungroup -- Promotes a range in an outline, that is, decreases its outline level. The specified range must be a row or column, or a range of rows or columns. If the range is in a pivot table, this method ungroups the items contained in the range.
  • unmerge -- Separates a merged area into individual cells.

Classes

  • cell
    • Plural name:
      • cells
    • Inherits from:
  • column
    • Plural name:
      • columns
    • Inherits from:
  • range -- Represents a cell, a row, a column, a selection of cells containing one or more contiguous blocks of cells, or a 3-D range.
    • Plural name:
      • ranges
    • Inherits from:
    • Inherited by:
    • Properties:
      • Excel_comment (r/o) Excel_comment -- Returns a comment object that represents the comment associated with the cell in the upper-left corner of the range.
      • add_indent boolean -- Returns or sets if text is automatically indented when the text alignment in a cell is set to equal distribution either horizontally or vertically.
      • areas (r/o) list -- Returns a list of range objects that represents all the ranges in a multiple-area selection.
      • column_width float -- Returns or sets the width of all columns in the specified range.
      • count_large (r/o) null -- Counts the largest value in a given range of values. Read-only Variant.
      • current_array (r/o) range -- If the specified cell is part of an array, returns a range object that represents the entire array.
      • current_region (r/o) range -- Returns a range object that represents the current region. The current region is a range bounded by any combination of blank rows and blank columns.
      • dependents (r/o) range -- Returns a range object that represents the range containing all the dependents of a cell. This can be a multiple selection, a union of Range objects, if there's more than one dependent.
      • direct_dependents (r/o) range -- Returns a range object that represents the range containing all the direct dependents of a cell. This can be a multiple selection, a union of Range objects, if there's more than one dependent.
      • direct_precedents (r/o) range -- Returns a range object that represents the range containing all the direct precedents of a cell. This can be a multiple selection, a union of Range objects, if there's more than one precedent.
      • display_format (r/o) display_format -- Returns the display format associated with this range.
      • entire_column (r/o) range -- Returns a range object that represents the entire column, or columns, that contains the specified range.
      • entire_row (r/o) range -- Returns a range object that represents the entire row, or rows, that contains the specified range.
      • first_column_index (r/o) integer -- Returns the number of the first column in the first area in the specified range.
      • first_row_index (r/o) integer -- Returns the number of the first row of the first area in the range.
      • font_object (r/o) font -- Returns the font object associated with this range.
      • formula anything -- Returns or sets the object's formula, in A1-style notation.
      • formula_array unicode_text -- Returns or sets the array formula of a range.
      • formula_hidden boolean -- Returns or sets if the formula will be hidden when the workbook or worksheet is protected.
      • formula_label k.no_labels / k.row_labels / k.column_labels / k.mixed_labels -- Returns or sets the formula label type for the specified range.
      • formula_local unicode_text -- Returns or sets the formula for the object, using A1-style references in the language of the user.
      • formula_r1c1 unicode_text -- Returns or sets the formula for the object, using R1C1-style notation.
      • formula_r1c1_local unicode_text -- Returns or sets the formula for the object, using R1C1-style notation in the language of the user.
      • has_array (r/o) boolean -- Returns true if the specified cell is part of an array formula.
      • has_formula (r/o) boolean -- Returns true if all cells in the range contain formulas.
      • height (r/o) float -- Returns the height of the range.
      • hidden boolean -- Returns or sets if the rows or columns are hidden. The specified range must span an entire column or row.
      • horizontal_alignment k.horizontal_align_center / k.horizontal_align_center_across_selection / k.horizontal_align_distributed / k.horizontal_align_fill / k.horizontal_align_general / k.horizontal_align_justify / k.horizontal_align_left / k.horizontal_align_right -- Returns or sets the horizontal alignment for the range.
      • indent_level integer -- Returns or sets the indent level for the range or style. Can be an integer from 0 to 15.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • left_position (r/o) float -- The distance from the left edge of column A to the left edge of the range. If the range is discontinuous, the first area is used. If the range is more than one column wide, the leftmost column in the range is used.
      • list_header_rows (r/o) integer -- Returns the number of header rows for the specified range.
      • list_object (r/o) list_object -- Returns the list object associated with this range.
      • location_in_table (r/o) k.column_header / k.column_item / k.data_header / k.data_item / k.page_header / k.page_item / k.row_header / k.row_item / k.table_body -- Returns an enumeration that describes the part of the pivot table that contains the upper-left corner of the specified range.
      • locked boolean -- Returns or sets if the range is locked.
      • merge_area (r/o) range -- Returns a range object that represents the merged range containing the specified cell. If the specified cell isn't in a merged range, this property returns the specified cell.
      • merge_cells boolean -- Returns or sets if the range contains merged cells.
      • name unicode_text -- Returns or sets the name of the range.
      • named_item (r/o) unicode_text -- Returns the named item associated with this range.
      • number_format unicode_text -- Returns or sets the format code for the object.
      • number_format_local unicode_text -- Returns or sets the format code for the object as a string in the language of the user.
      • outline_level integer -- Returns or sets the current outline level of the specified row or column
      • page_break k.page_break_automatic / k.page_break_manual / k.page_break_none -- Returns or sets the location of a page break.
      • phonetic_object (r/o) phonetic -- Returns the phonetic object, which contains information about a specific phonetic text string in a specified range.
      • pivot_field (r/o) pivot_field -- Returns a pivot field object that represents the pivot field containing the upper-left corner of the specified range.
      • pivot_item (r/o) pivot_item -- Returns a pivot item object that represents the pivot item containing the upper-left corner of the specified range.
      • pivot_table (r/o) pivot_table -- Returns a pivot table object that represents the pivot table containing the upper-left corner of the specified range.
      • precedents (r/o) range -- Returns a range object that represents all the precedents of a cell. This can be a multiple selection, a union of Range objects, if there's more than one precedent.
      • prefix_character (r/o) unicode_text -- Returns the prefix character for the cell.
      • query_table (r/o) query_table -- Returns a query table object that represents the query table that intersects the specified range.
      • reading_order k.left_to_right / k.right_to_left / k.context -- Returns or sets the reading order for the specified object.
      • row_height float -- Returns or sets the height of all the rows in the range specified, measured in points.
      • show_detail boolean -- Returns or sets if the outline is expanded for the specified range, so that the detail of the column or row is visible. The specified range must be a single summary column or row in an outline.
      • shrink_to_fit boolean -- Returns or sets if text automatically shrinks to fit in the available column width.
      • string_value (r/o) anything -- Returns the text for the range.
      • style_object style -- Returns or sets a style object that represents the style of the specified range.
      • summary (r/o) boolean -- Returns true if the range is an outlining summary row or column. The range should be a row or a column.
      • text_orientation k.orientation_downward / k.orientation_horizontal / k.orientation_upward / k.orientation_vertical -- The text orientation. Can be a number value from -90 to 90 degrees.
      • top (r/o) float -- The distance from the top edge of row 1 to the top edge of the range. If the range is discontinuous, the first area is used. If the range is more than one row high, the top, lowest numbered, row in the range is used.
      • use_standard_height boolean -- Returns or sets if the row height of the range object equals the standard height of the sheet.
      • use_standard_width boolean -- Returns or sets if the column width of the range object equals the standard width of the sheet.
      • validation (r/o) validation -- Returns the validation object that represents data validation for the specified range.
      • value anything -- Returns or sets the value of the range.
      • value2 anything -- Returns or sets the value of the range. The difference between this property and Value is that Value2 uses the numerical representation of cells that are formatted as currency and date.
      • vertical_alignment k.vertical_alignment_top / k.vertical_alignment_center / k.vertical_alignment_bottom / k.vertical_alignment_justify / k.vertical_alignment_distributed -- Returns or sets the vertical alignment of the range.
      • width (r/o) float -- Returns the width of the range.
      • worksheet_object (r/o) sheet -- Returns a worksheet object that represents the worksheet containing the specified range.
      • wrap_text boolean -- Returns or sets if Microsoft Excel wraps the text in the object.
    • Elements:
  • row
    • Plural name:
      • rows
    • Inherits from:

Proofing Suite

Classes and types for scripting text proofing

Commands

  • add_replacement -- Adds an entry to the array of autocorrect replacements.
    • autocorrect
    • text_to_replace unicode_text -- The text to be replaced. If this string already exists in the array of autocorrect replacements, the existing substitute text is replaced by the new text.
    • replacement_text unicode_text -- The replacement text.
  • delete_replacement -- Deletes an entry from the array of autocorrect replacements.
    • autocorrect
    • what unicode_text -- The text to be replaced, as it appears in the row to be deleted from the array of autocorrect replacements. If this string doesn't exist in the array of autocorrect replacements, this method fails.
  • get_replacement_list -- Returns a list of autocorrect replacements.

Classes

  • autocorrect -- Contains Microsoft Excel autocorrect attributes, capitalization of names of days, correction of two initial capital letters, automatic correction list, and so on.
    • Inherits from:
    • Properties:
      • Automatically_expand_tables_as_I_type boolean -- Returns or sets if resizes the table to include data entered into a neighboring column or row.
      • Automatically_fill_formulas boolean -- Returns or sets if we automatically copies the formula to all the cells in the column when a formula is entered into a cell.
      • correct_caps_lock boolean -- Returns or sets if Microsoft Excel automatically corrects accidental use of the CAPS LOCK key.
      • correct_days boolean -- Returns or sets if the first letter of day names is capitalized automatically.
      • correct_initial_caps boolean -- Returns or sets if words that begin with two capital letters are corrected automatically.
      • correct_sentence_caps boolean -- Returns or sets if Microsoft Excel automatically corrects sentence, first word, capitalization.
      • replace_text boolean -- Returns or sets if text in the list of autocorrect replacements is replaced automatically.

Chart Suite

Classes and types for scripting charts

Commands

  • activate_object -- Activates the object.
    • k.chart / k.chart_object
  • apply_custom_chart_type -- Applies a standard or custom chart type to a chart or series.
    • chart
    • chart_type k.built_in_chart / k.user_defined / k.any_gallery -- A standard chart type, see the chart type property for the list of available constants. For Chart objects, this argument can also be one of the options specified for this argument.
    • [chart_name unicode_text] -- The name of the custom chart type if chart type specifies a custom chart gallery.
  • apply_data_labels -- Applies data labels to all the series in a chart, a single series or a series point.
    • k.chart / k.series_point / k.series
    • [type k.data_labels_show_none / k.data_labels_show_value / k.data_labels_show_percent / k.data_labels_show_label / k.data_labels_show_label_and_percent / k.data_labels_show_bubble_sizes] -- Specifies the data label type. The default is 'data labels show value'
    • [legend_key boolean] -- Set to true to show the legend key next to the point. The default value is false.
    • [auto_text boolean] -- Set to true if the object automatically generates appropriate text based on content.
    • [has_leader_lines boolean] -- True for chart and series point objects if the series has leader lines.
    • [show_series_name boolean] -- Set to true to show the series name for the data label.
    • [show_category_name boolean] -- Set to true to show the category name for the data label.
    • [show_value boolean] -- Set to true to show the value for the data label.
    • [show_percentage boolean] -- Set to true to show the percentage for the data label.
    • [show_bubble_size boolean] -- Set to true to show the bubble size for the data label.
    • [separator unicode_text] -- The separator for the data label.
  • apply_layout -- Applies a chart layout.
    • chart
    • layout integer -- Specifies the type of layout, denoted by a number from 1 to 10.
    • [chart_type k.column_clustered / k.column_stacked / k.column_stacked_100 / k.ThreeD_column_clustered / k.ThreeD_column_stacked / k.ThreeD_column_stacked_100 / k.bar_clustered / k.bar_stacked / k.bar_stacked_100 / k.ThreeD_bar_clustered / k.ThreeD_bar_stacked / k.ThreeD_bar_stacked_100 / k.line_stacked / k.line_stacked_100 / k.line_markers / k.line_markers_stacked / k.line_markers_stacked_100 / k.pie_of_pie / k.pie_exploded / k.ThreeD_pie_exploded / k.bar_of_pie / k.xy_scatter_smooth / k.xy_scatter_smooth_no_markers / k.xy_scatter_lines / k.xy_scatter_lines_no_markers / k.area_stacked / k.area_stacked_100 / k.ThreeD_area_stacked / k.ThreeD_area_stacked_100 / k.doughnut_exploded / k.radar_markers / k.radar_filled / k.surface / k.surface_wireframe / k.surface_top_view / k.surface_top_view_wireframe / k.bubble / k.bubble_ThreeD_effect / k.stock_HLC / k.stock_OHLC / k.stock_VHLC / k.stock_VOHLC / k.cylinder_column_clustered / k.cylinder_column_stacked / k.cylinder_column_stacked_100 / k.cylinder_bar_clustered / k.cylinder_bar_stacked / k.cylinder_bar_stacked_100 / k.cylinder_column / k.cone_column_clustered / k.cone_column_stacked / k.cone_column_stacked_100 / k.cone_bar_clustered / k.cone_bar_stacked / k.cone_bar_stacked_100 / k.cone_col / k.pyramid_column_clustered / k.pyramid_column_stacked / k.pyramid_column_stacked_100 / k.pyramid_bar_clustered / k.pyramid_bar_stacked / k.pyramid_bar_stacked_100 / k.pyramid_column / k.ThreeD_column / k.line_chart / k.ThreeD_line / k.ThreeD_pie / k.pie_chart / k.xyscatter / k.ThreeD_area / k.area_chart / k.doughnut / k.radar / k.combination_chart] -- If specified, uses the layout from this chart type. For example, you can apply the layouts that are available from a line chart to a column chart. The layout only adds chart elements that are available for that particular chart type.
  • bring_to_front -- Brings the object to the front of the z-order.
  • chart_location -- Moves the chart to a new location.
    • chart
    • where k.location_as_new_sheet / k.location_as_object / k.location_automatic -- Where to move the chart.
    • [name unicode_text] -- The name of the sheet where the chart will be embedded if where is location as object or the name of the new sheet if where is location as new sheet.
    • Result: chart
  • chart_one_color_gradient -- Sets the specified fill to a one-color gradient.
    • k.chart_fill_format / k.chart_title / k.axis_title / k.series_point / k.series / k.data_label / k.legend_key / k.down_bars / k.floor / k.walls / k.plot_area / k.chart_area / k.legend / k.display_unit_label
    • gradient_style k.gradient_unset / k.horizontal_gradient / k.vertical_gradient / k.diagonal_up_gradient / k.diagonal_down_gradient / k.from_corner_gradient / k.from_title_gradient / k.from_center_gradient -- The gradient style.
    • variant integer -- The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the gradient tab in the fill effects dialog box. If gradient style is from center gradient, the variant argument can only be 1 or 2.
    • degree short_float -- The gradient degree. Can be a value from 0.0 dark, through 1.0 light.
  • chart_patterned -- Sets the specified fill to a pattern.
    • k.chart_fill_format / k.chart_title / k.axis_title / k.series_point / k.series / k.data_label / k.legend_key / k.down_bars / k.floor / k.walls / k.plot_area / k.chart_area / k.legend / k.display_unit_label
    • pattern k.pattern_unset / k.five_percent_pattern / k.ten_percent_pattern / k.twenty_percent_pattern / k.twenty_five_percent_pattern / k.thirty_percent_pattern / k.forty_percent_pattern / k.fifty_percent_pattern / k.sixty_percent_pattern / k.seventy_percent_pattern / k.seventy_five_percent_pattern / k.eighty_percent_pattern / k.ninety_percent_pattern / k.dark_horizontal_pattern / k.dark_vertical_pattern / k.dark_downward_diagonal_pattern / k.dark_upward_diagonal_pattern / k.small_checker_board_pattern / k.trellis_pattern / k.light_horizontal_pattern / k.light_vertical_pattern / k.light_downward_diagonal_pattern / k.light_upward_diagonal_pattern / k.small_grid_pattern / k.dotted_diamond_pattern / k.wide_downward_diagonal / k.wide_upward_diagonal_pattern / k.dashed_upward_diagonal_pattern / k.dashed_downward_diagonal_pattern / k.narrow_vertical_pattern / k.narrow_horizontal_pattern / k.dashed_vertical_pattern / k.dashed_horizontal_pattern / k.large_confetti_pattern / k.large_grid_pattern / k.horizontal_brick_pattern / k.large_checker_board_pattern / k.small_confetti_pattern / k.zig_zag_pattern / k.solid_diamond_pattern / k.diagonal_brick_pattern / k.outlined_diamond_pattern / k.plaid_pattern / k.sphere_pattern / k.weave_pattern / k.dotted_grid_pattern / k.divot_pattern / k.shingle_pattern / k.wave_pattern / k.horizontal_pattern / k.vertical_pattern / k.cross_pattern / k.downward_diagonal_pattern / k.upward_diagonal_pattern / k.diagonal_cross_pattern -- The pattern type.
  • chart_solid -- Sets the specified fill to a uniform color. Use this method to convert a gradient, textured, patterned, or background fill back to a solid fill.
    • k.chart_fill_format / k.chart_title / k.axis_title / k.series_point / k.series / k.data_label / k.legend_key / k.down_bars / k.floor / k.walls / k.plot_area / k.chart_area / k.legend / k.display_unit_label
  • chart_two_color_gradient -- Sets the specified fill to a two-color gradient.
    • k.chart_fill_format / k.chart_title / k.axis_title / k.series_point / k.series / k.data_label / k.legend_key / k.down_bars / k.floor / k.walls / k.plot_area / k.chart_area / k.legend / k.display_unit_label
    • gradient_style k.gradient_unset / k.horizontal_gradient / k.vertical_gradient / k.diagonal_up_gradient / k.diagonal_down_gradient / k.from_corner_gradient / k.from_title_gradient / k.from_center_gradient -- The gradient style.
    • variant integer -- The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the gradient tab in the fill effects dialog box. If gradient style is from center gradient, the variant argument can only be 1 or 2.
  • chart_user_picture -- Fills the specified shape with an image.
    • k.chart_fill_format / k.chart_title / k.axis_title / k.series_point / k.series / k.data_label / k.legend_key / k.down_bars / k.floor / k.walls / k.plot_area / k.chart_area / k.legend / k.display_unit_label
    • picture_file unicode_text -- The name of the picture file.
    • [picture_format k.chart_picture_type_stack_scale / k.chart_picture_type_stack / k.chart_picture_type_stretch] -- The picture format.
    • [picture_stack_unit integer] -- The picture stack or scale unit, depends on the picture format argument.
    • [picture_placement k.sides / k.end_ / k.end_sides / k.front / k.front_sides / k.front_end / k.all_faces] -- The picture placement.
  • chart_user_textured -- Fills the specified shape with small tiles of an image.
    • k.chart_fill_format / k.chart_title / k.axis_title / k.series_point / k.series / k.data_label / k.legend_key / k.down_bars / k.floor / k.walls / k.plot_area / k.chart_area / k.legend / k.display_unit_label
    • texture_file unicode_text -- The name of the picture file.
  • chart_wizard -- Modifies the properties of the given chart. You can use this method to quickly format a chart without setting all the individual properties. This method is noninteractive, and it changes only the specified properties.
    • chart
    • [source range] -- The range that contains the source data for the new chart. If this argument is omitted, Microsoft Excel edits the active chart sheet or the selected chart on the active worksheet.
    • [gallery k.column_clustered / k.column_stacked / k.column_stacked_100 / k.ThreeD_column_clustered / k.ThreeD_column_stacked / k.ThreeD_column_stacked_100 / k.bar_clustered / k.bar_stacked / k.bar_stacked_100 / k.ThreeD_bar_clustered / k.ThreeD_bar_stacked / k.ThreeD_bar_stacked_100 / k.line_stacked / k.line_stacked_100 / k.line_markers / k.line_markers_stacked / k.line_markers_stacked_100 / k.pie_of_pie / k.pie_exploded / k.ThreeD_pie_exploded / k.bar_of_pie / k.xy_scatter_smooth / k.xy_scatter_smooth_no_markers / k.xy_scatter_lines / k.xy_scatter_lines_no_markers / k.area_stacked / k.area_stacked_100 / k.ThreeD_area_stacked / k.ThreeD_area_stacked_100 / k.doughnut_exploded / k.radar_markers / k.radar_filled / k.surface / k.surface_wireframe / k.surface_top_view / k.surface_top_view_wireframe / k.bubble / k.bubble_ThreeD_effect / k.stock_HLC / k.stock_OHLC / k.stock_VHLC / k.stock_VOHLC / k.cylinder_column_clustered / k.cylinder_column_stacked / k.cylinder_column_stacked_100 / k.cylinder_bar_clustered / k.cylinder_bar_stacked / k.cylinder_bar_stacked_100 / k.cylinder_column / k.cone_column_clustered / k.cone_column_stacked / k.cone_column_stacked_100 / k.cone_bar_clustered / k.cone_bar_stacked / k.cone_bar_stacked_100 / k.cone_col / k.pyramid_column_clustered / k.pyramid_column_stacked / k.pyramid_column_stacked_100 / k.pyramid_bar_clustered / k.pyramid_bar_stacked / k.pyramid_bar_stacked_100 / k.pyramid_column / k.ThreeD_column / k.line_chart / k.ThreeD_line / k.ThreeD_pie / k.pie_chart / k.xyscatter / k.ThreeD_area / k.area_chart / k.doughnut / k.radar / k.combination_chart] -- Specifies he chart type.
    • [format integer] -- The option number for the built-in autoformats. Can be a number from 1 through 10, depending on the gallery type. If this argument is omitted, Microsoft Excel chooses a default value based on the gallery type and data source.
    • [plot_by k.by_columns / k.by_rows] -- Specifies whether the data for each series is in rows or columns.
    • [category_labels integer] -- An integer specifying the number of rows or columns within the source range that contain category labels. Legal values are from zero through one less than the maximum number of the corresponding categories or series.
    • [series_labels integer] -- An integer specifying the number of rows or columns within the source range that contain series labels. Legal values are from zero through one less than the maximum number of the corresponding categories or series.
    • [has_legend boolean] -- Set to true to include a legend.
    • [title unicode_text] -- Specifies the chart title text.
    • [category_title unicode_text] -- Specifies the category axis title text.
    • [value_title unicode_text] -- Specifies the value axis title text.
    • [extra_title unicode_text] -- Specifies the series axis title for 3-D charts or the second value axis title for 2-D charts.
  • check_spelling -- Checks the spelling of an object.
    • chart
    • [custom_dictionary unicode_text] -- A string that indicates the file name of the custom dictionary to examine if the word isn't found in the main dictionary. If this argument is omitted, the currently specified dictionary is used.
    • [ignore_uppercase boolean] -- Set to true to have Microsoft Excel ignore words that are all uppercase. False to have Microsoft Excel check words that are all uppercase.
    • [always_suggest boolean] -- Set to true to have Microsoft Excel display a list of suggested alternate spellings when an incorrect spelling is found. False to have Microsoft Excel wait for you to input the correct spelling.
  • clear -- Clear the object.
    • k.chart_area / k.legend
  • clear_contents -- Clears the data from a chart but leaves the formatting.
  • clear_formats -- Clears the formatting of the object.
    • k.series_point / k.series / k.legend_key / k.trendline / k.floor / k.walls / k.plot_area / k.chart_area / k.error_bars
  • clear_to_match_style -- Sets the chart formatting to the last predefined chart style applied.
  • copy_chart_as_picture -- Copies the selected object to the clipboard as a picture.
    • chart
    • [appearance k.printer / k.screen] -- Specifies how the picture should be copied.
    • [format k.bitmap / k.picture] -- The format of the picture.
    • [output_size k.printer / k.screen] -- The size of the copied picture when the object is a chart on a chart sheet, not embedded on a worksheet.
  • copy_object -- Copies the object to the clipboard.
    • k.chart_object / k.series_point / k.series / k.chart_area
  • copy_picture -- Copies the selected object to the clipboard as a picture.
    • chart_object
    • [appearance k.printer / k.screen] -- Specifies how the picture should be copied.
    • [format k.bitmap / k.picture] -- The format of the picture.
  • cut -- Cuts the object to the clipboard.
  • delete_object -- Deletes the object.
    • k.chart_object / k.axis
  • deselect -- Cancels the selection for the specified chart.
  • error_bar -- Applies error bars to the series.
    • series
    • direction k.error_bar_direction_x / k.error_bar_direction_y -- The error bar direction.
    • include k.error_bar_include_both / k.error_bar_include_minus_values / k.error_bar_include_none / k.error_bar_include_plus_values -- The error bar parts to include.
    • type k.error_bar_type_custom / k.error_bar_type_fixed_value / k.error_bar_type_percent / k.error_bar_type_standard_deviation / k.error_bar_type_standard_error -- The error bar type.
    • [amount float] -- The error amount. Used for only the positive error amount when type is error bar type custom.
    • [minus_values float] -- The negative error amount when type is error bar type custom.
  • get_axis -- Returns an object that represents a specified axis object.
    • chart
    • axis_type k.category_axis / k.series_axis / k.value_axis
    • [which_axis k.primary_axis / k.secondary_axis]
    • Result: axis
  • get_chart_element -- Returns information about the chart element at specified X and Y coordinates. This method returns a list of three items. Please refer to the documentation on the meaning of the returned values.
    • chart
    • x integer -- The X coordinate of the chart element.
    • y integer -- The Y coordinate of the chart element.
    • Result: list -- The list of returned values.
  • get_has_axis -- Returns which axes exist on the chart.
    • chart
    • [axis_type k.category_axis / k.series_axis / k.value_axis] -- Specifies the axis type.
    • [axis_group k.primary_axis / k.secondary_axis] -- Specifies the axis group.
    • Result: boolean -- Returns true if the specified axis exists.
  • paste
    • k.floor / k.walls
  • paste_chart -- Pastes chart data from the clipboard into the specified chart.
    • chart
    • [format k.paste_all / k.paste_all_using_source_theme / k.paste_all_except_borders / k.paste_formats / k.paste_formulas / k.paste_comments / k.paste_values / k.paste_column_widths / k.paste_validation / k.paste_formulas_and_number_formats / k.paste_values_and_number_formats]
  • paste_series
  • preset_chart_gradient -- Sets the specified fill to a preset gradient.
    • k.chart_fill_format / k.chart_title / k.axis_title / k.series_point / k.series / k.data_label / k.legend_key / k.down_bars / k.floor / k.walls / k.plot_area / k.chart_area / k.legend / k.display_unit_label
    • gradient_style k.gradient_unset / k.horizontal_gradient / k.vertical_gradient / k.diagonal_up_gradient / k.diagonal_down_gradient / k.from_corner_gradient / k.from_title_gradient / k.from_center_gradient -- The gradient style.
    • variant integer -- The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the gradient tab in the fill effects dialog box. If gradient style is from center gradient, the variant argument can only be 1 or 2.
    • preset_gradient_type k.preset_gradient_unset / k.gradient_early_sunset / k.gradient_late_sunset / k.gradient_nightfall / k.gradient_daybreak / k.gradient_horizon / k.gradient_desert / k.gradient_ocean / k.gradient_calm_water / k.gradient_fire / k.gradient_fog / k.gradient_moss / k.gradient_peacock / k.gradient_wheat / k.gradient_parchment / k.gradient_mahogany / k.gradient_rainbow / k.gradient_rainbow2 / k.gradient_gold / k.gradient_gold2 / k.gradient_brass / k.gradient_chrome / k.gradient_chrome2 / k.gradient_silver / k.gradient_sapphire -- The gradient type.
  • preset_chart_textured -- Sets the specified fill format to a preset texture.
    • k.chart_fill_format / k.chart_title / k.axis_title / k.series_point / k.series / k.data_label / k.legend_key / k.down_bars / k.floor / k.walls / k.plot_area / k.chart_area / k.legend / k.display_unit_label
    • preset_texture_for_chart k.preset_texture_unset / k.texture_papyrus / k.texture_canvas / k.texture_denim / k.texture_woven_mat / k.texture_water_droplets / k.texture_paper_bag / k.texture_fish_fossil / k.texture_sand / k.texture_green_marble / k.texture_white_marble / k.texture_brown_marble / k.texture_granite / k.texture_newsprint / k.texture_recycled_paper / k.texture_parchment / k.texture_stationery / k.texture_blue_tissue_paper / k.texture_pink_tissue_paper / k.texture_purple_mesh / k.texture_bouquet / k.texture_cork / k.texture_walnut / k.texture_oak / k.texture_medium_wood -- The preset texture.
  • print_out -- Prints the object
    • chart
    • [from_ integer] -- The number of the page at which to start printing. If this argument is omitted, printing starts at the beginning.
    • [to integer] -- The number of the last page to print. If this argument is omitted, printing ends with the last page.
    • [copies integer] -- The number of copies to print. If this argument is omitted, one copy is printed.
    • [preview boolean] -- Set to true to have Microsoft Excel invoke print preview before printing the object.
    • [active_printer unicode_text] -- Sets the name of the active printer.
    • [print_to_file boolean] -- Set to true to print to a file.
    • [collate boolean] -- Set to true to collate multiple copies.
  • print_preview -- Shows a preview of the object as it would look when printed. This function is deprecated.
    • chart
    • [enable_changes boolean] -- Controls access to the page setup dialog and the ability to change margins from the preview window by enabling or disabling the setup and margins buttons, respectively.
  • protect_chart -- Protects a chart so that it cannot be modified.
    • chart
    • [password unicode_text] -- A string that specifies a case-sensitive password for the sheet or workbook. If this argument is omitted, you can unprotect the sheet or workbook without using a password. Otherwise, you must specify the password to unprotect the sheet or workbook.
    • [drawing_objects boolean] -- Set to true to protect shapes. The default value is false.
    • [chart_contents boolean] -- Set to true to protect contents. The default value is true.
    • [user_interface_only boolean] -- Set to true to protect the user interface, but not macros. If this argument is omitted, protection applies both to macros and to the user interface.
  • refresh -- Updates the cache of the chart object.
  • save_as -- Saves changes into a different file.
    • chart
    • filename unicode_text -- A string that indicates the name of the file to be saved. You can include a full path, if you don't, Microsoft Excel saves the file in the current folder.
    • [file_format k.CSV_file_format / k.CSV_Mac_file_format / k.CSV_MSDos_file_format / k.CSV_Windows_file_format / k.DBF3_file_format / k.DBF4_file_format / k.DIF_file_format / k.Excel2_file_format / k.Excel_2_east_asian_file_format / k.Excel3_file_format / k.Excel4_file_format / k.Excel5_file_format / k.Excel7_file_format / k.Excel_4_workbook_file_format / k.international_add_in_file_format / k.international_macro_file_format / k.workbook_normal_file_format / k.SYLK_file_format / k.current_platform_text_file_format / k.text_Mac_file_format / k.text_MSDos_file_format / k.text_printer_file_format / k.text_windows_file_format / k.HTML_file_format / k.XML_spreadsheet_file_format / k.PDF_file_format / k.Excel_binary_file_format / k.Excel_XML_file_format / k.macro_enabled_XML_file_format / k.macro_enabled_template_file_format / k.template_file_format / k.add_in_file_format / k.Excel98to2004_file_format / k.Excel98to2004_template_file_format / k.Excel98to2004_add_in_file_format] -- Specifies the file format to use when you save the file.
    • [password unicode_text] -- A case-sensitive string, no more than 15 characters, that indicates the protection password to be given to the file.
    • [write_reservation_password unicode_text] -- A string that indicates the write-reservation password for this file. If a file is saved with the password and the password isn't supplied when the file is opened, the file is opened as read-only.
    • [read_only_recommended boolean] -- Set to true to display a message when the file is opened, recommending that the file be opened as read-only.
    • [create_backup boolean] -- Set to true to create a backup file.
    • [add_to_most_recently_used_list boolean] -- Set to true to add this workbook to the list of recently used files. The default value is false.
    • [save_as_local_language boolean] -- True saves files against the language of Microsoft Excel. False is the default, which saves files against the language of Visual Basic for Applications
  • save_as_picture -- Saves the shape in the requested file using the stated graphic format
    • chart_object
    • [picture_type k.save_as_default / k.save_as_PNG_file / k.save_as_BMP_file / k.save_as_GIF_file / k.save_as_JPG_file / k.save_as_PDF_file] -- Specifies the graphic format in which the file is saved
    • [file_name unicode_text] -- The name and path for the picture being saved
  • send_to_back -- Sends the object to the back of the z-order.
  • set_background_picture -- Sets the background graphic for a chart.
    • chart
    • [picture_file_name unicode_text] -- The name of the graphic file.
  • set_chart_element -- Sets chart elements on a chart.
    • chart
    • chart_element null -- Specifies the chart element type.
  • set_has_axis -- Sets which axes exist on the chart.
    • chart
    • axis_exists boolean -- Specifies if the specified axis should exist.
    • [axis_type k.category_axis / k.series_axis / k.value_axis] -- Specifies the axis type.
    • [axis_group k.primary_axis / k.secondary_axis] -- Specifies the axis group.
  • set_source_data -- Sets the source data range for the chart.
    • chart
    • source range -- The range that contains the source data.
    • [plot_by k.by_columns / k.by_rows] -- Specifies the way the data is to be plotted.
  • unprotect -- Removes protection from a sheet or workbook. This method has no effect if the sheet or workbook isn't protected.
    • chart
    • [password unicode_text] -- A string that denotes the case-sensitive password to use to unprotect the sheet or workbook. If you omit this argument for a sheet that's protected with a password, you'll be prompted for the password.

Classes

  • area_group
  • axis_title -- Represents a chart axis title.
    • Plural name:
      • axis_titles
    • Inherits from:
    • Properties:
      • auto_scale_font boolean -- Returns or sets if the text in the object changes font size when the object size changes.
      • axis_title_text unicode_text -- Returns or sets the text associated with this object.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • caption unicode_text -- Returns or sets the caption for this object.
      • chart_fill_format_object (r/o) chart_fill_format -- Returns a chart fill format object for this object.
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • horizontal_alignment k.horizontal_align_center / k.horizontal_align_center_across_selection / k.horizontal_align_distributed / k.horizontal_align_fill / k.horizontal_align_general / k.horizontal_align_justify / k.horizontal_align_left / k.horizontal_align_right -- Returns or sets the horizontal alignment for the object.
      • include_in_layout boolean -- Returns or sets if a axis title will occupy the chart layout space when a chart layout is being determined.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • left_position float -- Returns or sets the left position of the specified object, in points.
      • name (r/o) unicode_text -- Returns the name of the object.
      • orientation integer -- The text orientation. Can be a number value from -90 to 90 degrees.
      • position k.automatic / k.custom -- Returns or sets the position of the axis title on the chart.
      • reading_order k.left_to_right / k.right_to_left / k.context -- Returns or sets the reading order for the specified object.
      • shadow boolean -- Returns or sets if the object has a shadow.
      • top float -- Returns or sets the top position of the specified object, in points.
      • vertical_alignment k.vertical_alignment_top / k.vertical_alignment_center / k.vertical_alignment_bottom / k.vertical_alignment_justify / k.vertical_alignment_distributed -- Returns or sets the vertical alignment of the object.
    • Elements:
  • axis -- Represents a single axis in a chart.
    • Plural name:
      • axes
    • Inherits from:
    • Properties:
      • axis_between_categories boolean -- Returns or sets if the value axis crosses the category axis between categories.
      • axis_group (r/o) k.primary_axis / k.secondary_axis -- Returns the group for the specified axis.
      • axis_title (r/o) axis_title -- Returns an axis title object that represents the title of the specified axis.
      • axis_type k.category_axis / k.series_axis / k.value_axis -- Returns or sets the axis type
      • base_unit k.days / k.months / k.years -- Returns or sets the base unit for the specified category axis.
      • base_unit_is_auto boolean -- Returns or sets if Microsoft Excel chooses appropriate base units for the specified category axis.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • category_names k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_category_names -- Returns or sets all the category names for the specified axis, as a text array. When you set this property, you can set it to either an array or a range object that contains the category names.
      • category_type k.category_scale / k.time_scale / k.automatic_scale -- Returns or sets the category axis type.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the axis.
      • crosses k.axis_crosses_automatic / k.axis_crosses_custom / k.axis_crosses_maximum / k.axis_crosses_minimum -- Returns or sets the point on the specified axis where the other axis crosses.
      • crosses_at float -- Returns or sets the point on the value axis where the category axis crosses it. Applies only to the value axis.
      • display_unit k.hundreds / k.thousands / k.ten_thousands / k.hundred_thousands / k.millions / k.ten_millions / k.hundred_millions / k.thousand_millions / k.million_millions / k.custom_display_unit -- Returns or sets the unit label for the specified axis.
      • display_unit_custom float -- If the value of the display unit property is custom display unit, the display unit custom property returns or sets the value of the displayed units.
      • display_unit_label (r/o) display_unit_label -- Returns the display unit label object for the specified axis
      • has_display_unit_label boolean -- Returns or sets if the label specified by the display unit or display unit custom property is displayed on the specified axis. The default value is true.
      • has_major_gridlines boolean -- Returns or sets if the axis has major gridlines. Only axes in the primary axis group can have gridlines.
      • has_minor_gridlines boolean -- Returns or sets if the axis has minor gridlines. Only axes in the primary axis group can have gridlines.
      • has_title boolean -- Returns or sets if the axis or chart has a visible title.
      • height (r/o) float -- Returns the height of the object.
      • left_position (r/o) float -- Returns the left position of the specified object, in points.
      • log_base float -- Returns or sets the base of the logarithm when you are using log scales.
      • major_gridlines (r/o) gridlines -- Returns a gridlines object that represents the major gridlines for the specified axis. Only axes in the primary axis group can have gridlines.
      • major_tick_mark k.tick_mark_cross / k.tick_mark_inside / k.tick_mark_none / k.tick_mark_outside -- Returns or sets the type of major tick mark for the specified axis.
      • major_unit float -- Returns or sets the major units for the axis.
      • major_unit_is_auto boolean -- Returns or sets if Microsoft Excel calculates the major units for the axis.
      • major_unit_scale k.days / k.months / k.years -- Returns or sets the major unit scale value for the category axis when the category type property is set to time scale.
      • maximum_scale float -- Returns or sets the maximum value on the axis.
      • maximum_scale_is_auto boolean -- Returns or sets if Microsoft Excel calculates the maximum value for the axis.
      • minimum_scale float -- Returns or sets the minimum value on the axis.
      • minimum_scale_is_auto boolean -- Returns or sets if Microsoft Excel calculates the minimum value for the axis.
      • minor_gridlines (r/o) gridlines -- Returns a gridlines object that represents the minor gridlines for the specified axis. Only axes in the primary axis group can have gridlines.
      • minor_tick_mark k.tick_mark_cross / k.tick_mark_inside / k.tick_mark_none / k.tick_mark_outside -- Returns or sets the type of minor tick mark for the specified axis.
      • minor_unit float -- Returns or sets the minor units on the axis.
      • minor_unit_is_auto boolean -- Returns or sets if Microsoft Excel calculates minor units for the axis.
      • minor_unit_scale k.days / k.months / k.years -- Returns or sets the minor unit scale value for the category axis when the category type property is set to time scale.
      • reverse_plot_order boolean -- Returns or sets if Microsoft Excel plots data points from last to first.
      • scale_type k.scale_linear / k.scale_logarithmic -- Returns or sets the value axis scale type.
      • tick_label_position k.tick_label_position_high / k.tick_label_position_low / k.tick_label_position_next_to_axis / k.tick_label_position_none -- Describes the position of tick-mark labels on the specified axis.
      • tick_label_spacing integer -- Returns or sets the number of categories or series between tick-mark labels. Applies only to category and series axes.
      • tick_label_spacing_is_auto boolean -- Returns or sets whether or not the tick label spacing is automatic.
      • tick_labels (r/o) tick_labels -- Returns a tick labels object that represents the tick-mark labels for the specified axis.
      • tick_mark_spacing integer -- Returns or sets the number of categories or series between tick marks. Applies only to category and series axes.
      • top (r/o) float -- Returns the top position of the specified object, in points.
      • width (r/o) float -- Returns the width of the object.
  • bar_group
  • chart_area -- Represents the chart area of a chart. The chart area on a 2-D chart contains the axes, the chart title, the axis titles, and the legend. The chart area on a 3-D chart contains the chart title and the legend; it doesn't include the plot area .
    • Plural name:
      • chart_areas
    • Inherits from:
    • Properties:
      • auto_scale_font boolean -- Returns or sets if the text in the object changes font size when the object size changes.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_fill_format_object (r/o) chart_fill_format -- Returns a chart fill format object for this object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the chart area.
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • height float -- Returns or sets the height of the object.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • left_position float -- Returns or sets the left position of the specified object, in points.
      • name (r/o) unicode_text -- Returns the name of the object.
      • rounded_corners (r/o) boolean -- Returns or sets if the chart area has rounded corners.
      • shadow boolean -- Returns or sets if the object has a shadow.
      • top float -- Returns or sets the top position of the specified object, in points.
      • width float -- Returns or sets the width of the object.
  • chart_fill_format -- Used only with charts. Represents fill formatting for chart elements.
    • Plural name:
      • chart_fill_formats
    • Inherits from:
    • Properties:
      • back_color (r/o) RGB_color -- Returns the background color.
      • background_scheme_color integer -- Returns or sets the background color as an index in the current color scheme.
      • chart_fill_format_type (r/o) k.fill_unset / k.fill_solid / k.fill_patterned / k.fill_gradient / k.fill_textured / k.fill_background / k.fill_picture -- The fill type.
      • fore_color (r/o) RGB_color -- Returns the foreground color.
      • foreground_scheme_color integer -- Returns or sets the foreground color as an index in the current color scheme.
      • gradient_color_type (r/o) k.gradient_type_unset / k.single_shade_gradient_type / k.two_colors_gradient_type / k.preset_colors_gradient_type / k.multi_colors_gradient_type -- Returns the gradient color type for the specified fill.
      • gradient_degree (r/o) short_float -- Returns the gradient degree of the specified one-color shaded fill as a floating-point value from 0.0 dark through 1.0 light.
      • gradient_style (r/o) k.gradient_unset / k.horizontal_gradient / k.vertical_gradient / k.diagonal_up_gradient / k.diagonal_down_gradient / k.from_corner_gradient / k.from_title_gradient / k.from_center_gradient -- Returns the gradient style for the specified fill.
      • gradient_variant (r/o) integer -- Returns the shade variant for the specified fill as an integer value from 1 through 4.
      • pattern (r/o) k.pattern_unset / k.five_percent_pattern / k.ten_percent_pattern / k.twenty_percent_pattern / k.twenty_five_percent_pattern / k.thirty_percent_pattern / k.forty_percent_pattern / k.fifty_percent_pattern / k.sixty_percent_pattern / k.seventy_percent_pattern / k.seventy_five_percent_pattern / k.eighty_percent_pattern / k.ninety_percent_pattern / k.dark_horizontal_pattern / k.dark_vertical_pattern / k.dark_downward_diagonal_pattern / k.dark_upward_diagonal_pattern / k.small_checker_board_pattern / k.trellis_pattern / k.light_horizontal_pattern / k.light_vertical_pattern / k.light_downward_diagonal_pattern / k.light_upward_diagonal_pattern / k.small_grid_pattern / k.dotted_diamond_pattern / k.wide_downward_diagonal / k.wide_upward_diagonal_pattern / k.dashed_upward_diagonal_pattern / k.dashed_downward_diagonal_pattern / k.narrow_vertical_pattern / k.narrow_horizontal_pattern / k.dashed_vertical_pattern / k.dashed_horizontal_pattern / k.large_confetti_pattern / k.large_grid_pattern / k.horizontal_brick_pattern / k.large_checker_board_pattern / k.small_confetti_pattern / k.zig_zag_pattern / k.solid_diamond_pattern / k.diagonal_brick_pattern / k.outlined_diamond_pattern / k.plaid_pattern / k.sphere_pattern / k.weave_pattern / k.dotted_grid_pattern / k.divot_pattern / k.shingle_pattern / k.wave_pattern / k.horizontal_pattern / k.vertical_pattern / k.cross_pattern / k.downward_diagonal_pattern / k.upward_diagonal_pattern / k.diagonal_cross_pattern -- Returns the fill pattern.
      • preset_gradient_type (r/o) k.preset_gradient_unset / k.gradient_early_sunset / k.gradient_late_sunset / k.gradient_nightfall / k.gradient_daybreak / k.gradient_horizon / k.gradient_desert / k.gradient_ocean / k.gradient_calm_water / k.gradient_fire / k.gradient_fog / k.gradient_moss / k.gradient_peacock / k.gradient_wheat / k.gradient_parchment / k.gradient_mahogany / k.gradient_rainbow / k.gradient_rainbow2 / k.gradient_gold / k.gradient_gold2 / k.gradient_brass / k.gradient_chrome / k.gradient_chrome2 / k.gradient_silver / k.gradient_sapphire -- Returns the preset gradient type for the specified fill.
      • preset_texture (r/o) k.preset_texture_unset / k.texture_papyrus / k.texture_canvas / k.texture_denim / k.texture_woven_mat / k.texture_water_droplets / k.texture_paper_bag / k.texture_fish_fossil / k.texture_sand / k.texture_green_marble / k.texture_white_marble / k.texture_brown_marble / k.texture_granite / k.texture_newsprint / k.texture_recycled_paper / k.texture_parchment / k.texture_stationery / k.texture_blue_tissue_paper / k.texture_pink_tissue_paper / k.texture_purple_mesh / k.texture_bouquet / k.texture_cork / k.texture_walnut / k.texture_oak / k.texture_medium_wood -- Returns the preset texture for the specified fill.
      • texture_name (r/o) unicode_text -- Returns the name of the custom texture file for the specified fill.
      • texture_type (r/o) k.texture_type_texture_type_unset / k.texture_type_preset_texture / k.texture_type_user_defined_texture -- Returns the texture type for the specified fill.
      • transparency short_float -- Returns or sets the degree of transparency of the specified fill, shadow, or line as a value between 0.0, opaque, and 1.0, clear.
      • visible boolean -- Returns or sets if the specified object is visible.
  • chart_format -- Provides access to the Office Art formatting for chart elements.
    • Inherits from:
    • Properties:
      • fill_format (r/o) fill_format -- Returns a fill format object for the parent chart element that contains fill formatting properties for the chart element.
      • glow_format (r/o) glow_format -- Returns a glow format object for a specified chart that contains glow formatting properties for the chart.
      • line_format (r/o) line_format -- Returns a line format object that contains line formatting properties for the specified chart element.
      • shadow_format (r/o) shadow_format -- Returns a shadow format object that contains shadow formatting properties for the chart element.
      • shape_text_frame (r/o) shape_text_frame -- Returns a shape text frame object that contains the alignment and anchoring properties for the specified chart.
      • soft_edge_format (r/o) soft_edge_format -- Returns the formatting properties for a soft edge effect.
      • threeD_format (r/o) threeD_format -- Returns a threeD format object that contains 3-D-effect formatting properties for the specified chart.
  • chart_group -- Represents one or more series plotted in a chart with the same format. A chart contains one or more chart groups, each chart group contains one or more series, and each series contains one or more points.
    • Plural name:
      • chart_groups
    • Inherits from:
    • Inherited by:
    • Properties:
      • axis_group k.primary_axis / k.secondary_axis
      • bubble_scale integer -- Returns or sets the scale factor for bubbles in the specified chart group. Can be an integer value from zero to 300, corresponding to a percentage of the default size. Applies only to bubble charts.
      • doughnut_hole_size integer -- Returns or sets the size of the hole in a doughnut chart group. The hole size is expressed as a percentage of the chart size, between 10 and 90 percent.
      • down_bars_object (r/o) down_bars -- Returns a down bars object that represents the down bars on a line chart. Applies only to line charts.
      • drop_lines_object (r/o) drop_lines -- Returns a drop lines object that represents the drop lines for a series on a line chart or area chart. Applies only to line charts or area charts.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • first_slice_angle integer -- Returns or sets the angle of the first pie-chart or doughnut-chart slice, in degrees, clockwise from vertical. Applies only to pie, 3-D pie, and doughnut charts.
      • gap_width integer -- Returns or sets: For bar and column charts, the space between bar or column clusters, as a percentage of the bar or column width. For pie of pie and bar of pie charts, the space between the primary and secondary sections of the chart.
      • has_drop_lines boolean -- Returns or sets if the line chart or area chart has drop lines. Applies only to line and area charts.
      • has_hi_lo_lines boolean -- Returns or sets if the line chart has high-low lines. Applies only to line charts.
      • has_radar_axis_labels boolean -- Returns or sets if a radar chart has axis labels. Applies only to radar charts.
      • has_series_lines boolean -- Returns or sets if a stacked column chart or bar chart has series lines or if a pie of pie chart or bar of pie chart has connector lines between the two sections. Applies only to stacked column charts, bar charts, pie of pie charts, or bar of pie charts.
      • has_threeD_shading boolean -- Returns or sets if the chart group has three-dimensional shading.
      • has_up_down_bars boolean -- Returns or sets if a line chart has up and down bars. Applies only to line charts.
      • hilo_lines_Object (r/o) hilo_lines -- Returns a hilo lines object that represents the high-low lines for a series on a line chart.
      • overlap integer -- Returns or sets how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and 2-D column charts.
      • radar_axis_labels (r/o) tick_labels -- Returns a tick labels object that represents the radar axis labels for the specified chart group.
      • second_plot_size integer -- Returns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200.
      • series_lines_object (r/o) series_lines -- Returns a series lines object that represents the series lines for a stacked bar chart or a stacked column chart. Applies only to stacked bar and stacked column charts.
      • show_negative_bubbles boolean -- Returns or sets if negative bubbles are shown for the chart group. Valid only for bubble charts.
      • size_represents k.size_is_width / k.size_is_area -- Returns or sets what the bubble size represents on a bubble chart.
      • split_type k.split_by_position / k.split_by_percent_value / k.split_by_custom_split / k.split_by_value -- Returns or sets the way the two sections of either a pie of pie chart or a bar of pie chart are split.
      • split_value integer -- Returns or sets the threshold value separating the two sections of either a pie of pie chart or a bar of pie chart.
      • up_bars_object (r/o) up_bars -- Returns an up bars object that represents the up bars on a line chart. Applies only to line charts.
      • vary_by_categories boolean -- Returns or sets if Microsoft Excel assigns a different color or pattern to each data marker. The chart must contain only one series.
    • Elements:
  • chart_object -- Represents an embedded chart on a worksheet. The chart object object acts as a container for a chart object. Properties and methods for the chart object object control the appearance and size of the embedded chart on the worksheet.
    • Plural name:
      • chart_objects
    • Inherits from:
    • Properties:
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • bottom_right_cell (r/o) range -- Returns a range object that represents the cell that lies under the lower-right corner of the object.
      • chart (r/o) chart -- Returns a chart object that represents the chart contained in the object.
      • enabled boolean -- Returns or sets if the object is enabled.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • height float -- Returns or set the height of the object.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • left_position float -- Returns or sets the position of the specified object, in points.
      • locked boolean -- Returns or sets if the object is locked, if false the object can be modified when the sheet is protected.
      • name unicode_text -- Returns or sets the name of the object.
      • on_action unicode_text -- Returns or sets the name of a string of AppleScript commands that will be executed when the object is clicked on. Please note that if AppleScript commands are set they will not be saved with the document.
      • placement k.placement_free_floating / k.placement_move / k.placement_move_and_size -- Returns or sets the way the object is attached to the cells below it.
      • print_object boolean -- Returns or sets if this object is printed.
      • protect_chart_object boolean -- Returns or sets if the embedded chart frame cannot be moved, resized, or deleted.
      • rounded_corners boolean -- Returns or sets if the embedded chart has rounded corners.
      • shadow boolean -- Returns or sets if the if the object has a shadow.
      • top float -- Returns or sets the distance from the top edge of the object to the top of row 1, on a worksheet, or the top of the chart area, on a chart.
      • top_left_cell (r/o) range -- Returns a range object that represents the cell that lies under the upper-left corner of the specified object.
      • visible boolean -- Returns or sets if the object is visible.
      • width float -- Returns or sets the width of the object.
      • z_order_position (r/o) integer -- Returns the z-order position of the object.
  • chart_sheet -- A chart sheet is a worksheet that contains only a chart.
    • Plural name:
      • chart_sheets
    • Inherits from:
    • Properties:
      • chart (r/o) chart -- Returns the chart for this chart sheet.
      • worksheet_type (r/o) k.sheet_type_chart / k.sheet_type_dialog_sheet / k.sheet_type_excel_4_intl_macro_sheet / k.sheet_type_excel_4_macro_sheet / k.sheet_type_worksheet -- Returns the type of this worksheet.
  • chart_title -- Represents the chart title.
    • Plural name:
      • chart_titles
    • Inherits from:
    • Properties:
      • auto_scale_font boolean -- Returns or sets if the text in the object changes font size when the object size changes.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • caption unicode_text -- Returns or sets the chart title text.
      • chart_fill_format_object (r/o) chart_fill_format -- Returns a chart fill format object for this object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the chart title.
      • chart_title_text unicode_text -- Returns or sets the text for the specified object.
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • formula unicode_text -- Returns or sets the object's formula, in A1-style notation and in the language of the macro.
      • formula_local unicode_text -- Returns or sets the formula for the object, using A1-style references in the language of the user.
      • formula_r1c1 unicode_text -- Returns or sets the formula for the object, using R1C1-style notation in the language of the macro.
      • formula_r1c1_local unicode_text -- Returns or sets the formula for the object, using R1C1-style notation in the language of the user.
      • height (r/o) float -- Returns the height of the object.
      • horizontal_alignment k.horizontal_align_center / k.horizontal_align_center_across_selection / k.horizontal_align_distributed / k.horizontal_align_fill / k.horizontal_align_general / k.horizontal_align_justify / k.horizontal_align_left / k.horizontal_align_right -- Returns or sets the horizontal alignment for the object.
      • include_in_layout boolean -- Returns or sets if a chart title will occupy the chart layout space when a chart layout is being determined.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • left_position float -- Returns or sets the left position of the specified object, in points.
      • name (r/o) unicode_text -- Returns the name of the object.
      • orientation k.orientation_downward / k.orientation_horizontal / k.orientation_upward / k.orientation_vertical -- May also be a number value from -90 to 90 degrees.
      • position k.automatic / k.custom -- Returns or sets the position of the chart title on the chart.
      • reading_order k.left_to_right / k.right_to_left / k.context -- Returns or sets the reading order for the specified object.
      • shadow boolean -- Returns or sets if the object has a shadow.
      • top float -- Returns or sets the top position of the specified object, in points.
      • vertical_alignment k.vertical_alignment_top / k.vertical_alignment_center / k.vertical_alignment_bottom / k.vertical_alignment_justify / k.vertical_alignment_distributed -- Returns or sets the vertical alignment of the object.
      • width (r/o) float -- Returns the width of the object.
    • Elements:
  • chart -- Represents a chart in a workbook. The chart can be either an embedded chart, contained in a chart object, or a separate chart sheet.
    • Plural name:
      • charts
    • Inherits from:
    • Inherited by:
    • Properties:
      • area_threeD_group (r/o) chart_group -- Returns a chart group object that represents the area chart group on a 3-D chart.
      • auto_scaling boolean -- Returns or sets if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart. The chart's right angle axes property must be true.
      • back_wall (r/o) walls -- Returns a walls object that allows the user to individually format the back wall of a 3-D chart.
      • bar_shape k.box / k.pyramid_to_point / k.pyramid_to_max / k.cylinder / k.cone_to_point / k.cone_to_max -- Returns or sets the shape used with the 3-D bar or column chart.
      • bar_threeD_group (r/o) chart_group -- Returns a chart group object that represents the bar chart group on a 3-D chart.
      • chart_area_object (r/o) chart_area -- Returns a chart area object that represents the complete chart area for the chart.
      • chart_style integer -- Returns or sets the chart type.
      • chart_title (r/o) chart_title -- Returns a chart title object that represents the title of the specified chart.
      • chart_type k.column_clustered / k.column_stacked / k.column_stacked_100 / k.ThreeD_column_clustered / k.ThreeD_column_stacked / k.ThreeD_column_stacked_100 / k.bar_clustered / k.bar_stacked / k.bar_stacked_100 / k.ThreeD_bar_clustered / k.ThreeD_bar_stacked / k.ThreeD_bar_stacked_100 / k.line_stacked / k.line_stacked_100 / k.line_markers / k.line_markers_stacked / k.line_markers_stacked_100 / k.pie_of_pie / k.pie_exploded / k.ThreeD_pie_exploded / k.bar_of_pie / k.xy_scatter_smooth / k.xy_scatter_smooth_no_markers / k.xy_scatter_lines / k.xy_scatter_lines_no_markers / k.area_stacked / k.area_stacked_100 / k.ThreeD_area_stacked / k.ThreeD_area_stacked_100 / k.doughnut_exploded / k.radar_markers / k.radar_filled / k.surface / k.surface_wireframe / k.surface_top_view / k.surface_top_view_wireframe / k.bubble / k.bubble_ThreeD_effect / k.stock_HLC / k.stock_OHLC / k.stock_VHLC / k.stock_VOHLC / k.cylinder_column_clustered / k.cylinder_column_stacked / k.cylinder_column_stacked_100 / k.cylinder_bar_clustered / k.cylinder_bar_stacked / k.cylinder_bar_stacked_100 / k.cylinder_column / k.cone_column_clustered / k.cone_column_stacked / k.cone_column_stacked_100 / k.cone_bar_clustered / k.cone_bar_stacked / k.cone_bar_stacked_100 / k.cone_col / k.pyramid_column_clustered / k.pyramid_column_stacked / k.pyramid_column_stacked_100 / k.pyramid_bar_clustered / k.pyramid_bar_stacked / k.pyramid_bar_stacked_100 / k.pyramid_column / k.ThreeD_column / k.line_chart / k.ThreeD_line / k.ThreeD_pie / k.pie_chart / k.xyscatter / k.ThreeD_area / k.area_chart / k.doughnut / k.radar / k.combination_chart -- Returns or sets the chart type.
      • column_threeD_group (r/o) chart_group -- Returns a chart group object that represents the column chart group on a 3-D chart.
      • corners_object (r/o) corners -- Returns a corners object that represents the corners of a 3-D chart.
      • data_table_object (r/o) data_table -- Returns a data table object that represents the chart data table.
      • depth_percent integer -- Returns or sets the depth of a 3-D chart as a percentage of the chart width, between 20 and 2000 percent.
      • display_blanks_as k.interpolated / k.not_plotted / k.zero -- Returns or sets the way that blank cells are plotted on a chart.
      • elevation integer -- Returns or sets the elevation of the 3-D chart view, in degrees.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • floor_object (r/o) floor -- Returns a floor object that represents the floor of the 3-D chart.
      • gap_depth integer -- Returns or sets the distance between the data series in a 3-D chart, as a percentage of the marker width. The value of this property must be between 0 and 500.
      • has_data_table boolean -- Returns or sets if the chart has a data table.
      • has_legend boolean -- Returns or sets if the chart has a legend.
      • has_title boolean -- Returns or sets if the chart has a title.
      • height_percent integer -- Returns or sets the height of a 3-D chart as a percentage of the chart width, between 5 and 500 percent.
      • legend_object (r/o) legend -- Returns a legend object that represents the legend for the chart.
      • line_threeD_group (r/o) chart_group -- Returns a chart group object that represents the line chart group on a 3-D chart.
      • name unicode_text -- Returns or sets the name of the chart.
      • next_ (r/o) chart -- Returns a worksheet object that represents the next sheet.
      • page_setup_object (r/o) page_setup -- Returns the page setup object associated with this chart.
      • perspective integer -- Returns or sets the perspective for the 3-D chart view. Must be between 0 and 100. This property is ignored if the right angle axes property is true.
      • pie_threeD_group (r/o) chart_group -- Returns a chart group object that represents the pie chart group on a 3-D chart.
      • plot_area_object (r/o) plot_area -- Returns a plot area object that represents the plot area of a chart.
      • plot_by k.by_columns / k.by_rows -- Returns or sets the way columns or rows are used as data series on the chart.
      • plot_visible_only boolean -- Returns or sets if only visible cells are plotted. False if both visible and hidden cells are plotted.
      • previous_ (r/o) null -- Returns a worksheet object that represents the previous sheet.
      • protect_contents (r/o) boolean -- Returns true if the contents of the sheet are protected.
      • protect_data boolean -- Returns or sets if series formulas cannot be modified by the user.
      • protect_drawing_objects (r/o) boolean -- Returns true if shapes are protected.
      • protect_formatting boolean -- Returns or sets if chart formatting cannot be modified by the user.
      • protect_goal_seek boolean -- Returns or sets if the user cannot modify chart data points with mouse actions.
      • protect_selection boolean -- Returns or sets if chart elements cannot be selected.
      • protection_mode (r/o) boolean -- Returns true if user-interface-only protection is turned on. To turn on user interface protection, use the protect method with the user interface only argument set to true.
      • right_angle_axes boolean -- Returns or sets if the chart axes are at right angles, independent of chart rotation or elevation. Applies only to 3-D line, column, and bar charts.
      • rotation_ integer -- The rotation of the 3D chart view. The value of must be from 0 to 360.
      • sheet_tab (r/o) tab -- Returns the sheet tab of the chart sheet
      • show_data_labels_over_maximum boolean -- Returns or sets whether to show the data labels when the value is greater than the maximum value on the value axis.
      • show_window boolean -- Returns or sets if the embedded chart is displayed in a separate window. The Chart object used with this property must refer to an embedded chart.
      • side_wall (r/o) walls -- Returns a walls object that allows the user to individually format the side wall of a 3-D chart.
      • size_with_window boolean -- Returns or sets if Microsoft Excel resizes the chart to match the size of the chart sheet window. False if the chart size isn't attached to the window size. Applies only to chart sheets, doesn't apply to embedded charts.
      • surface_group (r/o) chart_group -- Returns a chart group object that represents the surface chart group of a 3-D chart.
      • visible k.sheet_visible / k.sheet_hidden / k.sheet_very_hidden -- Returns or sets if the chart is visible.
      • walls_and_gridlines_twoD boolean -- Returns or sets if gridlines are drawn two-dimensionally on a 3-D chart.
      • walls_object (r/o) walls -- Returns a walls object that represents the walls of the 3-D chart.
    • Elements:
  • column_group
    • Plural name:
      • column_groups
    • Inherits from:
  • corners -- Represents the corners of a 3-D chart.
    • Inherits from:
    • Properties:
      • name (r/o) unicode_text -- Returns the name of this object.
  • data_label -- Represents the data label on a chart point or trendline.
    • Plural name:
      • data_labels
    • Inherits from:
    • Properties:
      • auto_scale_font boolean -- Returns or sets if the text in the object changes font size when the object size changes.
      • auto_text boolean -- Returns or sets if the object automatically generates appropriate text based on context.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • caption unicode_text -- Returns or sets the caption of the object.
      • chart_fill_format_object (r/o) chart_fill_format -- Returns a chart fill format object for this object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the data label.
      • data_label_text unicode_text -- Returns or sets the text for this object.
      • data_label_type k.data_labels_show_none / k.data_labels_show_value / k.data_labels_show_percent / k.data_labels_show_label / k.data_labels_show_label_and_percent / k.data_labels_show_bubble_sizes -- Returns or sets the type of the data label.
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • formula unicode_text -- Returns or sets the object's formula, in A1-style notation and in the language of the macro.
      • formula_local unicode_text -- Returns or sets the formula for the object, using A1-style references in the language of the user.
      • formula_r1c1 unicode_text -- Returns or sets the formula for the object, using R1C1-style notation in the language of the macro.
      • formula_r1c1_local unicode_text -- Returns or sets the formula for the object, using R1C1-style notation in the language of the user.
      • height (r/o) float -- Returns the height of the object.
      • horizontal_alignment k.horizontal_align_center / k.horizontal_align_center_across_selection / k.horizontal_align_distributed / k.horizontal_align_fill / k.horizontal_align_general / k.horizontal_align_justify / k.horizontal_align_left / k.horizontal_align_right -- Returns or sets the horizontal alignment for the object.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • left_position float -- Returns or sets the left position of the specified object, in points.
      • name (r/o) unicode_text -- Returns the name of the object.
      • number_format unicode_text -- Returns or sets the format code for the object.
      • number_format_linked boolean -- Returns or sets if the number format is linked to the cells, so that the number format changes in the labels when it changes in the cells.
      • number_format_local unicode_text -- Returns or sets the format code for the object as a string in the language of the user.
      • orientation integer -- The text orientation. Can be a number value from -90 to 90 degrees.
      • position k.label_position_center / k.label_position_above / k.label_position_below / k.label_position_left / k.label_position_right / k.label_position_outside_end / k.label_position_inside_end / k.label_position_inside_base / k.label_position_best_fit / k.label_position_mixed / k.label_position_custom -- Returns or sets the position of the specified object.
      • reading_order k.left_to_right / k.right_to_left / k.context -- Returns or sets the reading order for the specified object.
      • shadow boolean -- Returns or sets if the object has a shadow.
      • show_legend_key boolean -- Returns or sets if the data label legend key is visible.
      • top float -- Returns or sets the top position of the specified object, in points.
      • vertical_alignment k.vertical_alignment_top / k.vertical_alignment_center / k.vertical_alignment_bottom / k.vertical_alignment_justify / k.vertical_alignment_distributed -- Returns or sets the vertical alignment of the object.
      • width (r/o) float -- Returns the width of the object.
    • Elements:
  • data_table -- Represents a chart data table.
    • Plural name:
      • data_tables
    • Inherits from:
    • Properties:
      • auto_scale_font boolean -- Returns or sets if the text in the object changes font size when the object size changes.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the data table.
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • has_border_horizontal boolean -- Returns or sets if the chart data table has horizontal cell borders.
      • has_border_outline boolean -- Returns or sets if the chart data table has outline borders.
      • has_border_vertical boolean -- Returns or sets if the chart data table has vertical cell borders.
      • show_legend_key boolean -- Returns or sets if the data label legend key is visible.
  • display_unit_label -- Represents a unit label on an axis in the specified chart. Unit labels are useful for charting large values-- for example, in the millions or billions.
    • Plural name:
      • display_unit_labels
    • Inherits from:
    • Properties:
      • auto_scale_font boolean -- Returns or sets if the text in the object changes font size when the object size changes.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • caption unicode_text -- Returns or sets the caption for the object.
      • chart_fill_format_object (r/o) chart_fill_format -- Returns a chart fill format object for this object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the chart title.
      • display_label_unit_text unicode_text -- Returns or sets the text for this object.
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • horizontal_alignment k.horizontal_align_center / k.horizontal_align_center_across_selection / k.horizontal_align_distributed / k.horizontal_align_fill / k.horizontal_align_general / k.horizontal_align_justify / k.horizontal_align_left / k.horizontal_align_right -- Returns or sets the horizontal alignment for the object.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • left_position float -- Returns or sets the left position of the specified object, in points.
      • name (r/o) unicode_text -- Returns the name of the object.
      • orientation integer -- The text orientation. Can be a number value from -90 to 90 degrees.
      • position k.automatic / k.custom -- Returns or sets the position of the chart title on the chart.
      • reading_order k.left_to_right / k.right_to_left / k.context -- Returns or sets the reading order for the specified object.
      • shadow boolean -- Returns or sets if the object has a shadow.
      • top float -- Returns or sets the top position of the specified object, in points.
      • vertical_alignment k.vertical_alignment_top / k.vertical_alignment_center / k.vertical_alignment_bottom / k.vertical_alignment_justify / k.vertical_alignment_distributed -- Returns or sets the vertical alignment of the object.
    • Elements:
  • doughnut_group
    • Plural name:
      • doughnut_groups
    • Inherits from:
  • down_bars -- Represents the down bars in a chart group. Down bars connect points on the first series in the chart group with lower values on the last series, the lines go down from the first series.
    • Inherits from:
    • Properties:
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_fill_format_object (r/o) chart_fill_format -- Returns a chart fill format object for this object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the down bars.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • name (r/o) unicode_text -- Returns the name of the object.
  • drop_lines -- Represents the drop lines in a chart group. Drop lines connect the points in the chart with the x-axis. Only line and area chart groups can have drop lines.
    • Inherits from:
    • Properties:
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the drop lines.
      • name (r/o) unicode_text -- Returns the name of this object.
  • error_bars -- Represents the error bars on a chart series. Error bars indicate the degree of uncertainty for chart data.
    • Inherits from:
    • Properties:
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the error bars.
      • end_style k.cap / k.no_cap -- Returns or sets the end style for the error bars.
      • name (r/o) unicode_text -- Returns the name of the object.
  • floor -- Represents the floor of a 3-D chart.
    • Plural name:
      • floors
    • Inherits from:
    • Properties:
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_fill_format_object (r/o) chart_fill_format -- Returns a chart fill format object for this object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the floor.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • name (r/o) unicode_text -- Returns the name of the object.
      • picture_type k.chart_picture_type_stack_scale / k.chart_picture_type_stack / k.chart_picture_type_stretch -- Returns or sets the way pictures are displayed on a column or bar picture chart or on the walls and faces of a 3-D chart.
      • thickness integer -- Returns or sets the thickness of the floor.
  • gridlines -- Represents major or minor gridlines on a chart axis. Gridlines extend the tick marks on a chart axis to make it easier to see the values associated with the data markers.
    • Inherits from:
    • Properties:
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the gridlines.
      • name (r/o) unicode_text -- Returns the name of this object.
  • hilo_lines -- Represents the high-low lines in a chart group. High-low lines connect the highest point with the lowest point in every category in the chart group. Only 2-D line groups can have high-low lines.
    • Inherits from:
    • Properties:
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the hilo lines.
      • name (r/o) unicode_text -- Returns the name of this object.
  • interior -- Represents the interior of an object.
    • Plural name:
      • interiors
    • Inherits from:
    • Properties:
      • color RGB_color -- Returns or sets the primary color of the object.
      • color_index k.color_index_automatic / k.color_index_none / k.a_color_index_integer -- Returns or sets the color of the interior. The color is specified as an index value into the current color palette.
      • invert_if_negative boolean -- Returns or sets if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.
      • linear_gradient (r/o) linear_gradient -- Returns or sets the Gradient property of an Interior object of a selection.
      • pattern k.pattern_automatic / k.pattern_checker / k.pattern_criss_cross / k.pattern_down / k.pattern_gray_16 / k.pattern_gray_25 / k.pattern_gray_50 / k.pattern_gray_75 / k.pattern_gray_8 / k.pattern_grid / k.pattern_horizontal / k.pattern_light_down / k.pattern_light_horizontal / k.pattern_light_up / k.pattern_light_vertical / k.pattern_none / k.pattern_semi_gray_75 / k.pattern_solid / k.pattern_up / k.pattern_vertical / k.pattern_linear_gradient / k.pattern_rectangular_gradient -- Returns or sets the interior pattern.
      • pattern_color RGB_color -- Returns or sets the color of the interior pattern as an RGB value.
      • pattern_color_index k.color_index_automatic / k.color_index_none / k.a_color_index_integer -- Returns or sets the color of the interior pattern as an index into the current color palette.
      • pattern_theme_color k.color_index_none / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color -- Returns or sets a theme color pattern for an Interior object.
      • pattern_tint_and_shade float -- Returns or sets a tint and shade pattern for an Interior object.
      • rectangular_gradient (r/o) rectangular_gradient -- Returns or sets the Gradient property of an Interior object of a selection.
      • theme_color k.color_index_none / k.first_dark_theme_color / k.first_light_theme_color / k.second_dark_theme_color / k.second_light_theme_color / k.first_accent_theme_color / k.second_accent_theme_color / k.third_accent_theme_color / k.fourth_accent_theme_color / k.fifth_accent_theme_color / k.sixth_accent_theme_color / k.hyperlink_theme_color / k.followed_hyperlink_theme_color -- Returns or sets the theme color in the applied color scheme that is associated with the specified object.
      • tint_and_shade float -- Returns or sets a Single that lightens or darkens a color.
  • leader_lines -- Represents leader lines on a chart. Leader lines connect data labels to data points.
    • Inherits from:
    • Properties:
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the leader lines.
  • legend_entry -- Represents a legend entry in a chart legend.
    • Plural name:
      • legend_entries
    • Inherits from:
    • Properties:
      • auto_scale_font boolean -- Returns or sets if the text in the object changes font size when the object size changes.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the legend entry.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • height (r/o) float -- Returns the height of the object.
      • left_position (r/o) float -- Returns the left position of the specified object, in points.
      • legend_key (r/o) legend_key -- Returns a legend key object that represents the legend key associated with the entry.
      • top (r/o) float -- Returns the top position of the specified object, in points.
      • width (r/o) float -- Returns the width of the object.
  • legend_key -- Represents a legend key in a chart legend. Each legend key is a graphic that visually links a legend entry with its associated series or trendline in the chart.
    • Plural name:
      • legend_keys
    • Inherits from:
    • Properties:
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_fill_format_object (r/o) chart_fill_format -- Returns a chart fill format object for this object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the legend key.
      • height (r/o) float -- Returns the height of the object.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • invert_if_negative boolean -- Returns or sets if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.
      • left_position (r/o) float -- Returns the left position of the specified object, in points.
      • marker_background_color RGB_color -- Returns or sets the marker background color as an RGB value. Applies only to line, scatter, and radar charts.
      • marker_background_color_index k.color_index_automatic / k.color_index_none / k.a_color_index_integer -- Returns or sets the marker background color as an index into the current color palette, or as one of the following constants: color index automatic or color index none. Applies only to line, scatter, and radar charts.
      • marker_foreground_color RGB_color -- Returns or sets the foreground color of the marker as an RGB value. Applies only to line, scatter, and radar charts.
      • marker_foreground_color_index k.color_index_automatic / k.color_index_none / k.a_color_index_integer -- Returns or sets the marker foreground color as an index into the current color palette, or as one of the following constants: color index automatic or color index none. Applies only to line, scatter, and radar charts.
      • marker_size integer -- Returns or sets the data-marker size, in points.
      • marker_style k.marker_style_automatic / k.marker_style_circle / k.marker_style_dash / k.marker_style_diamond / k.marker_style_dot / k.marker_style_none / k.marker_style_picture / k.marker_style_plus / k.marker_style_square / k.marker_style_star / k.marker_style_triangle / k.marker_style_x -- Returns or sets the marker style for a point or series in a line chart, scatter chart, or radar chart.
      • picture_type k.chart_picture_type_stack_scale / k.chart_picture_type_stack / k.chart_picture_type_stretch -- Returns or sets the way pictures are displayed on a column or bar picture chart or on the walls and faces of a 3-D chart.
      • picture_unit float -- Returns or sets the unit for each picture on the chart if the picture type property is set to chart picture type stack scale, if not, this property is ignored.
      • shadow boolean -- Returns or sets if the object has a shadow.
      • smooth boolean -- Returns or sets if curve smoothing is turned on for the line chart or scatter chart. Applies only to line and scatter charts.
      • top (r/o) float -- Returns the top position of the specified object, in points.
      • width (r/o) float -- Returns the width of the object.
  • legend -- Represents the legend in a chart. Each chart can have only one legend.
    • Plural name:
      • legends
    • Inherits from:
    • Properties:
      • auto_scale_font boolean -- Returns or sets if the text in the object changes font size when the object size changes.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_fill_format_object (r/o) chart_fill_format -- Returns a chart fill format object for this object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the legend.
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • height float -- Returns or sets the height of the object.
      • include_in_layout boolean -- Returns or sets if a legend will occupy the chart layout space when a chart layout is being determined.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • left_position float -- Returns or sets the left position of the specified object, in points.
      • name (r/o) unicode_text -- Returns the name of the object.
      • position k.legend_position_bottom / k.legend_position_corner / k.legend_position_left / k.legend_position_right / k.legend_position_top -- Returns or sets the position of the legend on the chart.
      • shadow boolean -- Returns or sets if the object has a shadow.
      • top float -- Returns or sets the top position of the specified object, in points.
      • width float -- Returns or sets the width of the object.
    • Elements:
  • line_group
  • pie_group
  • plot_area -- Represents the plot area of a chart. This is the area where your chart data is plotted.
    • Plural name:
      • plot_areas
    • Inherits from:
    • Properties:
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_fill_format_object (r/o) chart_fill_format -- Returns a chart fill format object for this object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the plot area.
      • height float -- Returns or sets the height of the object.
      • inside_height (r/o) float -- Returns the inside height of the plot area, in points.
      • inside_left (r/o) float -- Returns the distance from the chart edge to the inside left edge of the plot area, in points.
      • inside_top (r/o) float -- Returns the distance from the chart edge to the inside top edge of the plot area, in points.
      • inside_width (r/o) float -- Returns the inside width of the plot area, in points.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • left_position float -- Returns or sets the left position of the specified object, in points.
      • name (r/o) unicode_text -- Returns the name of the object.
      • position k.automatic / k.custom -- Returns or sets the position of the plot area on the chart.
      • top float -- Returns or sets the top position of the specified object, in points.
      • width float -- Returns or sets the width of the object.
  • radar_group
  • series_lines -- Represents series lines in a chart group. Series lines connect the data values from each series. Only 2-D stacked bar or column chart groups can have series lines.
    • Inherits from:
    • Properties:
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the series lines.
      • name (r/o) unicode_text -- Returns the name of this object.
  • series_point -- Represents a single point in a series in a chart.
    • Plural name:
      • series_points
    • Inherits from:
    • Properties:
      • apply_pict_to_end boolean -- Returns or sets if a picture is applied to the end of the point or all points in the series.
      • apply_pict_to_front boolean -- Returns or sets if a picture is applied to the front of the point or all points in the series.
      • apply_pict_to_sides boolean -- Returns or sets if a picture is applied to the sides of the point or all points in the series.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_fill_format_object (r/o) chart_fill_format -- Returns a chart fill format object for this object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the point.
      • data_label_object (r/o) data_label -- Returns a data label object that represents the data label associated with the point or trendline.
      • explosion integer -- Returns or sets the explosion value for a pie-chart or doughnut-chart slice. Returns zero if there's no explosion, the tip of the slice is in the center of the pie.
      • has_data_label boolean -- Returns or sets if the point has a data label.
      • has_threeD_effect boolean -- Returns or sets if a point has a three-dimensional appearance. Applies only to bubble charts.
      • height (r/o) float -- Returns the height of the object.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • invert_if_negative boolean -- Returns or sets if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.
      • left_position (r/o) float -- Returns the left position of the specified object, in points.
      • marker_background_color RGB_color -- Returns or sets the marker background color as an RGB value. Applies only to line, scatter, and radar charts.
      • marker_background_color_index k.color_index_automatic / k.color_index_none / k.a_color_index_integer -- Returns or sets the marker background color as an index into the current color palette, or as one of the following constants: color index automatic or color index none. Applies only to line, scatter, and radar charts.
      • marker_foreground_color RGB_color -- Returns or sets the foreground color of the marker as an RGB value. Applies only to line, scatter, and radar charts.
      • marker_foreground_color_index k.color_index_automatic / k.color_index_none / k.a_color_index_integer -- Returns or sets the marker foreground color as an index into the current color palette, or as one of the following constants: color index automatic or color index none. Applies only to line, scatter, and radar charts.
      • marker_size integer -- Returns or sets the data-marker size, in points.
      • marker_style k.marker_style_automatic / k.marker_style_circle / k.marker_style_dash / k.marker_style_diamond / k.marker_style_dot / k.marker_style_none / k.marker_style_picture / k.marker_style_plus / k.marker_style_square / k.marker_style_star / k.marker_style_triangle / k.marker_style_x -- Returns or sets the marker style for a point or series in a line chart, scatter chart, or radar chart.
      • name (r/o) unicode_text -- Returns the name of the object.
      • picture_type k.chart_picture_type_stack_scale / k.chart_picture_type_stack / k.chart_picture_type_stretch -- Returns or sets the way pictures are displayed on a column or bar picture chart or on the walls and faces of a 3-D chart.
      • picture_unit float -- Returns or sets the unit for each picture on the chart if the picture type property is set to chart picture type stack scale, if not, this property is ignored.
      • secondary_plot boolean -- Returns or sets if the point is in the secondary section of either a pie of pie chart or a bar of pie chart. Applies only to points on pie of pie charts or bar of pie charts.
      • shadow boolean -- Returns or sets if the object has a shadow.
      • top (r/o) float -- Returns the top position of the specified object, in points.
      • width (r/o) float -- Returns the width of the object.
  • series -- Represents a series in a chart.
    • Plural name:
      • series_collection
    • Inherits from:
    • Properties:
      • apply_picture_to_end boolean -- Returns or sets if a picture is applied to the end of the point or all points in the series.
      • apply_picture_to_front boolean -- Returns or sets if a picture is applied to the front of the point or all points in the series.
      • apply_picture_to_sides boolean -- Returns or sets if a picture is applied to the sides of the point or all points in the series.
      • axis_group k.primary_axis / k.secondary_axis -- Returns or sets the axis group for the specified series.
      • bar_shape k.box / k.pyramid_to_point / k.pyramid_to_max / k.cylinder / k.cone_to_point / k.cone_to_max -- Returns or sets the shape used with the 3-D bar or column chart.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • bubble_sizes unicode_text -- Returns or sets a string in A1-style notation that refers to the worksheet cells containing the size data for the bubble chart. Applies only to bubble charts.
      • chart_fill_format_object (r/o) chart_fill_format -- Returns a chart fill format object for this object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the series.
      • chart_type k.column_clustered / k.column_stacked / k.column_stacked_100 / k.ThreeD_column_clustered / k.ThreeD_column_stacked / k.ThreeD_column_stacked_100 / k.bar_clustered / k.bar_stacked / k.bar_stacked_100 / k.ThreeD_bar_clustered / k.ThreeD_bar_stacked / k.ThreeD_bar_stacked_100 / k.line_stacked / k.line_stacked_100 / k.line_markers / k.line_markers_stacked / k.line_markers_stacked_100 / k.pie_of_pie / k.pie_exploded / k.ThreeD_pie_exploded / k.bar_of_pie / k.xy_scatter_smooth / k.xy_scatter_smooth_no_markers / k.xy_scatter_lines / k.xy_scatter_lines_no_markers / k.area_stacked / k.area_stacked_100 / k.ThreeD_area_stacked / k.ThreeD_area_stacked_100 / k.doughnut_exploded / k.radar_markers / k.radar_filled / k.surface / k.surface_wireframe / k.surface_top_view / k.surface_top_view_wireframe / k.bubble / k.bubble_ThreeD_effect / k.stock_HLC / k.stock_OHLC / k.stock_VHLC / k.stock_VOHLC / k.cylinder_column_clustered / k.cylinder_column_stacked / k.cylinder_column_stacked_100 / k.cylinder_bar_clustered / k.cylinder_bar_stacked / k.cylinder_bar_stacked_100 / k.cylinder_column / k.cone_column_clustered / k.cone_column_stacked / k.cone_column_stacked_100 / k.cone_bar_clustered / k.cone_bar_stacked / k.cone_bar_stacked_100 / k.cone_col / k.pyramid_column_clustered / k.pyramid_column_stacked / k.pyramid_column_stacked_100 / k.pyramid_bar_clustered / k.pyramid_bar_stacked / k.pyramid_bar_stacked_100 / k.pyramid_column / k.ThreeD_column / k.line_chart / k.ThreeD_line / k.ThreeD_pie / k.pie_chart / k.xyscatter / k.ThreeD_area / k.area_chart / k.doughnut / k.radar / k.combination_chart -- Returns or sets the chart type.
      • error_bars (r/o) error_bars -- Returns an error bars object that represents the error bars for the series.
      • explosion integer -- Returns or sets the explosion value for a pie-chart or doughnut-chart slice. Returns zero if there's no explosion, the tip of the slice is in the center of the pie.
      • formula unicode_text -- Returns or sets the object's formula, in A1-style notation and in the language of the macro.
      • formula_local unicode_text -- Returns or sets the formula for the object, using A1-style references in the language of the user.
      • formula_r1c1 unicode_text -- Returns or sets the formula for the object, using R1C1-style notation in the language of the macro.
      • formula_r1c1_local unicode_text -- Returns or sets the formula for the object, using R1C1-style notation in the language of the user.
      • has_data_labels boolean -- Returns or sets if the series has data labels.
      • has_error_bars boolean -- Returns or set if the series has error bars. This property isn't available for 3-D charts.
      • has_leader_lines boolean -- Returns or sets if the series has leader lines.
      • has_threeD_effect boolean -- Returns or sets if the series has a three-dimensional appearance. Applies only to bubble charts.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • invert_if_negative boolean -- Returns or sets if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.
      • leader_lines (r/o) leader_lines -- Returns a leader lines object that represents the leader lines for the series.
      • marker_background_color RGB_color -- Returns or sets the marker background color as an RGB value. Applies only to line, scatter, and radar charts.
      • marker_background_color_index k.color_index_automatic / k.color_index_none / k.a_color_index_integer -- Returns or sets the marker background color as an index into the current color palette, or as one of the following constants: color index automatic or color index none. Applies only to line, scatter, and radar charts.
      • marker_foreground_color RGB_color -- Returns or sets the foreground color of the marker as an RGB value. Applies only to line, scatter, and radar charts.
      • marker_foreground_color_index k.color_index_automatic / k.color_index_none / k.a_color_index_integer -- Returns or sets the marker foreground color as an index into the current color palette, or as one of the following constants: color index automatic or color index none. Applies only to line, scatter, and radar charts.
      • marker_size integer -- Returns or sets the data-marker size, in points.
      • marker_style k.marker_style_automatic / k.marker_style_circle / k.marker_style_dash / k.marker_style_diamond / k.marker_style_dot / k.marker_style_none / k.marker_style_picture / k.marker_style_plus / k.marker_style_square / k.marker_style_star / k.marker_style_triangle / k.marker_style_x -- Returns or sets the marker style for a point or series in a line chart, scatter chart, or radar chart.
      • name unicode_text -- Returns or sets the name of the object.
      • picture_type k.chart_picture_type_stack_scale / k.chart_picture_type_stack / k.chart_picture_type_stretch -- Returns or sets the way pictures are displayed on a column or bar picture chart or on the walls and faces of a 3-D chart.
      • picture_unit float -- Returns or sets the unit for each picture on the chart if the picture type property is set to chart picture type stack scale, if not, this property is ignored.
      • plot_color_index (r/o) integer -- Returns the plot color index of the series.
      • plot_order integer -- Returns or sets the plot order for the selected series within the chart group.
      • series_values k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_category_names -- Returns or sets a list of all the values in the series. This can be a range on a worksheet or a list of constant values.
      • shadow boolean -- Returns or sets if the object has a shadow.
      • smooth boolean -- Returns or sets if curve smoothing is turned on for the line chart or scatter chart. Applies only to line and scatter charts.
      • xvalues k.range_object / k.A1_style_range_reference / k.named_range / k.list_of_category_names -- Returns or sets a list of x values for a chart series. The xvalues property can be set to a range on a worksheet or to a list of values.
    • Elements:
  • tick_labels -- Represents the tick-mark labels associated with tick marks on a chart axis.
    • Inherits from:
    • Properties:
      • auto_scale_font boolean -- Returns or sets if the text in the object changes font size when the object size changes.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the tick labels.
      • depth (r/o) integer -- Returns the number of levels of category tick labels.
      • font_object (r/o) font -- Returns a font object that represents the font of the specified object.
      • multi_level boolean -- Returns or sets whether an axis is multilevel or not.
      • name (r/o) unicode_text -- Returns the name of the object.
      • number_format unicode_text -- Returns or sets the format code for the object.
      • number_format_linked boolean -- Returns or sets if the number format is linked to the cells, so that the number format changes in the labels when it changes in the cells.
      • number_format_local unicode_text -- Returns or sets the format code for the object as a string in the language of the user.
      • offset integer -- Returns or sets the distance between the levels of labels, and the distance between the first level and the axis line. The value can be an integer percentage from 0 through 1000, relative to the axis label's font size.
      • orientation k.tick_label_orientation_automatic / k.tick_label_orientation_downward / k.tick_label_orientation_horizontal / k.tick_label_orientation_upward / k.tick_label_orientation_vertical -- The text orientation. Can be a number value from -90 to 90 degrees.
      • reading_order k.left_to_right / k.right_to_left / k.context -- Returns or sets the reading order for the specified object.
      • tick_alignment k.align_tick_label_center / k.align_tick_label_left / k.align_tick_label_right -- Returns or sets the alignment for the specified tick label.
  • trendline -- Represents a trendline in a chart. A trendline shows the trend, or direction, of data in a series.
    • Plural name:
      • trendlines
    • Inherits from:
    • Properties:
      • backward float -- Returns or sets the number of periods, or units on a scatter chart, that the trendline extends backward.
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the trendline.
      • data_label_object (r/o) data_label -- Returns a data label object that represents the data label associated with the point or trendline.
      • display_R_squared boolean -- Returns or sets if the R-squared value of the trendline is displayed on the chart, in the same data label as the equation. Setting this property to true automatically turns on data labels.
      • display_equation boolean -- Returns or sets if the equation for the trendline is displayed on the chart, in the same data label as the R-squared value. Setting this property to true automatically turns on data labels.
      • entry_index (r/o) integer -- Returns the index number of the object within the elements of the parent object.
      • forward float -- Returns or sets the number of periods, or units on a scatter chart, that the trendline extends forward.
      • intercept float -- Returns or sets the point where the trendline crosses the value axis.
      • intercept_is_auto boolean -- Returns or sets if the point where the trendline crosses the value axis is automatically determined by the regression.
      • name unicode_text -- Returns or sets the name of this object.
      • name_is_auto boolean -- Returns or sets if Microsoft Excel automatically determines the name of the trendline.
      • order integer -- Returns or sets the trendline order, an integer greater than 1, when the trendline type is polynomial.
      • period integer -- Returns or sets the period for the moving-average trendline.
      • trendline_type k.exponential / k.linear / k.logarithmic / k.moving_average / k.polynomial / k.power -- Returns or sets the type of this trend line
  • up_bars -- Represents the up bars in a chart group. Up bars connect points on series one with higher values on the last series in the chart group, the lines go up from series one. Only 2-D line groups that contain at least two series can have up bars.
    • Inherits from:
    • Properties:
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_fill_format_object (r/o) chart_fill_format -- Returns a chart fill format object for this object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the up bars.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • name (r/o) unicode_text -- Returns the name of this object.
  • walls -- Represents the walls of a 3-D chart.
    • Plural name:
      • walls_collection
    • Inherits from:
    • Properties:
      • border (r/o) border -- Returns a border object that represents the border of the object.
      • chart_fill_format_object (r/o) chart_fill_format -- Returns a chart fill format object for this object.
      • chart_format (r/o) chart_format -- Returns a chart format object that contains chart formatting properties for the walls.
      • interior_object (r/o) interior -- Returns an interior object that represents the interior of the specified object.
      • name (r/o) unicode_text -- Returns or sets the name of the object.
      • picture_type k.chart_picture_type_stack_scale / k.chart_picture_type_stack / k.chart_picture_type_stretch -- Returns or sets the way pictures are displayed on a column or bar picture chart or on the walls and faces of a 3-D chart.
      • picture_unit integer -- Returns or sets the unit for each picture on the chart if the picture type property is set to chart picture type stack scale, if not, this property is ignored.
      • thickness integer -- Returns or sets the thickness of the floor.
  • xy_group