class CT_DataValidation(BaseOxmlElement):
"""
Complex type (sml-sheet.xsd)
"""
formula1 = ZeroOrOne('ssml:formula1') # Formula 1
formula2 = ZeroOrOne('ssml:formula2') # Formula 2
type = OptionalAttribute('type', ST_DataValidationType,
'none') # Data Validation Type
errorStyle = OptionalAttribute('errorStyle', ST_DataValidationErrorStyle,
'stop') # Data Validation Error Style
imeMode = OptionalAttribute('imeMode', ST_DataValidationImeMode,
'noControl') # IME Mode Enforced
operator = OptionalAttribute('operator', ST_DataValidationOperator,
'between') # Operator
allowBlank = OptionalAttribute('allowBlank', XsdBoolean,
False) # Allow Blank
showDropDown = OptionalAttribute('showDropDown', XsdBoolean,
False) # Show Drop Down
showInputMessage = OptionalAttribute('showInputMessage', XsdBoolean,
False) # Show Input Message
showErrorMessage = OptionalAttribute('showErrorMessage', XsdBoolean,
False) # Show Error Message
errorTitle = OptionalAttribute('errorTitle',
ST_Xstring) # Error Alert Text
error = OptionalAttribute('error', ST_Xstring) # Error Message
promptTitle = OptionalAttribute('promptTitle', ST_Xstring) # Prompt Title
prompt = OptionalAttribute('prompt', ST_Xstring) # Input Prompt
sqref = RequiredAttribute('sqref', ST_Sqref) # Sequence of References
class CT_Transform2D(BaseOxmlElement):
"""
``<a:xfrm>`` element, specifies size and shape of picture container.
"""
off = ZeroOrOne('a:off', successors=('a:ext', ))
ext = ZeroOrOne('a:ext', successors=())
@property
def cx(self):
ext = self.ext
if ext is None:
return None
return ext.cx
@cx.setter
def cx(self, value):
ext = self.get_or_add_ext()
ext.cx = value
@property
def cy(self):
ext = self.ext
if ext is None:
return None
return ext.cy
@cy.setter
def cy(self, value):
ext = self.get_or_add_ext()
ext.cy = value
class CT_CfRule(BaseOxmlElement):
"""
Complex type (sml-sheet.xsd)
"""
formula = ZeroOrMore('ssml:formula') # Formula
colorScale = ZeroOrOne('ssml:colorScale') # Color Scale
dataBar = ZeroOrOne('ssml:dataBar') # Data Bar
iconSet = ZeroOrOne('ssml:iconSet') # Icon Set
extLst = ZeroOrMore('ssml:extLst') # None
type = OptionalAttribute('type', ST_CfType) # Type
dxfId = OptionalAttribute('dxfId', ST_DxfId) # Differential Formatting Id
priority = RequiredAttribute('priority', XsdInt) # Priority
stopIfTrue = OptionalAttribute('stopIfTrue', XsdBoolean,
False) # Stop If True
aboveAverage = OptionalAttribute('aboveAverage', XsdBoolean,
True) # Above Or Below Average
percent = OptionalAttribute('percent', XsdBoolean, False) # Top 10 Percent
bottom = OptionalAttribute('bottom', XsdBoolean, False) # Bottom N
operator = OptionalAttribute('operator',
ST_ConditionalFormattingOperator) # Operator
text = OptionalAttribute('text', XsdString) # Text
timePeriod = OptionalAttribute('timePeriod', ST_TimePeriod) # Time Period
rank = OptionalAttribute('rank', XsdUnsignedInt) # Rank
stdDev = OptionalAttribute('stdDev', XsdInt) # StdDev
equalAverage = OptionalAttribute('equalAverage', XsdBoolean,
False) # Equal Average
class CT_Colors(BaseOxmlElement):
"""
Complex type (sml-styles.xsd)
"""
indexedColors = ZeroOrOne('ssml:indexedColors') # Color Indexes
mruColors = ZeroOrOne('ssml:mruColors') # MRU Colors
class CT_Fill(BaseOxmlElement):
"""
Complex type (sml-styles.xsd)
"""
patternFill = ZeroOrOne('ssml:patternFill') # Pattern
gradientFill = ZeroOrOne('ssml:gradientFill') # Gradient
class CT_Xf(BaseOxmlElement):
"""
Complex type (sml-styles.xsd)
"""
alignment = ZeroOrOne('ssml:alignment') # Alignment
protection = ZeroOrOne('ssml:protection') # Protection
extLst = ZeroOrOne('ssml:extLst') # Future Feature Data Storage Area
numFmtId = OptionalAttribute('numFmtId', ST_NumFmtId) # Number Format Id
fontId = OptionalAttribute('fontId', ST_FontId) # Font Id
fillId = OptionalAttribute('fillId', ST_FillId) # Fill Id
borderId = OptionalAttribute('borderId', ST_BorderId) # Border Id
xfId = OptionalAttribute('xfId', ST_CellStyleXfId) # Format Id
quotePrefix = OptionalAttribute('quotePrefix', XsdBoolean,
False) # Quote Prefix
pivotButton = OptionalAttribute('pivotButton', XsdBoolean,
False) # Pivot Button
applyNumberFormat = OptionalAttribute('applyNumberFormat',
XsdBoolean) # Apply Number Format
applyFont = OptionalAttribute('applyFont', XsdBoolean) # Apply Font
applyFill = OptionalAttribute('applyFill', XsdBoolean) # Apply Fill
applyBorder = OptionalAttribute('applyBorder', XsdBoolean) # Apply Border
applyAlignment = OptionalAttribute('applyAlignment',
XsdBoolean) # Apply Alignment
applyProtection = OptionalAttribute('applyProtection',
XsdBoolean) # Apply Protection
class CT_SheetPr(BaseOxmlElement):
"""
Complex type (sml-sheet.xsd)
"""
tabColor = ZeroOrOne('ssml:tabColor') # Sheet Tab Color
outlinePr = ZeroOrOne('ssml:outlinePr') # Outline Properties
pageSetUpPr = ZeroOrOne('ssml:pageSetUpPr') # Page Setup Properties
syncHorizontal = OptionalAttribute('syncHorizontal', XsdBoolean,
False) # Synch Horizontal
syncVertical = OptionalAttribute('syncVertical', XsdBoolean,
False) # Synch Vertical
syncRef = OptionalAttribute('syncRef', ST_Ref) # Synch Reference
transitionEvaluation = OptionalAttribute(
'transitionEvaluation', XsdBoolean,
False) # Transition Formula Evaluation
transitionEntry = OptionalAttribute('transitionEntry', XsdBoolean,
False) # Transition Formula Entry
published = OptionalAttribute('published', XsdBoolean, True) # Published
codeName = OptionalAttribute('codeName', XsdString) # Code Name
filterMode = OptionalAttribute('filterMode', XsdBoolean,
False) # Filter Mode
enableFormatConditionsCalculation = OptionalAttribute(
'enableFormatConditionsCalculation', XsdBoolean,
True) # Enable Conditional Formatting Calculations
class CT_NumPr(BaseOxmlElement):
"""
A ``<w:numPr>`` element, a container for numbering properties applied to
a paragraph.
"""
ilvl = ZeroOrOne('w:ilvl',
successors=('w:numId', 'w:numberingChange', 'w:ins'))
numId = ZeroOrOne('w:numId', successors=('w:numberingChange', 'w:ins'))
class CT_PatternFill(BaseOxmlElement):
"""
Complex type (sml-styles.xsd)
"""
fgColor = ZeroOrOne('ssml:fgColor') # Foreground Color
bgColor = ZeroOrOne('ssml:bgColor') # Background Color
patternType = OptionalAttribute('patternType',
ST_PatternType) # Pattern Type
class CT_AutoFilter(BaseOxmlElement):
"""
Complex type (sml-autoFilter.xsd)
"""
filterColumn = ZeroOrMore('ssml:filterColumn') # AutoFilter Column
sortState = ZeroOrOne('ssml:sortState') # Sort State for Auto Filter
extLst = ZeroOrOne('ssml:extLst') # None
ref = OptionalAttribute('ref', ST_Ref) # Cell or Range Reference
class CT_CustomChartsheetView(BaseOxmlElement):
"""
Complex type (sml-sheet.xsd)
"""
pageMargins = ZeroOrOne('ssml:pageMargins') # None
pageSetup = ZeroOrOne('ssml:pageSetup') # Chart Sheet Page Setup
headerFooter = ZeroOrOne('ssml:headerFooter') # None
guid = RequiredAttribute('guid', ST_Guid) # GUID
scale = OptionalAttribute('scale', XsdUnsignedInt) # Print Scale
state = OptionalAttribute('state', ST_SheetState) # Visible State
zoomToFit = OptionalAttribute('zoomToFit', XsdBoolean,
False) # Zoom To Fit
class CT_SheetViews(BaseOxmlElement):
"""
Complex type (sml-sheet.xsd)
"""
sheetView = OneOrMore('ssml:sheetView') # Worksheet View
extLst = ZeroOrOne('ssml:extLst') # Future Feature Data Storage Area
class CT_Cell(BaseOxmlElement):
"""
Complex type (sml-sheet.xsd)
"""
f = ZeroOrOne('ssml:f') # Formula
v = ZeroOrOne('ssml:v') # Cell Value
is_ = ZeroOrOne('ssml:is') # Rich Text Inline
extLst = ZeroOrMore('ssml:extLst') # Future Feature Data Storage Area
r = OptionalAttribute('r', ST_CellRef) # Reference
s = OptionalAttribute('s', XsdUnsignedInt, 0) # Style Index
t = OptionalAttribute('t', ST_CellType, 'n') # Cell Data Type
cm = OptionalAttribute('cm', XsdUnsignedInt, 0) # Cell Metadata Index
vm = OptionalAttribute('vm', XsdUnsignedInt, 0) # Value Metadata Index
ph = OptionalAttribute('ph', XsdBoolean, False) # Show Phonetic
class CT_IgnoredErrors(BaseOxmlElement):
"""
Complex type (sml-sheet.xsd)
"""
ignoredError = OneOrMore('ssml:ignoredError') # Ignored Error
extLst = ZeroOrOne('ssml:extLst') # None
class CT_ChartsheetViews(BaseOxmlElement):
"""
Complex type (sml-sheet.xsd)
"""
sheetView = OneOrMore('ssml:sheetView') # Chart Sheet View
extLst = ZeroOrOne('ssml:extLst') # None
class CT_SST(BaseOxmlElement):
si = ZeroOrMore('ssml:si')
extLst = ZeroOrOne('ssml:extLst') # None
count = OptionalAttribute('count', XsdUnsignedInt) # String Count
uniqueCount = OptionalAttribute('uniqueCount',
XsdUnsignedInt) # Unique String Count
class CT_BookView(BaseOxmlElement):
"""
Complex type (sml-workbook.xsd)
"""
extLst = ZeroOrOne('ssml:extLst') # None
visibility = OptionalAttribute('visibility', ST_Visibility,
'visible') # Visibility
minimized = OptionalAttribute('minimized', XsdBoolean, False) # Minimized
showHorizontalScroll = OptionalAttribute('showHorizontalScroll',
XsdBoolean,
True) # Show Horizontal Scroll
showVerticalScroll = OptionalAttribute('showVerticalScroll', XsdBoolean,
True) # Show Vertical Scroll
showSheetTabs = OptionalAttribute('showSheetTabs', XsdBoolean,
True) # Show Sheet Tabs
xWindow = OptionalAttribute('xWindow',
XsdInt) # Upper Left Corner (X Coordinate)
yWindow = OptionalAttribute('yWindow',
XsdInt) # Upper Left Corner (Y Coordinate)
windowWidth = OptionalAttribute('windowWidth',
XsdUnsignedInt) # Window Width
windowHeight = OptionalAttribute('windowHeight',
XsdUnsignedInt) # Window Height
tabRatio = OptionalAttribute('tabRatio', XsdUnsignedInt,
600) # Sheet Tab Ratio
firstSheet = OptionalAttribute('firstSheet', XsdUnsignedInt,
0) # First Sheet
activeTab = OptionalAttribute('activeTab', XsdUnsignedInt,
0) # Active Sheet Index
autoFilterDateGrouping = OptionalAttribute(
'autoFilterDateGrouping', XsdBoolean, True) # AutoFilter Date Grouping
class CT_SheetView(BaseOxmlElement):
"""
Complex type (sml-sheet.xsd)
"""
pane = ZeroOrOne('ssml:pane') # View Pane
selection = ZeroOrMore('ssml:selection') # Selection
pivotSelection = ZeroOrMore('ssml:pivotSelection') # PivotTable Selection
extLst = ZeroOrOne('ssml:extLst') # Future Feature Data Storage Area
windowProtection = OptionalAttribute('windowProtection', XsdBoolean,
False) # Window Protection
showFormulas = OptionalAttribute('showFormulas', XsdBoolean,
False) # Show Formulas
showGridLines = OptionalAttribute('showGridLines', XsdBoolean,
True) # Show Grid Lines
showRowColHeaders = OptionalAttribute('showRowColHeaders', XsdBoolean,
True) # Show Headers
showZeros = OptionalAttribute('showZeros', XsdBoolean,
True) # Show Zero Values
rightToLeft = OptionalAttribute('rightToLeft', XsdBoolean,
False) # Right To Left
tabSelected = OptionalAttribute('tabSelected', XsdBoolean,
False) # Sheet Tab Selected
showRuler = OptionalAttribute('showRuler', XsdBoolean, True) # Show Ruler
showOutlineSymbols = OptionalAttribute('showOutlineSymbols', XsdBoolean,
True) # Show Outline Symbols
defaultGridColor = OptionalAttribute('defaultGridColor', XsdBoolean,
True) # Default Grid Color
showWhiteSpace = OptionalAttribute('showWhiteSpace', XsdBoolean,
True) # Show White Space
view = OptionalAttribute('view', ST_SheetViewType, 'normal') # View Type
topLeftCell = OptionalAttribute('topLeftCell',
ST_CellRef) # Top Left Visible Cell
colorId = OptionalAttribute('colorId', XsdUnsignedInt, 64) # Color Id
zoomScale = OptionalAttribute('zoomScale', XsdUnsignedInt,
100) # Zoom Scale
zoomScaleNormal = OptionalAttribute('zoomScaleNormal', XsdUnsignedInt,
0) # Zoom Scale Normal View
zoomScaleSheetLayoutView = OptionalAttribute(
'zoomScaleSheetLayoutView', XsdUnsignedInt,
0) # Zoom Scale Page Break Preview
zoomScalePageLayoutView = OptionalAttribute(
'zoomScalePageLayoutView', XsdUnsignedInt,
0) # Zoom Scale Page Layout View
workbookViewId = RequiredAttribute('workbookViewId',
XsdUnsignedInt) # Workbook View Index
class CT_BorderPr(BaseOxmlElement):
"""
Complex type (sml-styles.xsd)
"""
color = ZeroOrOne('ssml:color') # Color
style = OptionalAttribute('style', ST_BorderStyle, 'none') # Line Style
class CT_CustomSheetView(BaseOxmlElement):
"""
Complex type (sml-sheet.xsd)
"""
pane = ZeroOrOne('ssml:pane') # Pane Split Information
selection = ZeroOrOne('ssml:selection') # Selection
rowBreaks = ZeroOrOne('ssml:rowBreaks') # Horizontal Page Breaks
colBreaks = ZeroOrOne('ssml:colBreaks') # Vertical Page Breaks
pageMargins = ZeroOrOne('ssml:pageMargins') # Page Margins
printOptions = ZeroOrOne('ssml:printOptions') # Print Options
pageSetup = ZeroOrOne('ssml:pageSetup') # Page Setup Settings
headerFooter = ZeroOrOne('ssml:headerFooter') # Header Footer Settings
autoFilter = ZeroOrOne('ssml:autoFilter') # AutoFilter Settings
extLst = ZeroOrMore('ssml:extLst') # None
guid = RequiredAttribute('guid', ST_Guid) # GUID
scale = OptionalAttribute('scale', XsdUnsignedInt) # Print Scale
colorId = OptionalAttribute('colorId', XsdUnsignedInt) # Color Id
showPageBreaks = OptionalAttribute('showPageBreaks', XsdBoolean,
False) # Show Page Breaks
showFormulas = OptionalAttribute('showFormulas', XsdBoolean,
False) # Show Formulas
showGridLines = OptionalAttribute('showGridLines', XsdBoolean,
True) # Show Grid Lines
showRowCol = OptionalAttribute('showRowCol', XsdBoolean,
True) # Show Headers
outlineSymbols = OptionalAttribute('outlineSymbols', XsdBoolean,
True) # Show Outline Symbols
zeroValues = OptionalAttribute('zeroValues', XsdBoolean,
True) # Show Zero Values
fitToPage = OptionalAttribute('fitToPage', XsdBoolean,
False) # Fit To Page
printArea = OptionalAttribute('printArea', XsdBoolean,
False) # Print Area Defined
filter = OptionalAttribute('filter', XsdBoolean, False) # Filtered List
showAutoFilter = OptionalAttribute(
'showAutoFilter', XsdBoolean,
False) # Show AutoFitler Drop Down Controls
hiddenRows = OptionalAttribute('hiddenRows', XsdBoolean,
False) # Hidden Rows
hiddenColumns = OptionalAttribute('hiddenColumns', XsdBoolean,
False) # Hidden Columns
state = OptionalAttribute('state', ST_SheetState) # Visible State
filterUnique = OptionalAttribute('filterUnique', XsdBoolean,
False) # Filter
view = OptionalAttribute('view', ST_SheetViewType) # View Type
showRuler = OptionalAttribute('showRuler', XsdBoolean, True) # Show Ruler
topLeftCell = OptionalAttribute('topLeftCell',
ST_CellRef) # Top Left Visible Cell
class CT_ChartsheetPr(BaseOxmlElement):
"""
Complex type (sml-sheet.xsd)
"""
tabColor = ZeroOrOne('ssml:tabColor') # None
published = OptionalAttribute('published', XsdBoolean, True) # Published
codeName = OptionalAttribute('codeName', XsdString) # Code Name
class CT_Cfvo(BaseOxmlElement):
"""
Complex type (sml-sheet.xsd)
"""
extLst = ZeroOrOne('ssml:extLst') # None
type = RequiredAttribute('type', ST_CfvoType) # Type
val = OptionalAttribute('val', ST_Xstring) # Value
gte = OptionalAttribute('gte', XsdBoolean, True) # Greater Than Or Equal
class CT_SortState(BaseOxmlElement):
"""
Complex type (sml-autoFilter.xsd)
"""
sortCondition = ZeroOrMore('ssml:sortCondition') # Sort Condition
extLst = ZeroOrOne('ssml:extLst') # None
columnSort = OptionalAttribute('columnSort', XsdBoolean, False) # Sort by Columns
caseSensitive = OptionalAttribute('caseSensitive', XsdBoolean, False) # Case Sensitive
sortMethod = OptionalAttribute('sortMethod', ST_SortMethod, 'none') # Sort Method
ref = RequiredAttribute('ref', ST_Ref) # Sort Range
class CT_Parent(BaseOxmlElement):
"""
``<w:parent>`` element, an invented element for use in testing.
"""
eg_zooChoice = ZeroOrOneChoice((Choice('w:choice'), Choice('w:choice2')),
successors=('w:oomChild', 'w:oooChild'))
oomChild = OneOrMore('w:oomChild',
successors=('w:oooChild', 'w:zomChild', 'w:zooChild'))
oooChild = OneAndOnlyOne('w:oooChild')
zomChild = ZeroOrMore('w:zomChild', successors=('w:zooChild', ))
zooChild = ZeroOrOne('w:zooChild', successors=())
optAttr = OptionalAttribute('w:optAttr', ST_IntegerType)
reqAttr = RequiredAttribute('reqAttr', ST_IntegerType)
class CT_Dialogsheet(BaseOxmlElement):
"""
Complex type (sml-sheet.xsd)
"""
sheetPr = ZeroOrMore('ssml:sheetPr') # Sheet Properties
sheetViews = ZeroOrMore('ssml:sheetViews') # Dialog Sheet Views
sheetFormatPr = ZeroOrMore(
'ssml:sheetFormatPr') # Dialog Sheet Format Properties
sheetProtection = ZeroOrOne('ssml:sheetProtection') # Sheet Protection
customSheetViews = ZeroOrMore(
'ssml:customSheetViews') # Custom Sheet Views
printOptions = ZeroOrMore('ssml:printOptions') # Print Options
pageMargins = ZeroOrMore('ssml:pageMargins') # Page Margins
pageSetup = ZeroOrMore('ssml:pageSetup') # Page Setup Settings
headerFooter = ZeroOrMore('ssml:headerFooter') # Header & Footer Settings
drawing = ZeroOrMore('ssml:drawing') # Drawing
legacyDrawing = ZeroOrMore('ssml:legacyDrawing') # Legacy Drawing
legacyDrawingHF = ZeroOrOne(
'ssml:legacyDrawingHF') # Legacy Drawing Header Footer
oleObjects = ZeroOrOne('ssml:oleObjects') # None
extLst = ZeroOrMore('ssml:extLst') # Future Feature Data Storage Area
class CT_Document(BaseOxmlElement):
"""
``<w:document>`` element, the root element of a document.xml file.
"""
body = ZeroOrOne('w:body')
@property
def sectPr_lst(self):
"""
Return a list containing a reference to each ``<w:sectPr>`` element
in the document, in the order encountered.
"""
return self.xpath('.//w:sectPr')
class CT_Dxf(BaseOxmlElement):
"""
Complex type (sml-styles.xsd)
"""
font = ZeroOrOne('ssml:font') # Font Properties
numFmt = ZeroOrOne('ssml:numFmt') # Number Format
fill = ZeroOrOne('ssml:fill') # Fill
alignment = ZeroOrOne('ssml:alignment') # Alignment
border = ZeroOrOne('ssml:border') # Border Properties
protection = ZeroOrOne('ssml:protection') # Protection Properties
extLst = ZeroOrOne('ssml:extLst') # Future Feature Data Storage Area
class CT_DataConsolidate(BaseOxmlElement):
"""
Complex type (sml-sheet.xsd)
"""
dataRefs = ZeroOrOne('ssml:dataRefs') # Data Consolidation References
function = OptionalAttribute('function', ST_DataConsolidateFunction,
'sum') # Function Index
leftLabels = OptionalAttribute('leftLabels', XsdBoolean,
False) # Use Left Column Labels
topLabels = OptionalAttribute('topLabels', XsdBoolean,
False) # Labels In Top Row
link = OptionalAttribute('link', XsdBoolean, False) # Link
class CT_NumLvl(BaseOxmlElement):
"""
``<w:lvlOverride>`` element, which identifies a level in a list
definition to override with settings it contains.
"""
startOverride = ZeroOrOne('w:startOverride', successors=('w:lvl', ))
ilvl = RequiredAttribute('w:ilvl', ST_DecimalNumber)
def add_startOverride(self, val):
"""
Return a newly added CT_DecimalNumber element having tagname
``w:startOverride`` and ``val`` attribute set to *val*.
"""
return self._add_startOverride(val=val)
class CT_CellStyle(BaseOxmlElement):
"""
Complex type (sml-styles.xsd)
"""
extLst = ZeroOrOne('ssml:extLst') # Future Feature Data Storage Area
name = OptionalAttribute('name', ST_Xstring) # User Defined Cell Style
xfId = RequiredAttribute('xfId', ST_CellStyleXfId) # Format Id
builtinId = OptionalAttribute('builtinId',
XsdUnsignedInt) # Built-In Style Id
iLevel = OptionalAttribute('iLevel', XsdUnsignedInt) # Outline Style
hidden = OptionalAttribute('hidden', XsdBoolean) # Hidden Style
customBuiltin = OptionalAttribute('customBuiltin',
XsdBoolean) # Custom Built In
