Module: RubyXL::CellConvenienceMethods

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

Instance Method Summary collapse

Instance Method Details

#change_border(direction, weight) ⇒ Object 



859
860
861
862
 
# File 'lib/rubyXL/convenience_methods.rb', line 859

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 



864
865
866
867
868
 
# File 'lib/rubyXL/convenience_methods.rb', line 864

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 



816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
 
# File 'lib/rubyXL/convenience_methods.rb', line 816

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



939
940
941
942
943
 
# File 'lib/rubyXL/convenience_methods.rb', line 939

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



984
985
986
987
988
989
990
 
# File 'lib/rubyXL/convenience_methods.rb', line 984

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



965
966
967
968
969
970
971
972
 
# File 'lib/rubyXL/convenience_methods.rb', line 965

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



975
976
977
978
979
980
981
 
# File 'lib/rubyXL/convenience_methods.rb', line 975

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



946
947
948
949
950
951
952
 
# File 'lib/rubyXL/convenience_methods.rb', line 946

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



955
956
957
958
959
960
961
962
 
# File 'lib/rubyXL/convenience_methods.rb', line 955

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 



1001
1002
1003
1004
1005
1006
1007
 
# File 'lib/rubyXL/convenience_methods.rb', line 1001

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



993
994
995
996
997
998
999
 
# File 'lib/rubyXL/convenience_methods.rb', line 993

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 



844
845
846
847
 
# File 'lib/rubyXL/convenience_methods.rb', line 844

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

#change_text_wrap(wrap = false) ⇒ Object 



854
855
856
857
 
# File 'lib/rubyXL/convenience_methods.rb', line 854

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 



849
850
851
852
 
# File 'lib/rubyXL/convenience_methods.rb', line 849

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

#fill_color ⇒ Object 



905
906
907
908
 
# File 'lib/rubyXL/convenience_methods.rb', line 905

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

#font_color ⇒ Object 



900
901
902
903
 
# File 'lib/rubyXL/convenience_methods.rb', line 900

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

#font_name ⇒ Object 



890
891
892
893
 
# File 'lib/rubyXL/convenience_methods.rb', line 890

def font_name()
  validate_worksheet
  get_cell_font.get_name
end

#font_size ⇒ Object 



895
896
897
898
 
# File 'lib/rubyXL/convenience_methods.rb', line 895

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



1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/rubyXL/convenience_methods.rb', line 1017

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 



834
835
836
837
 
# File 'lib/rubyXL/convenience_methods.rb', line 834

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

#get_border_color(direction) ⇒ Object 



839
840
841
842
 
# File 'lib/rubyXL/convenience_methods.rb', line 839

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

#horizontal_alignment ⇒ Object 



910
911
912
913
914
915
 
# File 'lib/rubyXL/convenience_methods.rb', line 910

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

#is_bolded ⇒ Object 



875
876
877
878
 
# File 'lib/rubyXL/convenience_methods.rb', line 875

def is_bolded()
  validate_worksheet
  get_cell_font.is_bold
end

#is_italicized ⇒ Object 



870
871
872
873
 
# File 'lib/rubyXL/convenience_methods.rb', line 870

def is_italicized()
  validate_worksheet
  get_cell_font.is_italic
end

#is_struckthrough ⇒ Object 



885
886
887
888
 
# File 'lib/rubyXL/convenience_methods.rb', line 885

def is_struckthrough()
  validate_worksheet
  get_cell_font.is_strikethrough
end

#is_underlined ⇒ Object 



880
881
882
883
 
# File 'lib/rubyXL/convenience_methods.rb', line 880

def is_underlined()
  validate_worksheet
  get_cell_font.is_underlined
end

#set_number_format(format_code) ⇒ Object 



931
932
933
934
935
936
 
# File 'lib/rubyXL/convenience_methods.rb', line 931

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_wrap ⇒ Object 



924
925
926
927
928
929
 
# File 'lib/rubyXL/convenience_methods.rb', line 924

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

#vertical_alignment ⇒ Object 



917
918
919
920
921
922
 
# File 'lib/rubyXL/convenience_methods.rb', line 917

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