# openpyxl.workbook.defined_name module

class openpyxl.workbook.defined_name.DefinedName(name=None, comment=None, customMenu=None, description=None, help=None, statusBar=None, localSheetId=None, hidden=None, function=None, vbProcedure=None, xlm=None, functionGroupId=None, shortcutKey=None, publishToServer=None, workbookParameter=None, attr_text=None)

  Bases: `Serialisable`

  attr_text
  comment

    Values must be of type <class ‘str’>

  customMenu

    Values must be of type <class ‘str’>

  description

    Values must be of type <class ‘str’>

  property destinations
  function

    Values must be of type <class ‘bool’>

  functionGroupId

    Values must be of type <class ‘int’>

  help

    Values must be of type <class ‘str’>

  hidden

    Values must be of type <class ‘bool’>

  property is_external
  property is_reserved
  localSheetId

    Values must be of type <class ‘int’>

  name

    Values must be of type <class ‘str’>

  publishToServer

    Values must be of type <class ‘bool’>

  shortcutKey

    Values must be of type <class ‘str’>

  statusBar

    Values must be of type <class ‘str’>

  tagname = 'definedName'
  property type
  value

    Aliases can be used when either the desired attribute name is not allowed or confusing in Python (eg. “type”) or a more descriptive name is desired (eg. “underline” for “u”)

  vbProcedure

    Values must be of type <class ‘bool’>

  workbookParameter

    Values must be of type <class ‘bool’>

  xlm

    Values must be of type <class ‘bool’>

class openpyxl.workbook.defined_name.DefinedNameDict

  Bases: `dict`

  Utility class for storing defined names. Allows access by name and separation of global and scoped names

  add(value)

    Add names without worrying about key and name matching.

class openpyxl.workbook.defined_name.DefinedNameList(definedName=())

  Bases: `Serialisable`

  by_sheet()

    Break names down into sheet locals and globals

  definedName

    A sequence (list or tuple) that may only contain objects of the declared type

  tagname = 'definedNames'