forked from jmcnamara/XlsxWriter
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathexample_comments2.html
More file actions
385 lines (297 loc) · 35.4 KB
/
example_comments2.html
File metadata and controls
385 lines (297 loc) · 35.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Example: Adding Cell Comments to Worksheets (Advanced) — XlsxWriter Documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.3.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="XlsxWriter Documentation" href="index.html" />
<link rel="up" title="Examples" href="examples.html" />
<link rel="next" title="Example: Outline and Grouping" href="example_outline1.html" />
<link rel="prev" title="Example: Adding Cell Comments to Worksheets (Simple)" href="example_comments1.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="example_outline1.html" title="Example: Outline and Grouping"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="example_comments1.html" title="Example: Adding Cell Comments to Worksheets (Simple)"
accesskey="P">previous</a> |</li>
<li><a href="index.html">XlsxWriter Documentation</a> »</li>
<li><a href="examples.html" accesskey="U">Examples</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="example-adding-cell-comments-to-worksheets-advanced">
<span id="ex-comments2"></span><h1>Example: Adding Cell Comments to Worksheets (Advanced)</h1>
<p>Another example of adding cell comments to a worksheet. This example
demonstrates most of the available comment formatting options. For more
details see <a class="reference internal" href="working_with_cell_comments.html#cell-comments"><em>Working with Cell Comments</em></a>.</p>
<img alt="_images/comments2.png" src="_images/comments2.png" />
<div class="highlight-python"><div class="highlight"><pre><span class="c">###############################################################################</span>
<span class="c">#</span>
<span class="c"># An example of writing cell comments to a worksheet using Python and</span>
<span class="c"># XlsxWriter.</span>
<span class="c">#</span>
<span class="c"># Each of the worksheets demonstrates different features of cell comments.</span>
<span class="c">#</span>
<span class="c"># Copyright 2013, John McNamara, jmcnamara@cpan.org</span>
<span class="c">#</span>
<span class="kn">from</span> <span class="nn">xlsxwriter.workbook</span> <span class="kn">import</span> <span class="n">Workbook</span>
<span class="n">workbook</span> <span class="o">=</span> <span class="n">Workbook</span><span class="p">(</span><span class="s">'comments2.xlsx'</span><span class="p">)</span>
<span class="n">worksheet1</span> <span class="o">=</span> <span class="n">workbook</span><span class="o">.</span><span class="n">add_worksheet</span><span class="p">()</span>
<span class="n">worksheet2</span> <span class="o">=</span> <span class="n">workbook</span><span class="o">.</span><span class="n">add_worksheet</span><span class="p">()</span>
<span class="n">worksheet3</span> <span class="o">=</span> <span class="n">workbook</span><span class="o">.</span><span class="n">add_worksheet</span><span class="p">()</span>
<span class="n">worksheet4</span> <span class="o">=</span> <span class="n">workbook</span><span class="o">.</span><span class="n">add_worksheet</span><span class="p">()</span>
<span class="n">worksheet5</span> <span class="o">=</span> <span class="n">workbook</span><span class="o">.</span><span class="n">add_worksheet</span><span class="p">()</span>
<span class="n">worksheet6</span> <span class="o">=</span> <span class="n">workbook</span><span class="o">.</span><span class="n">add_worksheet</span><span class="p">()</span>
<span class="n">worksheet7</span> <span class="o">=</span> <span class="n">workbook</span><span class="o">.</span><span class="n">add_worksheet</span><span class="p">()</span>
<span class="n">worksheet8</span> <span class="o">=</span> <span class="n">workbook</span><span class="o">.</span><span class="n">add_worksheet</span><span class="p">()</span>
<span class="n">text_wrap</span> <span class="o">=</span> <span class="n">workbook</span><span class="o">.</span><span class="n">add_format</span><span class="p">({</span><span class="s">'text_wrap'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s">'valign'</span><span class="p">:</span> <span class="s">'top'</span><span class="p">})</span>
<span class="c">###############################################################################</span>
<span class="c">#</span>
<span class="c"># Example 1. Demonstrates a simple cell comments without formatting.</span>
<span class="c"># comments.</span>
<span class="c">#</span>
<span class="c"># Set up some formatting.</span>
<span class="n">worksheet1</span><span class="o">.</span><span class="n">set_column</span><span class="p">(</span><span class="s">'C:C'</span><span class="p">,</span> <span class="mi">25</span><span class="p">)</span>
<span class="n">worksheet1</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet1</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="c"># Simple ASCII string.</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'Hold the mouse over this cell to see the comment.'</span>
<span class="n">comment</span> <span class="o">=</span> <span class="s">'This is a comment.'</span>
<span class="n">worksheet1</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C3'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet1</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C3'</span><span class="p">,</span> <span class="n">comment</span><span class="p">)</span>
<span class="c">###############################################################################</span>
<span class="c">#</span>
<span class="c"># Example 2. Demonstrates visible and hidden comments.</span>
<span class="c">#</span>
<span class="c"># Set up some formatting.</span>
<span class="n">worksheet2</span><span class="o">.</span><span class="n">set_column</span><span class="p">(</span><span class="s">'C:C'</span><span class="p">,</span> <span class="mi">25</span><span class="p">)</span>
<span class="n">worksheet2</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet2</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'This cell comment is visible.'</span>
<span class="n">comment</span> <span class="o">=</span> <span class="s">'Hello.'</span>
<span class="n">worksheet2</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C3'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet2</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C3'</span><span class="p">,</span> <span class="n">comment</span><span class="p">,</span> <span class="p">{</span><span class="s">'visible'</span><span class="p">:</span> <span class="bp">True</span><span class="p">})</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">"This cell comment isn't visible (the default)."</span>
<span class="n">worksheet2</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C6'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet2</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C6'</span><span class="p">,</span> <span class="n">comment</span><span class="p">)</span>
<span class="c">###############################################################################</span>
<span class="c">#</span>
<span class="c"># Example 3. Demonstrates visible and hidden comments set at the worksheet</span>
<span class="c"># level.</span>
<span class="c">#</span>
<span class="c"># Set up some formatting.</span>
<span class="n">worksheet3</span><span class="o">.</span><span class="n">set_column</span><span class="p">(</span><span class="s">'C:C'</span><span class="p">,</span> <span class="mi">25</span><span class="p">)</span>
<span class="n">worksheet3</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet3</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet3</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">8</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="c"># Make all comments on the worksheet visible.</span>
<span class="n">worksheet3</span><span class="o">.</span><span class="n">show_comments</span><span class="p">()</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'This cell comment is visible, explicitly.'</span>
<span class="n">comment</span> <span class="o">=</span> <span class="s">'Hello.'</span>
<span class="n">worksheet3</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C3'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet3</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C3'</span><span class="p">,</span> <span class="n">comment</span><span class="p">,</span> <span class="p">{</span><span class="s">'visible'</span><span class="p">:</span> <span class="mi">1</span><span class="p">})</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'This cell comment is also visible because of show_comments().'</span>
<span class="n">worksheet3</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C6'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet3</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C6'</span><span class="p">,</span> <span class="n">comment</span><span class="p">)</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'However, we can still override it locally.'</span>
<span class="n">worksheet3</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C9'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet3</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C9'</span><span class="p">,</span> <span class="n">comment</span><span class="p">,</span> <span class="p">{</span><span class="s">'visible'</span><span class="p">:</span> <span class="bp">False</span><span class="p">})</span>
<span class="c">###############################################################################</span>
<span class="c">#</span>
<span class="c"># Example 4. Demonstrates changes to the comment box dimensions.</span>
<span class="c">#</span>
<span class="c"># Set up some formatting.</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">set_column</span><span class="p">(</span><span class="s">'C:C'</span><span class="p">,</span> <span class="mi">25</span><span class="p">)</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">8</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">15</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">show_comments</span><span class="p">()</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'This cell comment is default size.'</span>
<span class="n">comment</span> <span class="o">=</span> <span class="s">'Hello.'</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C3'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C3'</span><span class="p">,</span> <span class="n">comment</span><span class="p">)</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'This cell comment is twice as wide.'</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C6'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C6'</span><span class="p">,</span> <span class="n">comment</span><span class="p">,</span> <span class="p">{</span><span class="s">'x_scale'</span><span class="p">:</span> <span class="mi">2</span><span class="p">})</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'This cell comment is twice as high.'</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C9'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C9'</span><span class="p">,</span> <span class="n">comment</span><span class="p">,</span> <span class="p">{</span><span class="s">'y_scale'</span><span class="p">:</span> <span class="mi">2</span><span class="p">})</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'This cell comment is scaled in both directions.'</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C16'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C16'</span><span class="p">,</span> <span class="n">comment</span><span class="p">,</span> <span class="p">{</span><span class="s">'x_scale'</span><span class="p">:</span> <span class="mf">1.2</span><span class="p">,</span> <span class="s">'y_scale'</span><span class="p">:</span> <span class="mf">0.8</span><span class="p">})</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'This cell comment has width and height specified in pixels.'</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C19'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet4</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C19'</span><span class="p">,</span> <span class="n">comment</span><span class="p">,</span> <span class="p">{</span><span class="s">'width'</span><span class="p">:</span> <span class="mi">200</span><span class="p">,</span> <span class="s">'height'</span><span class="p">:</span> <span class="mi">20</span><span class="p">})</span>
<span class="c">###############################################################################</span>
<span class="c">#</span>
<span class="c"># Example 5. Demonstrates changes to the cell comment position.</span>
<span class="c">#</span>
<span class="n">worksheet5</span><span class="o">.</span><span class="n">set_column</span><span class="p">(</span><span class="s">'C:C'</span><span class="p">,</span> <span class="mi">25</span><span class="p">)</span>
<span class="n">worksheet5</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet5</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet5</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">8</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet5</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">11</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet5</span><span class="o">.</span><span class="n">show_comments</span><span class="p">()</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'This cell comment is in the default position.'</span>
<span class="n">comment</span> <span class="o">=</span> <span class="s">'Hello.'</span>
<span class="n">worksheet5</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C3'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet5</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C3'</span><span class="p">,</span> <span class="n">comment</span><span class="p">)</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'This cell comment has been moved to another cell.'</span>
<span class="n">worksheet5</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C6'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet5</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C6'</span><span class="p">,</span> <span class="n">comment</span><span class="p">,</span> <span class="p">{</span><span class="s">'start_cell'</span><span class="p">:</span> <span class="s">'E4'</span><span class="p">})</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'This cell comment has been moved to another cell.'</span>
<span class="n">worksheet5</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C9'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet5</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C9'</span><span class="p">,</span> <span class="n">comment</span><span class="p">,</span> <span class="p">{</span><span class="s">'start_row'</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span> <span class="s">'start_col'</span><span class="p">:</span> <span class="mi">4</span><span class="p">})</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'This cell comment has been shifted within its default cell.'</span>
<span class="n">worksheet5</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C12'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet5</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C12'</span><span class="p">,</span> <span class="n">comment</span><span class="p">,</span> <span class="p">{</span><span class="s">'x_offset'</span><span class="p">:</span> <span class="mi">30</span><span class="p">,</span> <span class="s">'y_offset'</span><span class="p">:</span> <span class="mi">12</span><span class="p">})</span>
<span class="c">###############################################################################</span>
<span class="c">#</span>
<span class="c"># Example 6. Demonstrates changes to the comment background colour.</span>
<span class="c">#</span>
<span class="n">worksheet6</span><span class="o">.</span><span class="n">set_column</span><span class="p">(</span><span class="s">'C:C'</span><span class="p">,</span> <span class="mi">25</span><span class="p">)</span>
<span class="n">worksheet6</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet6</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet6</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">8</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet6</span><span class="o">.</span><span class="n">show_comments</span><span class="p">()</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'This cell comment has a different colour.'</span>
<span class="n">comment</span> <span class="o">=</span> <span class="s">'Hello.'</span>
<span class="n">worksheet6</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C3'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet6</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C3'</span><span class="p">,</span> <span class="n">comment</span><span class="p">,</span> <span class="p">{</span><span class="s">'color'</span><span class="p">:</span> <span class="s">'green'</span><span class="p">})</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'This cell comment has the default colour.'</span>
<span class="n">worksheet6</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C6'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet6</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C6'</span><span class="p">,</span> <span class="n">comment</span><span class="p">)</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="s">'This cell comment has a different colour.'</span>
<span class="n">worksheet6</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C9'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet6</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C9'</span><span class="p">,</span> <span class="n">comment</span><span class="p">,</span> <span class="p">{</span><span class="s">'color'</span><span class="p">:</span> <span class="s">'#CCFFCC'</span><span class="p">})</span>
<span class="c">###############################################################################</span>
<span class="c">#</span>
<span class="c"># Example 7. Demonstrates how to set the cell comment author.</span>
<span class="c">#</span>
<span class="n">worksheet7</span><span class="o">.</span><span class="n">set_column</span><span class="p">(</span><span class="s">'C:C'</span><span class="p">,</span> <span class="mi">30</span><span class="p">)</span>
<span class="n">worksheet7</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet7</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">worksheet7</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">8</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">author</span> <span class="o">=</span> <span class="s">''</span>
<span class="n">cell</span> <span class="o">=</span> <span class="s">'C3'</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="p">(</span><span class="s">"Move the mouse over this cell and you will see 'Cell commented "</span>
<span class="s">"by (blank)' in the status bar at the bottom"</span><span class="p">)</span>
<span class="n">comment</span> <span class="o">=</span> <span class="s">'Hello.'</span>
<span class="n">worksheet7</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">cell</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet7</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="n">cell</span><span class="p">,</span> <span class="n">comment</span><span class="p">)</span>
<span class="n">author</span> <span class="o">=</span> <span class="s">'Python'</span>
<span class="n">cell</span> <span class="o">=</span> <span class="s">'C6'</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="p">(</span><span class="s">"Move the mouse over this cell and you will see 'Cell commented "</span>
<span class="s">"by Python' in the status bar at the bottom"</span><span class="p">)</span>
<span class="n">worksheet7</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">cell</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet7</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="n">cell</span><span class="p">,</span> <span class="n">comment</span><span class="p">,</span> <span class="p">{</span><span class="s">'author'</span><span class="p">:</span> <span class="n">author</span><span class="p">})</span>
<span class="c">###############################################################################</span>
<span class="c">#</span>
<span class="c"># Example 8. Demonstrates the need to explicitly set the row height.</span>
<span class="c">#</span>
<span class="c"># Set up some formatting.</span>
<span class="n">worksheet8</span><span class="o">.</span><span class="n">set_column</span><span class="p">(</span><span class="s">'C:C'</span><span class="p">,</span> <span class="mi">25</span><span class="p">)</span>
<span class="n">worksheet8</span><span class="o">.</span><span class="n">set_row</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">80</span><span class="p">)</span>
<span class="n">worksheet8</span><span class="o">.</span><span class="n">show_comments</span><span class="p">()</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="p">(</span><span class="s">'The height of this row has been adjusted explicitly using '</span>
<span class="s">'set_row(). The size of the comment box is adjusted '</span>
<span class="s">'accordingly by XlsxWriter.'</span><span class="p">)</span>
<span class="n">comment</span> <span class="o">=</span> <span class="s">'Hello.'</span>
<span class="n">worksheet8</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C3'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet8</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C3'</span><span class="p">,</span> <span class="n">comment</span><span class="p">)</span>
<span class="n">cell_text</span> <span class="o">=</span> <span class="p">(</span><span class="s">'The height of this row has been adjusted by Excel due to the '</span>
<span class="s">'text wrap property being set. Unfortunately this means that '</span>
<span class="s">'the height of the row is unknown to XlsxWriter at run time '</span>
<span class="s">"and thus the comment box is stretched as well.</span><span class="se">\n\n</span><span class="s">"</span>
<span class="s">'Use set_row() to specify the row height explicitly to avoid '</span>
<span class="s">'this problem.'</span><span class="p">)</span>
<span class="n">worksheet8</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'C6'</span><span class="p">,</span> <span class="n">cell_text</span><span class="p">,</span> <span class="n">text_wrap</span><span class="p">)</span>
<span class="n">worksheet8</span><span class="o">.</span><span class="n">write_comment</span><span class="p">(</span><span class="s">'C6'</span><span class="p">,</span> <span class="n">comment</span><span class="p">)</span>
<span class="n">workbook</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/logo.png" alt="Logo"/>
</a></p>
<h4>Previous topic</h4>
<p class="topless"><a href="example_comments1.html"
title="previous chapter">Example: Adding Cell Comments to Worksheets (Simple)</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="example_outline1.html"
title="next chapter">Example: Outline and Grouping</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/example_comments2.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="example_outline1.html" title="Example: Outline and Grouping"
>next</a> |</li>
<li class="right" >
<a href="example_comments1.html" title="Example: Adding Cell Comments to Worksheets (Simple)"
>previous</a> |</li>
<li><a href="index.html">XlsxWriter Documentation</a> »</li>
<li><a href="examples.html" >Examples</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2013, John McNamara.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>