Names

class Names(impl: Any)

A collection of all name objects in the workbook:

>>> import xlwings as xw
>>> book = xw.books['Book1']  # book scope and sheet scope
>>> book.names
[<Name 'MyName': =Sheet1!$A$3>]
>>> book.sheets[0].names  # sheet scope only

Added in version 0.9.0.

add(name: str, refers_to: str) → Name

Defines a new name for a range of cells.

Parameters

namestr

Specifies the text to use as the name. Names cannot include spaces and cannot be formatted as cell references.

refers_tostr

Describes what the name refers to, in English, using A1-style notation.

Returns

Name

Added in version 0.9.0.

property api: Any

Returns the native object (pywin32 or appscript obj) of the engine beingused.

Added in version 0.9.0.

property count: int

Returns the number of objects in the collection.