openpyxl.worksheet.datavalidation module¶

class openpyxl.worksheet.datavalidation.DataValidation(type=None, formula1=None, formula2=None, allow_blank=False, showErrorMessage=True, showInputMessage=True, showDropDown=None, allowBlank=None, sqref=None, promptTitle=None, errorStyle=None, error=None, prompt=None, errorTitle=None, imeMode=None, operator=None)[source]¶

Bases: openpyxl.descriptors.serialisable.Serialisable

add(cell)[source]¶: Adds a openpyxl.cell to this validator

allowBlank¶: Values must be of type <class ‘bool’>

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

error¶: Values must be of type <class ‘str’>

errorStyle¶: Value must be one of {‘stop’, ‘warning’, ‘information’}

errorTitle¶: Values must be of type <class ‘str’>

formula1¶: Values must be of type <class ‘str’>

formula2¶: Values must be of type <class ‘str’>

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

imeMode¶: Value must be one of {‘fullHangul’, ‘noControl’, ‘on’, ‘off’, ‘halfAlpha’, ‘fullKatakana’, ‘hiragana’, ‘fullAlpha’, ‘disabled’, ‘halfKatakana’, ‘halfHangul’}

operator¶: Value must be one of {‘between’, ‘notEqual’, ‘greaterThan’, ‘greaterThanOrEqual’, ‘notBetween’, ‘equal’, ‘lessThan’, ‘lessThanOrEqual’}

prompt¶: Values must be of type <class ‘str’>

promptTitle¶: Values must be of type <class ‘str’>

showDropDown¶: Values must be of type <class ‘bool’>

showErrorMessage¶: Values must be of type <class ‘bool’>

showInputMessage¶: Values must be of type <class ‘bool’>

sqref¶

tagname = 'dataValidation'¶

type¶: Value must be one of {‘textLength’, ‘custom’, ‘decimal’, ‘time’, ‘date’, ‘whole’, ‘list’}

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

class openpyxl.worksheet.datavalidation.DataValidationList(disablePrompts=None, xWindow=None, yWindow=None, count=None, dataValidation=())[source]¶

Bases: openpyxl.descriptors.serialisable.Serialisable

append(dv)[source]¶

count¶

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

disablePrompts¶: Values must be of type <class ‘bool’>

tagname = 'dataValidations'¶

xWindow¶: Values must be of type <class ‘int’>

yWindow¶: Values must be of type <class ‘int’>

openpyxl.worksheet.datavalidation.collapse_cell_addresses(cells, input_ranges=())[source]¶

Collapse a collection of cell co-ordinates down into an optimal range or collection of ranges.

E.g. Cells A1, A2, A3, B1, B2 and B3 should have the data-validation object applied, attempt to collapse down to a single range, A1:B3.

Currently only collapsing contiguous vertical ranges (i.e. above example results in A1:A3 B1:B3).

openpyxl.worksheet.datavalidation.expand_cell_ranges(range_string)[source]¶: Expand cell ranges to a sequence of addresses. Reverse of collapse_cell_addresses Eg. converts “A1:A2 B1:B2” to (A1, A2, B1, B2)