openpyxl.comments.comment_sheet module¶

class openpyxl.comments.comment_sheet.CommentRecord(ref='', authorId=0, guid=None, shapeId=0, text=None, commentPr=None, author=None)[source]¶

Bases: openpyxl.descriptors.serialisable.Serialisable

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

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

commentPr¶: Values must be of type <class ‘openpyxl.comments.comment_sheet.Properties’>

content¶: Remove all inline formatting and stuff

classmethod from_cell(cell)[source]¶: Class method to convert cell comment

guid¶

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

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

tagname = 'comment'¶

text¶: Values must be of type <class ‘openpyxl.cell.text.Text’>

class openpyxl.comments.comment_sheet.CommentSheet(authors=None, commentList=None, extLst=None)[source]¶

Bases: openpyxl.descriptors.serialisable.Serialisable

authors¶: Values must be of type <class ‘openpyxl.comments.author.AuthorList’>

commentList¶: Wrap a sequence in an containing object

comments¶: Return a dictionary of comments keyed by coord

extLst¶: Values must be of type <class ‘openpyxl.descriptors.excel.ExtensionList’>

classmethod from_comments(comments)[source]¶: Create a comment sheet from a list of comments for a particular worksheet

mime_type = 'application/vnd.openxmlformats-officedocument.spreadsheetml.comments+xml'¶

path¶: Return path within the archive

tagname = 'comments'¶

to_tree()[source]¶

write_shapes(vml=None)[source]¶: Create the VML for comments

class openpyxl.comments.comment_sheet.ObjectAnchor(moveWithCells=None, sizeWithCells=None)[source]¶

Bases: openpyxl.descriptors.serialisable.Serialisable

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

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

class openpyxl.comments.comment_sheet.Properties(locked=None, defaultSize=None, _print=None, disabled=None, uiObject=None, autoFill=None, autoLine=None, altText=None, textHAlign=None, textVAlign=None, lockText=None, justLastX=None, autoScale=None, rowHidden=None, colHidden=None, anchor=None)[source]¶

Bases: openpyxl.descriptors.serialisable.Serialisable

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

anchor¶: Values must be of type <class ‘openpyxl.comments.comment_sheet.ObjectAnchor’>

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

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

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

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

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

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

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

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

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

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

textHAlign¶: Value must be one of {‘right’, ‘justify’, ‘distributed’, ‘left’, ‘center’}

textVAlign¶: Value must be one of {‘top’, ‘justify’, ‘distributed’, ‘bottom’, ‘center’}

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