Module: RubyXL::WorksheetConvenienceMethods

Included in:
Worksheet
Defined in:
lib/rubyXL/convenience_methods.rb

Instance Method Summary collapse

Instance Method Details

#change_column_alignment(column_index, &block) ⇒ Object 



582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/rubyXL/convenience_methods.rb', line 582

def change_column_alignment(column_index, &block)
  validate_workbook
  ensure_cell_exists(0, column_index)

  cols.get_range(column_index).style_index = @workbook.modify_alignment(get_col_style(column_index), &block)
  # Excel gets confused if width is not explicitly set for a column that had alignment changes
  change_column_width(column_index) if get_column_width_raw(column_index).nil?

  sheet_data.rows.each { |row|
    c = row[column_index]
    next if c.nil?
    c.style_index = @workbook.modify_alignment(c.style_index, &block)
  }
end

#change_column_bold(column_index, bolded = false) ⇒ Object 



503
504
505
506
507
508
 
# File 'lib/rubyXL/convenience_methods.rb', line 503

def change_column_bold(column_index, bolded = false)
  xf = get_col_xf(column_index)
  font = @workbook.fonts[xf.font_id].dup
  font.set_bold(bolded)
  change_column_font(column_index, Worksheet::BOLD, bolded, font, xf)
end

#change_column_border(column_index, direction, weight) ⇒ Object 



557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/rubyXL/convenience_methods.rb', line 557

def change_column_border(column_index, direction, weight)
  validate_workbook
  ensure_cell_exists(0, column_index)

  cols.get_range(column_index).style_index = @workbook.modify_border(get_col_style(column_index), direction, weight)

  sheet_data.rows.each { |row|
    c = row.cells[column_index]
    c.change_border(direction, weight) unless c.nil?
  }
end

#change_column_border_bottom(column_index, weight = 'thin') ⇒ Object 



547
548
549
550
 
# File 'lib/rubyXL/convenience_methods.rb', line 547

def change_column_border_bottom(column_index, weight = 'thin')
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_column_border` instead."
  change_column_border(column_index, :bottom, weight)
end

#change_column_border_diagonal(column_index, weight = 'thin') ⇒ Object 



552
553
554
555
 
# File 'lib/rubyXL/convenience_methods.rb', line 552

def change_column_border_diagonal(column_index, weight = 'thin')
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_column_border` instead."
  change_column_border(column_index, :diagonal, weight)
end

#change_column_border_left(column_index, weight = 'thin') ⇒ Object 



537
538
539
540
 
# File 'lib/rubyXL/convenience_methods.rb', line 537

def change_column_border_left(column_index, weight = 'thin')
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_column_border` instead."
  change_column_border(column_index, :left, weight)
end

#change_column_border_right(column_index, weight = 'thin') ⇒ Object 



542
543
544
545
 
# File 'lib/rubyXL/convenience_methods.rb', line 542

def change_column_border_right(column_index, weight = 'thin')
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_column_border` instead."
  change_column_border(column_index, :right, weight)
end

#change_column_border_top(column_index, weight = 'thin') ⇒ Object 



532
533
534
535
 
# File 'lib/rubyXL/convenience_methods.rb', line 532

def change_column_border_top(column_index, weight = 'thin')
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_column_border` instead."
  change_column_border(column_index, :top, weight)
end

#change_column_font_color(column_index, font_color = '000000') ⇒ Object 



487
488
489
490
491
492
493
494
 
# File 'lib/rubyXL/convenience_methods.rb', line 487

def change_column_font_color(column_index, font_color='000000')
  Color.validate_color(font_color)

  xf = get_col_xf(column_index)
  font = @workbook.fonts[xf.font_id].dup
  font.set_rgb_color(font_color)
  change_column_font(column_index, Worksheet::COLOR, font_color, font, xf)
end

#change_column_font_name(column_index = 0, font_name = 'Verdana') ⇒ Object 



473
474
475
476
477
478
 
# File 'lib/rubyXL/convenience_methods.rb', line 473

def change_column_font_name(column_index = 0, font_name = 'Verdana')
  xf = get_col_xf(column_index)
  font = @workbook.fonts[xf.font_id].dup
  font.set_name(font_name)
  change_column_font(column_index, Worksheet::NAME, font_name, font, xf)
end

#change_column_font_size(column_index, font_size = 10) ⇒ Object 



480
481
482
483
484
485
 
# File 'lib/rubyXL/convenience_methods.rb', line 480

def change_column_font_size(column_index, font_size=10)
  xf = get_col_xf(column_index)
  font = @workbook.fonts[xf.font_id].dup
  font.set_size(font_size)
  change_column_font(column_index, Worksheet::SIZE, font_size, font, xf)
end

#change_column_horizontal_alignment(column_index, alignment = 'center') ⇒ Object 



524
525
526
 
# File 'lib/rubyXL/convenience_methods.rb', line 524

def change_column_horizontal_alignment(column_index, alignment = 'center')
  change_column_alignment(column_index) { |a| a.horizontal = alignment }
end

#change_column_italics(column_index, italicized = false) ⇒ Object 



496
497
498
499
500
501
 
# File 'lib/rubyXL/convenience_methods.rb', line 496

def change_column_italics(column_index, italicized = false)
  xf = get_col_xf(column_index)
  font = @workbook.fonts[xf.font_id].dup
  font.set_italic(italicized)
  change_column_font(column_index, Worksheet::ITALICS, italicized, font, xf)
end

#change_column_strikethrough(column_index, struckthrough = false) ⇒ Object 



517
518
519
520
521
522
 
# File 'lib/rubyXL/convenience_methods.rb', line 517

def change_column_strikethrough(column_index, struckthrough=false)
  xf = get_col_xf(column_index)
  font = @workbook.fonts[xf.font_id].dup
  font.set_strikethrough(struckthrough)
  change_column_font(column_index, Worksheet::STRIKETHROUGH, struckthrough, font, xf)
end

#change_column_underline(column_index, underlined = false) ⇒ Object 



510
511
512
513
514
515
 
# File 'lib/rubyXL/convenience_methods.rb', line 510

def change_column_underline(column_index, underlined = false)
  xf = get_col_xf(column_index)
  font = @workbook.fonts[xf.font_id].dup
  font.set_underline(underlined)
  change_column_font(column_index, Worksheet::UNDERLINE, underlined, font, xf)
end

#change_column_vertical_alignment(column_index, alignment = 'center') ⇒ Object 



528
529
530
 
# File 'lib/rubyXL/convenience_methods.rb', line 528

def change_column_vertical_alignment(column_index, alignment = 'center')
  change_column_alignment(column_index) { |a| a.vertical = alignment }
end

#change_row_alignment(row, &block) ⇒ Object 



569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/rubyXL/convenience_methods.rb', line 569

def change_row_alignment(row, &block)
  validate_workbook
  validate_nonnegative(row)
  ensure_cell_exists(row)

  sheet_data.rows[row].style_index = @workbook.modify_alignment(get_row_style(row), &block)

  sheet_data[row].cells.each { |c|
    next if c.nil?
    c.style_index = @workbook.modify_alignment(c.style_index, &block)
  }
end

#change_row_bold(row = 0, bolded = false) ⇒ Object 



443
444
445
446
447
448
 
# File 'lib/rubyXL/convenience_methods.rb', line 443

def change_row_bold(row = 0, bolded = false)
  ensure_cell_exists(row)
  font = row_font(row).dup
  font.set_bold(bolded)
  change_row_font(row, Worksheet::BOLD, bolded, font)
end

#change_row_border(row, direction, weight) ⇒ Object 



394
395
396
397
398
399
400
401
402
403
 
# File 'lib/rubyXL/convenience_methods.rb', line 394

def change_row_border(row, direction, weight)
  validate_workbook
  ensure_cell_exists(row)

  sheet_data.rows[row].style_index = @workbook.modify_border(get_row_style(row), direction, weight)

  sheet_data[row].cells.each { |c|
    c.change_border(direction, weight) unless c.nil?
  }
end

#change_row_border_bottom(row = 0, weight = 'thin') ⇒ Object 



384
385
386
387
 
# File 'lib/rubyXL/convenience_methods.rb', line 384

def change_row_border_bottom(row = 0, weight = 'thin')
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_row_border` instead."
  change_row_border(row, :bottom, weight)
end

#change_row_border_diagonal(row = 0, weight = 'thin') ⇒ Object 



389
390
391
392
 
# File 'lib/rubyXL/convenience_methods.rb', line 389

def change_row_border_diagonal(row = 0, weight = 'thin')
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_row_border` instead."
  change_row_border(row, :diagonal, weight)
end

#change_row_border_left(row = 0, weight = 'thin') ⇒ Object 



374
375
376
377
 
# File 'lib/rubyXL/convenience_methods.rb', line 374

def change_row_border_left(row = 0, weight = 'thin')
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_row_border` instead."
  change_row_border(row, :left, weight)
end

#change_row_border_right(row = 0, weight = 'thin') ⇒ Object 



379
380
381
382
 
# File 'lib/rubyXL/convenience_methods.rb', line 379

def change_row_border_right(row = 0, weight = 'thin')
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_row_border` instead."
  change_row_border(row, :right, weight)
end

#change_row_border_top(row = 0, weight = 'thin') ⇒ Object 



369
370
371
372
 
# File 'lib/rubyXL/convenience_methods.rb', line 369

def change_row_border_top(row = 0, weight = 'thin')
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_row_border` instead."
  change_row_border(row, :top, weight)
end

#change_row_fill(row_index = 0, rgb = 'ffffff') ⇒ Object 



405
406
407
408
409
410
411
412
 
# File 'lib/rubyXL/convenience_methods.rb', line 405

def change_row_fill(row_index = 0, rgb = 'ffffff')
  validate_workbook
  ensure_cell_exists(row_index)
  Color.validate_color(rgb)

  sheet_data.rows[row_index].style_index = @workbook.modify_fill(get_row_style(row_index), rgb)
  sheet_data[row_index].cells.each { |c| c.change_fill(rgb) unless c.nil? }
end

#change_row_font_color(row = 0, font_color = '000000') ⇒ Object 



428
429
430
431
432
433
434
 
# File 'lib/rubyXL/convenience_methods.rb', line 428

def change_row_font_color(row = 0, font_color = '000000')
  ensure_cell_exists(row)
  Color.validate_color(font_color)
  font = row_font(row).dup
  font.set_rgb_color(font_color)
  change_row_font(row, Worksheet::COLOR, font_color, font)
end

#change_row_font_name(row = 0, font_name = 'Verdana') ⇒ Object 



414
415
416
417
418
419
 
# File 'lib/rubyXL/convenience_methods.rb', line 414

def change_row_font_name(row = 0, font_name = 'Verdana')
  ensure_cell_exists(row)
  font = row_font(row).dup
  font.set_name(font_name)
  change_row_font(row, Worksheet::NAME, font_name, font)
end

#change_row_font_size(row = 0, font_size = 10) ⇒ Object 



421
422
423
424
425
426
 
# File 'lib/rubyXL/convenience_methods.rb', line 421

def change_row_font_size(row = 0, font_size=10)
  ensure_cell_exists(row)
  font = row_font(row).dup
  font.set_size(font_size)
  change_row_font(row, Worksheet::SIZE, font_size, font)
end

#change_row_height(row = 0, height = 10) ⇒ Object 



464
465
466
467
468
469
470
471
 
# File 'lib/rubyXL/convenience_methods.rb', line 464

def change_row_height(row = 0, height = 10)
  validate_workbook
  ensure_cell_exists(row)

  c = sheet_data.rows[row]
  c.ht = height
  c.custom_height = true
end

#change_row_horizontal_alignment(row = 0, alignment = 'center') ⇒ Object 



357
358
359
360
361
 
# File 'lib/rubyXL/convenience_methods.rb', line 357

def change_row_horizontal_alignment(row = 0, alignment = 'center')
  validate_workbook
  validate_nonnegative(row)
  change_row_alignment(row) { |a| a.horizontal = alignment }
end

#change_row_italics(row = 0, italicized = false) ⇒ Object 



436
437
438
439
440
441
 
# File 'lib/rubyXL/convenience_methods.rb', line 436

def change_row_italics(row = 0, italicized = false)
  ensure_cell_exists(row)
  font = row_font(row).dup
  font.set_italic(italicized)
  change_row_font(row, Worksheet::ITALICS, italicized, font)
end

#change_row_strikethrough(row = 0, struckthrough = false) ⇒ Object 



457
458
459
460
461
462
 
# File 'lib/rubyXL/convenience_methods.rb', line 457

def change_row_strikethrough(row = 0, struckthrough=false)
  ensure_cell_exists(row)
  font = row_font(row).dup
  font.set_strikethrough(struckthrough)
  change_row_font(row, Worksheet::STRIKETHROUGH, struckthrough, font)
end

#change_row_underline(row = 0, underlined = false) ⇒ Object 



450
451
452
453
454
455
 
# File 'lib/rubyXL/convenience_methods.rb', line 450

def change_row_underline(row = 0, underlined=false)
  ensure_cell_exists(row)
  font = row_font(row).dup
  font.set_underline(underlined)
  change_row_font(row, Worksheet::UNDERLINE, underlined, font)
end

#change_row_vertical_alignment(row = 0, alignment = 'center') ⇒ Object 



363
364
365
366
367
 
# File 'lib/rubyXL/convenience_methods.rb', line 363

def change_row_vertical_alignment(row = 0, alignment = 'center')
  validate_workbook
  validate_nonnegative(row)
  change_row_alignment(row) { |a| a.vertical = alignment }
end

#get_column_border_bottom(col = 0) ⇒ Object 



347
348
349
350
 
# File 'lib/rubyXL/convenience_methods.rb', line 347

def get_column_border_bottom(col=0)
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_column_border` instead."
  get_column_border(col, :bottom)
end

#get_column_border_diagonal(col = 0) ⇒ Object 



352
353
354
355
 
# File 'lib/rubyXL/convenience_methods.rb', line 352

def get_column_border_diagonal(col=0)
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_column_border` instead."
  get_column_border(col, :diagonal)
end

#get_column_border_left(col = 0) ⇒ Object 



337
338
339
340
 
# File 'lib/rubyXL/convenience_methods.rb', line 337

def get_column_border_left(col=0)
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_column_border` instead."
  get_column_border(col, :left)
end

#get_column_border_right(col = 0) ⇒ Object 



342
343
344
345
 
# File 'lib/rubyXL/convenience_methods.rb', line 342

def get_column_border_right(col=0)
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_column_border` instead."
  get_column_border(col, :right)
end

#get_column_border_top(col = 0) ⇒ Object 



332
333
334
335
 
# File 'lib/rubyXL/convenience_methods.rb', line 332

def get_column_border_top(col=0)
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_column_border` instead."
  get_column_border(col, :top)
end

#get_column_fill(col = 0) ⇒ Object 



314
315
316
317
318
319
320
 
# File 'lib/rubyXL/convenience_methods.rb', line 314

def get_column_fill(col=0)
  validate_workbook
  validate_nonnegative(col)
  return nil unless column_exists(col)

  @workbook.get_fill_color(get_col_xf(col))
end

#get_column_font_color(col = 0) ⇒ Object 



272
273
274
275
 
# File 'lib/rubyXL/convenience_methods.rb', line 272

def get_column_font_color(col = 0)
  font = column_font(col)
  font && (font.get_rgb_color || '000000')
end

#get_column_font_name(col = 0) ⇒ Object 



262
263
264
265
 
# File 'lib/rubyXL/convenience_methods.rb', line 262

def get_column_font_name(col = 0)
  font = column_font(col)
  font && font.get_name
end

#get_column_font_size(col = 0) ⇒ Object 



267
268
269
270
 
# File 'lib/rubyXL/convenience_methods.rb', line 267

def get_column_font_size(col = 0)
  font = column_font(col)
  font && font.get_size
end

#get_column_horizontal_alignment(col = 0) ⇒ Object 



322
323
324
325
 
# File 'lib/rubyXL/convenience_methods.rb', line 322

def get_column_horizontal_alignment(col=0)
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_column_alignment` instead."
  get_column_alignment(col, :horizontal)
end

#get_column_vertical_alignment(col = 0) ⇒ Object 



327
328
329
330
 
# File 'lib/rubyXL/convenience_methods.rb', line 327

def get_column_vertical_alignment(col=0)
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_column_alignment` instead."
  get_column_alignment(col, :vertical)
end

#get_column_width(column_index = 0) ⇒ Object

Get column width measured in number of digits, as per msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.column%28v=office.14%29.aspx



308
309
310
311
312
 
# File 'lib/rubyXL/convenience_methods.rb', line 308

def get_column_width(column_index = 0)
  width = get_column_width_raw(column_index)
  return RubyXL::ColumnRange::DEFAULT_WIDTH if width.nil?
  (width - (5.0 / RubyXL::Font::MAX_DIGIT_WIDTH)).round
end

#get_column_width_raw(column_index = 0) ⇒ Object

Get raw column width value as stored in the file



298
299
300
301
302
303
304
 
# File 'lib/rubyXL/convenience_methods.rb', line 298

def get_column_width_raw(column_index = 0)
  validate_workbook
  validate_nonnegative(column_index)

  range = cols.locate_range(column_index)
  range && range.width
end

#get_row_border_bottom(row = 0) ⇒ Object 



252
253
254
255
 
# File 'lib/rubyXL/convenience_methods.rb', line 252

def get_row_border_bottom(row = 0)
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_row_border` instead."
  return get_row_border(row, :bottom)
end

#get_row_border_diagonal(row = 0) ⇒ Object 



257
258
259
260
 
# File 'lib/rubyXL/convenience_methods.rb', line 257

def get_row_border_diagonal(row = 0)
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_row_border` instead."
  return get_row_border(row, :diagonal)
end

#get_row_border_left(row = 0) ⇒ Object 



242
243
244
245
 
# File 'lib/rubyXL/convenience_methods.rb', line 242

def get_row_border_left(row = 0)
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_row_border` instead."
  return get_row_border(row, :left)
end

#get_row_border_right(row = 0) ⇒ Object 



247
248
249
250
 
# File 'lib/rubyXL/convenience_methods.rb', line 247

def get_row_border_right(row = 0)
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_row_border` instead."
  return get_row_border(row, :right)
end

#get_row_border_top(row = 0) ⇒ Object 



237
238
239
240
 
# File 'lib/rubyXL/convenience_methods.rb', line 237

def get_row_border_top(row = 0)
  warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_row_border` instead."
  return get_row_border(row, :top)
end

#get_row_fill(row = 0) ⇒ Object 



187
188
189
 
# File 'lib/rubyXL/convenience_methods.rb', line 187

def get_row_fill(row = 0)
  (row = sheet_data.rows[row]) && row.get_fill_color
end

#get_row_font_color(row = 0) ⇒ Object 



199
200
201
202
203
 
# File 'lib/rubyXL/convenience_methods.rb', line 199

def get_row_font_color(row = 0)
  font = row_font(row)
  color = font && font.color
  color && (color.rgb || '000000')
end

#get_row_font_name(row = 0) ⇒ Object 



191
192
193
 
# File 'lib/rubyXL/convenience_methods.rb', line 191

def get_row_font_name(row = 0)
  (font = row_font(row)) && font.get_name
end

#get_row_font_size(row = 0) ⇒ Object 



195
196
197
 
# File 'lib/rubyXL/convenience_methods.rb', line 195

def get_row_font_size(row = 0)
  (font = row_font(row)) && font.get_size
end

#get_row_height(row = 0) ⇒ Object 



221
222
223
224
225
226
227
 
# File 'lib/rubyXL/convenience_methods.rb', line 221

def get_row_height(row = 0)
  validate_workbook
  validate_nonnegative(row)
  return nil unless row_exists(row)
  row = sheet_data.rows[row]
  row && row.ht || 13
end

#get_row_horizontal_alignment(row = 0) ⇒ Object 



229
230
231
 
# File 'lib/rubyXL/convenience_methods.rb', line 229

def get_row_horizontal_alignment(row = 0)
  return get_row_alignment(row, true)
end

#get_row_vertical_alignment(row = 0) ⇒ Object 



233
234
235
 
# File 'lib/rubyXL/convenience_methods.rb', line 233

def get_row_vertical_alignment(row = 0)
  return get_row_alignment(row, false)
end

#is_column_bolded(col = 0) ⇒ Object 



282
283
284
285
 
# File 'lib/rubyXL/convenience_methods.rb', line 282

def is_column_bolded(col = 0)
  font = column_font(col)
  font && font.is_bold
end

#is_column_italicized(col = 0) ⇒ Object 



277
278
279
280
 
# File 'lib/rubyXL/convenience_methods.rb', line 277

def is_column_italicized(col = 0)
  font = column_font(col)
  font && font.is_italic
end

#is_column_struckthrough(col = 0) ⇒ Object 



292
293
294
295
 
# File 'lib/rubyXL/convenience_methods.rb', line 292

def is_column_struckthrough(col = 0)
  font = column_font(col)
  font && font.is_strikethrough
end

#is_column_underlined(col = 0) ⇒ Object 



287
288
289
290
 
# File 'lib/rubyXL/convenience_methods.rb', line 287

def is_column_underlined(col = 0)
  font = column_font(col)
  font && font.is_underlined
end

#is_row_bolded(row = 0) ⇒ Object 



209
210
211
 
# File 'lib/rubyXL/convenience_methods.rb', line 209

def is_row_bolded(row = 0)
  (font = row_font(row)) && font.is_bold
end

#is_row_italicized(row = 0) ⇒ Object 



205
206
207
 
# File 'lib/rubyXL/convenience_methods.rb', line 205

def is_row_italicized(row = 0)
  (font = row_font(row)) && font.is_italic
end

#is_row_struckthrough(row = 0) ⇒ Object 



217
218
219
 
# File 'lib/rubyXL/convenience_methods.rb', line 217

def is_row_struckthrough(row = 0)
  (font = row_font(row)) && font.is_strikethrough
end

#is_row_underlined(row = 0) ⇒ Object 



213
214
215
 
# File 'lib/rubyXL/convenience_methods.rb', line 213

def is_row_underlined(row = 0)
  (font = row_font(row)) && font.is_underlined
end