parasol.Word

144 """Wrapper around Word documents to make them easy to build. 145 Has variables for the Applications, Document and Selection; 146 most methods add things at the end of the document"""

147 - def __init__(self, templatefile=None):

148 self.wordApp = Dispatch('Word.Application') 149 if templatefile == None: 150 self.wordDoc = self.wordApp.Documents.Add() 151 else: 152 self.wordDoc = self.wordApp.Documents.Add( Template=templatefile) 153 #set up the selection 154 self.wordDoc.Range(0,0).Select() 155 self.wordSel = self.wordApp.Selection

156 #fetch the styles in the document - see below 157 #self.getStyleDictionary() 158

159 - def show(self):

160 # convenience when developing 161 self.wordApp.Visible = 1

162

163 - def showFastView(self):

164 self.wordApp.Visible = 1 165 self.wordApp.Windows(1).View.Type = wdNormalView 166 self.wordApp.Options.Pagination = False

167 #self.wordApp.ScreenUpdating = False 168

169 - def setFastOptions(self):

170 self.wordApp.Visible = 0 171 self.wordApp.Windows(1).View.Type = wdNormalView 172 self.wordApp.Options.Pagination = False 173 self.wordApp.ScreenUpdating = False

174 175 # Save and Print

176 - def saveAs(self, filename):

177 self.wordDoc.SaveAs(filename)

178

179 - def Quit(self):

180 self.wordApp.Quit()

181

182 - def abandonWord(self):

183 #print "self.wordApp.DisplayAlerts",w.wordApp.DisplayAlerts 184 wdDoNotSaveChanges =0x0 # from enum WdSaveOptions 185 self.wordApp.Quit(wdDoNotSaveChanges)

186

187 - def printout(self):

188 self.wordDoc.PrintOut()

189

190 - def changeStartSelection(self, NChar=-1):

191 '''changes selection by NChar characters at Start''' 192 pbTextUnitCharacter = 1 193 self.wordSel.MoveStart( pbTextUnitCharacter, NChar )

194

195 - def changeEndSelection(self, NChar=-1):

196 '''changes selection by NChar characters at End''' 197 pbTextUnitCharacter = 1 198 self.wordSel.MoveEnd( pbTextUnitCharacter, NChar )

199 200 # Move the selection to the end, and insert into selection

201 - def selectEnd(self):

202 # ensures insertion point is at the end of the document 203 self.wordSel.Collapse(0)

204 # 0 is the constant wdCollapseEnd; don't want to depend 205 # on makepy support. 206

207 - def addText(self, text):

208 R = self.wordSel.InsertAfter(text) 209 self.selectEnd()

210 #return R 211

212 - def addSelectedText(self, text):

213 R = self.wordSel.InsertBefore(text)

214 #self.selectEnd() 215 #return R 216 217 ''' 218 Insert a paragraph in a named style 219 Fast, versatile, and lets graphic designers set the styles in Word. 220 >>> from win32com.client import constants 221 >>> mySelection.Style = constants.wdStyleHeading1 222 >>> 223 However, (a) this is limited to the built-in styles, and 224 (b) won't work without MakePy. 225 Our solution: get a style list back at run time, and use it to add them by name: 226 227 '''

228 - def getStyleList(self):

229 # returns a dictionary of the styles in a document 230 self.styles = [] 231 stylecount = self.wordDoc.Styles.Count 232 for i in range(1, stylecount + 1): 233 styleObject = self.wordDoc.Styles(i) 234 self.styles.append(styleObject.NameLocal)

235

236 - def addStyledPara(self, text, stylename):

237 if text[-1] <> '\n': 238 text = text + '\n' 239 self.wordSel.InsertAfter(text) 240 self.wordSel.Style = stylename

241

242 - def addTable(self, tableList, styleid=None, Range=None, fullWidth=0):

243 # Takes a 'list of lists' of data. 244 # first we format the text. You might want to preformat 245 # numbers with the right decimal places etc. first. 246 247 # replace last character in document if Range is empty 248 if Range==None: 249 Range = self.selectCharacter( -1 ) 250 251 textlines = [] 252 NRows = len( tableList ) 253 NCols = 1 254 for row in tableList: 255 if len(row)>NCols: 256 NCols = len(row) 257 258 #Tbl = self.wordDoc.Tables.Add(Range=Range, 259 # NumRows=NRows, NumColumns=NCols) 260 if fullWidth: 261 autofit = wdAutoFitWindow 262 else: 263 autofit = wdAutoFitContent 264 Tbl = self.wordDoc.Tables.Add( Range, NRows, NCols, wdWord9TableBehavior, autofit) 265 266 #Tbl.AutoFitBehavior = wdAutoFitContent 267 268 NR = 1 269 for row in tableList: 270 NC = 1 271 for s in row: 272 Tbl.Cell(NR, NC).Range.Text = str( s ) 273 NC += 1 274 NR += 1 275 276 #and format 277 if styleid: 278 Tbl.AutoFormat(Format=styleid) 279 280 Tbl.AllowPageBreaks = False 281 return Tbl

282

283 - def createTableStyle(self, name='myStyle', font='Arial', 284 color='', bgcolor='', 285 size=14, borders=1, bold=0, keepTogether=1):

286 287 styl = self.wordDoc.Styles.Add(Name=name, Type=wdStyleTypeTable) 288 styl.Font.Name = font 289 styl.Font.Size = size 290 291 if keepTogether: 292 styl.ParagraphFormat.KeepWithNext = True 293 styl.ParagraphFormat.KeepTogether = True 294 295 if bold: 296 styl.Font.Bold = True 297 else: 298 styl.Font.Bold = False 299 300 if len(bgcolor)>0: 301 try: 302 styl.Table.Shading.BackgroundPatternColor = colorDict[bgcolor] 303 except: 304 pass 305 306 if len(color)>0: 307 try: 308 #styl.Font.ColorIndex = textColorIndexDict[color] 309 styl.Font.Color = colorDict[color] 310 except: 311 pass 312 313 if borders: 314 styl.Table.Borders.Enable = True 315 else: 316 styl.Table.Borders.Enable = False 317 styl.Table.Borders.InsideLineStyle = wdLineStyleNone 318 styl.Table.Borders.OutsideLineStyle = wdLineStyleNone 319 styl.Table.Borders(wdBorderBottom).LineStyle = wdLineStyleNone 320 styl.Table.Borders(wdBorderLeft).LineStyle = wdLineStyleNone 321 styl.Table.Borders(wdBorderRight).LineStyle = wdLineStyleNone 322 styl.Table.Borders(wdBorderTop).LineStyle = wdLineStyleNone 323 styl.Table.Borders(wdBorderHorizontal).LineStyle = wdLineStyleNone 324 styl.Table.Borders(wdBorderVertical).LineStyle = wdLineStyleNone 325 326 return styl

327 328

329 - def addCellText(self, Table=None, row=1, col=1, text=''):

330 if Table==None: 331 return 332 333 Table.Cell(row, col).Range.Text = str( text )

334

335 - def setAllTableCellStyle(self, Table=None, StyleName=None):

336 if Table==None or StyleName==None: 337 return 338 339 for i in range(1, Table.Rows.Count+1): 340 for j in range(1, Table.Columns.Count+1): 341 try: 342 Table.Cell(i,j).Range.Style = StyleName 343 except: 344 pass

345

346 - def setCellStyle(self, Table=None, row=1, col=1, text='', 347 StyleName='', fontName='', fontSize=0, just='', bold=None, 348 color='', bgcolor='', width=0):

349 if Table==None: 350 return 351 352 if row<1: row=1 353 if row>Table.Rows.Count: row=Table.Rows.Count 354 if col<1: col=1 355 if col>Table.Columns.Count: col=Table.Columns.Count 356 357 if len(text)>0: 358 try: 359 Table.Cell(row, col).Range.Text = str( text ) 360 except: 361 pass 362 363 if len(StyleName)>0: 364 try: 365 Table.Cell(row,col).Range.Style = StyleName 366 except: 367 pass 368 369 if len(fontName)>0: 370 try: 371 Table.Cell(row,col).Range.Font.Name = fontName 372 except: 373 pass 374 375 if fontSize>0: 376 try: 377 Table.Cell(row,col).Range.Font.Size = fontSize 378 except: 379 pass 380 381 if len(just)>0: 382 try: 383 Table.Cell(row,col).Range.ParagraphFormat.Alignment = justDict[just] 384 except: 385 pass 386 387 if bold != None: 388 try: 389 Table.Cell(row,col).Range.Font.Bold = bold 390 except: 391 pass 392 393 if len(color)>0: 394 try: 395 Table.Cell(row,col).Range.Font.Color = colorDict[color] 396 except: 397 pass 398 399 if len(bgcolor)>0: 400 try: 401 Table.Cell(row,col).Range.Shading.BackgroundPatternColor = colorDict[bgcolor] 402 except: 403 pass 404 405 if width>0: 406 try: 407 Table.Cell(row,col).Width=width 408 except: 409 pass

410

411 - def mergeRow(self, Table=None, NRow=1):

412 if Table==None: 413 return 414 415 myrow = Table.Rows(NRow) 416 myrow.Cells.Merge()

417 418 '''Adding Charts and Images 419 Let's assume we've set up and saved an 420 Excel sheet with the right chart in it already. 421 '''

422 - def addInlineExcelChart(self, filename, caption='', 423 height=216, width=432):

424 # adds a chart inline within the text, caption below. 425 # add an InlineShape to the InlineShapes collection 426 #- could appear anywhere 427 shape = self.wordDoc.InlineShapes.AddOLEObject( 428 ClassType='Excel.Chart', 429 FileName=filename 430 ) 431 # set height and width in points 432 shape.Height = height 433 shape.Width = width 434 435 # put it where we want 436 shape.Range.Cut() 437 self.wordSel.InsertAfter('chart will replace this') 438 self.wordSel.Range.Paste() # goes in selection 439 self.addStyledPara(caption, 'Normal')

440

441 - def addImage(self, filename, Range=None, fracPage=0.5):

442 # without a range, the picture is added at the top 443 hw=self.wordDoc.InlineShapes 444 if Range==None: 445 Image = hw.AddPicture(filename) 446 else: 447 # AddPicture(FileName, LinkToFile, SaveWithDocument, Range) 448 print "Range provided for image add" 449 Image = hw.AddPicture(filename, False, True, Range) 450 451 PageW = self.wordDoc.PageSetup.PageWidth 452 desiredW = int( fracPage * PageW ) 453 if Image.Width > desiredW: 454 ratio = float( desiredW ) / Image.Width 455 Image.Width = int( ratio * Image.Width ) 456 Image.Height = int( ratio * Image.Height ) 457 458 return Image

459

460 - def selectParagraph(self, N=1):

461 # can also use negative numbers like python indexing 462 Ps = self.wordDoc.Paragraphs 463 if N<0: 464 N = Ps.Count + N + 1 465 if N<1: N=1 466 if N>Ps.Count: N = Ps.Count 467 468 RN = Ps(N).Range 469 RN.Select() 470 return RN

471

472 - def selectSentence(self, N=1):

473 # can also use negative numbers like python indexing 474 Ss = self.wordDoc.Sentences 475 if N<0: 476 N = Ss.Count + N + 1 477 if N<1: N=1 478 if N>Ss.Count: N = Ss.Count 479 480 RN = self.wordDoc.Range( Ss(N).Start, Ss(N).End) 481 RN.Select() 482 return RN

483

484 - def selectWord(self, N=1):

485 # can also use negative numbers like python indexing 486 Ws = self.wordDoc.Words 487 if N<0: 488 N = Ws.Count + N + 1 489 if N<1: N=1 490 if N>Ws.Count: N = Ws.Count 491 492 RN = self.wordDoc.Range( Ws(N).Start, Ws(N).End) 493 RN.Select() 494 return RN

495

496 - def selectCharacter(self, N=1):

497 Cs = self.wordDoc.Characters 498 if N<0: 499 N = Cs.Count + N + 1 500 if N<1: N=1 501 if N>Cs.Count: N = Cs.Count 502 503 RN = self.wordDoc.Range( Cs(N).Start, Cs(N).End) 504 RN.Select() 505 return RN

Source Code for Module parasol.Word_wrapper