Module: RubyXL::CellConvenienceMethods

Defined in:
lib/rubyXL/convenience_methods/cell.rb

Instance Method Summary collapse

Instance Method Details

#change_border(direction, weight) ⇒ Object


57
58
59
60
# File 'lib/rubyXL/convenience_methods/cell.rb', line 57

def change_border(direction, weight)
  validate_worksheet
  self.style_index = workbook.modify_border(self.style_index, direction, weight)
end

#change_border_color(direction, color) ⇒ Object


62
63
64
65
66
# File 'lib/rubyXL/convenience_methods/cell.rb', line 62

def change_border_color(direction, color)
  validate_worksheet
  Color.validate_color(color)
  self.style_index = workbook.modify_border_color(self.style_index, direction, color)
end

#change_contents(data, formula_expression = nil) ⇒ Object


4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# File 'lib/rubyXL/convenience_methods/cell.rb', line 4

def change_contents(data, formula_expression = nil)
  validate_worksheet

  if formula_expression then
    self.datatype = nil
    self.formula = RubyXL::Formula.new(:expression => formula_expression)
  else
    self.datatype = case data
                    when Date, Numeric then nil
                    else RubyXL::DataType::RAW_STRING
                    end
  end

  data = workbook.date_to_num(data) if data.is_a?(Date)

  self.raw_value = data
end

#change_fill(rgb = 'ffffff') ⇒ Object

Changes fill color of cell


151
152
153
154
155
# File 'lib/rubyXL/convenience_methods/cell.rb', line 151

def change_fill(rgb = 'ffffff')
  validate_worksheet
  Color.validate_color(rgb)
  self.style_index = workbook.modify_fill(self.style_index, rgb)
end

#change_font_bold(bolded = false) ⇒ Object

Changes font bold settings of cell


196
197
198
199
200
201
202
# File 'lib/rubyXL/convenience_methods/cell.rb', line 196

def change_font_bold(bolded = false)
  validate_worksheet

  font = get_cell_font.dup
  font.set_bold(bolded)
  update_font_references(font)
end

#change_font_color(font_color = '000000') ⇒ Object

Changes font color of cell


177
178
179
180
181
182
183
184
# File 'lib/rubyXL/convenience_methods/cell.rb', line 177

def change_font_color(font_color = '000000')
  validate_worksheet
  Color.validate_color(font_color)

  font = get_cell_font.dup
  font.set_rgb_color(font_color)
  update_font_references(font)
end

#change_font_italics(italicized = false) ⇒ Object

Changes font italics settings of cell


187
188
189
190
191
192
193
# File 'lib/rubyXL/convenience_methods/cell.rb', line 187

def change_font_italics(italicized = false)
  validate_worksheet

  font = get_cell_font.dup
  font.set_italic(italicized)
  update_font_references(font)
end

#change_font_name(new_font_name = 'Verdana') ⇒ Object

Changes font name of cell


158
159
160
161
162
163
164
# File 'lib/rubyXL/convenience_methods/cell.rb', line 158

def change_font_name(new_font_name = 'Verdana')
  validate_worksheet

  font = get_cell_font.dup
  font.set_name(new_font_name)
  update_font_references(font)
end

#change_font_size(font_size = 10) ⇒ Object

Changes font size of cell


167
168
169
170
171
172
173
174
# File 'lib/rubyXL/convenience_methods/cell.rb', line 167

def change_font_size(font_size = 10)
  validate_worksheet
  raise 'Argument must be a number' unless font_size.is_a?(Integer) || font_size.is_a?(Float)

  font = get_cell_font.dup
  font.set_size(font_size)
  update_font_references(font)
end

#change_font_strikethrough(struckthrough = false) ⇒ Object


213
214
215
216
217
218
219
# File 'lib/rubyXL/convenience_methods/cell.rb', line 213

def change_font_strikethrough(struckthrough = false)
  validate_worksheet

  font = get_cell_font.dup
  font.set_strikethrough(struckthrough)
  update_font_references(font)
end

#change_font_underline(underlined = false) ⇒ Object

Changes font underline settings of cell


205
206
207
208
209
210
211
# File 'lib/rubyXL/convenience_methods/cell.rb', line 205

def change_font_underline(underlined = false)
  validate_worksheet

  font = get_cell_font.dup
  font.set_underline(underlined)
  update_font_references(font)
end

#change_horizontal_alignment(alignment = 'center') ⇒ Object


32
33
34
35
# File 'lib/rubyXL/convenience_methods/cell.rb', line 32

def change_horizontal_alignment(alignment = 'center')
  validate_worksheet
  self.style_index = workbook.modify_alignment(self.style_index) { |a| a.horizontal = alignment }
end

#change_text_indent(indent) ⇒ Object


52
53
54
55
# File 'lib/rubyXL/convenience_methods/cell.rb', line 52

def change_text_indent(indent)
  validate_worksheet
  self.style_index = workbook.modify_alignment(self.style_index) { |a| a.indent = indent }
end

#change_text_rotation(rot) ⇒ Object


47
48
49
50
# File 'lib/rubyXL/convenience_methods/cell.rb', line 47

def change_text_rotation(rot)
  validate_worksheet
  self.style_index = workbook.modify_alignment(self.style_index) { |a| a.text_rotation = rot }
end

#change_text_wrap(wrap = false) ⇒ Object


42
43
44
45
# File 'lib/rubyXL/convenience_methods/cell.rb', line 42

def change_text_wrap(wrap = false)
  validate_worksheet
  self.style_index = workbook.modify_alignment(self.style_index) { |a| a.wrap_text = wrap }
end

#change_vertical_alignment(alignment = 'center') ⇒ Object


37
38
39
40
# File 'lib/rubyXL/convenience_methods/cell.rb', line 37

def change_vertical_alignment(alignment = 'center')
  validate_worksheet
  self.style_index = workbook.modify_alignment(self.style_index) { |a| a.vertical = alignment }
end

#fill_colorObject


103
104
105
106
# File 'lib/rubyXL/convenience_methods/cell.rb', line 103

def fill_color()
  validate_worksheet
  return workbook.get_fill_color(get_cell_xf)
end

#font_colorObject


98
99
100
101
# File 'lib/rubyXL/convenience_methods/cell.rb', line 98

def font_color()
  validate_worksheet
  get_cell_font.get_rgb_color || '000000'
end

#font_nameObject


88
89
90
91
# File 'lib/rubyXL/convenience_methods/cell.rb', line 88

def font_name()
  validate_worksheet
  get_cell_font.get_name
end

#font_sizeObject


93
94
95
96
# File 'lib/rubyXL/convenience_methods/cell.rb', line 93

def font_size()
  validate_worksheet
  get_cell_font.get_size
end

#font_switch(change_type, arg) ⇒ Object

Performs correct modification based on what type of change_type is specified


229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/rubyXL/convenience_methods/cell.rb', line 229

def font_switch(change_type, arg)
  case change_type
  when Worksheet::NAME          then change_font_name(arg)
  when Worksheet::SIZE          then change_font_size(arg)
  when Worksheet::COLOR         then change_font_color(arg)
  when Worksheet::ITALICS       then change_font_italics(arg)
  when Worksheet::BOLD          then change_font_bold(arg)
  when Worksheet::UNDERLINE     then change_font_underline(arg)
  when Worksheet::STRIKETHROUGH then change_font_strikethrough(arg)
  else raise 'Invalid change_type'
  end
end

#get_border(direction) ⇒ Object


22
23
24
25
# File 'lib/rubyXL/convenience_methods/cell.rb', line 22

def get_border(direction)
  validate_worksheet
  get_cell_border.get_edge_style(direction)
end

#get_border_color(direction) ⇒ Object


27
28
29
30
# File 'lib/rubyXL/convenience_methods/cell.rb', line 27

def get_border_color(direction)
  validate_worksheet
  get_cell_border.get_edge_color(direction)
end

#horizontal_alignmentObject


108
109
110
111
112
113
# File 'lib/rubyXL/convenience_methods/cell.rb', line 108

def horizontal_alignment()
  validate_worksheet
  xf_obj = get_cell_xf
  return nil if xf_obj.alignment.nil?
  xf_obj.alignment.horizontal
end

#is_boldedObject


73
74
75
76
# File 'lib/rubyXL/convenience_methods/cell.rb', line 73

def is_bolded()
  validate_worksheet
  get_cell_font.is_bold
end

#is_italicizedObject


68
69
70
71
# File 'lib/rubyXL/convenience_methods/cell.rb', line 68

def is_italicized()
  validate_worksheet
  get_cell_font.is_italic
end

#is_struckthroughObject


83
84
85
86
# File 'lib/rubyXL/convenience_methods/cell.rb', line 83

def is_struckthrough()
  validate_worksheet
  get_cell_font.is_strikethrough
end

#is_underlinedObject


78
79
80
81
# File 'lib/rubyXL/convenience_methods/cell.rb', line 78

def is_underlined()
  validate_worksheet
  get_cell_font.is_underlined
end

#set_number_format(format_code) ⇒ Object


143
144
145
146
147
148
# File 'lib/rubyXL/convenience_methods/cell.rb', line 143

def set_number_format(format_code)
  new_xf = get_cell_xf.dup
  new_xf.num_fmt_id = workbook.stylesheet.register_number_format(format_code)
  new_xf.apply_number_format = true
  self.style_index = workbook.register_new_xf(new_xf)
end

#text_indentObject


136
137
138
139
140
141
# File 'lib/rubyXL/convenience_methods/cell.rb', line 136

def text_indent()
  validate_worksheet
  xf_obj = get_cell_xf
  return nil if xf_obj.alignment.nil?
  xf_obj.alignment.indent
end

#text_rotationObject


129
130
131
132
133
134
# File 'lib/rubyXL/convenience_methods/cell.rb', line 129

def text_rotation
  validate_worksheet
  xf_obj = get_cell_xf
  return nil if xf_obj.alignment.nil?
  xf_obj.alignment.text_rotation    
end

#text_wrapObject


122
123
124
125
126
127
# File 'lib/rubyXL/convenience_methods/cell.rb', line 122

def text_wrap()
  validate_worksheet
  xf_obj = get_cell_xf
  return nil if xf_obj.alignment.nil?
  xf_obj.alignment.wrap_text
end

#vertical_alignmentObject


115
116
117
118
119
120
# File 'lib/rubyXL/convenience_methods/cell.rb', line 115

def vertical_alignment()
  validate_worksheet
  xf_obj = get_cell_xf
  return nil if xf_obj.alignment.nil?
  xf_obj.alignment.vertical
end