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 



872
873
874
875
 
# File 'lib/rubyXL/convenience_methods.rb', line 872

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 



877
878
879
880
881
 
# File 'lib/rubyXL/convenience_methods.rb', line 877

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 



829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'lib/rubyXL/convenience_methods.rb', line 829

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



952
953
954
955
956
 
# File 'lib/rubyXL/convenience_methods.rb', line 952

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



997
998
999
1000
1001
1002
1003
 
# File 'lib/rubyXL/convenience_methods.rb', line 997

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



978
979
980
981
982
983
984
985
 
# File 'lib/rubyXL/convenience_methods.rb', line 978

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



988
989
990
991
992
993
994
 
# File 'lib/rubyXL/convenience_methods.rb', line 988

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



959
960
961
962
963
964
965
 
# File 'lib/rubyXL/convenience_methods.rb', line 959

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



968
969
970
971
972
973
974
975
 
# File 'lib/rubyXL/convenience_methods.rb', line 968

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 



1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/rubyXL/convenience_methods.rb', line 1014

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



1006
1007
1008
1009
1010
1011
1012
 
# File 'lib/rubyXL/convenience_methods.rb', line 1006

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 



857
858
859
860
 
# File 'lib/rubyXL/convenience_methods.rb', line 857

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 



867
868
869
870
 
# File 'lib/rubyXL/convenience_methods.rb', line 867

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 



862
863
864
865
 
# File 'lib/rubyXL/convenience_methods.rb', line 862

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 



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

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

#font_color ⇒ Object 



913
914
915
916
 
# File 'lib/rubyXL/convenience_methods.rb', line 913

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

#font_name ⇒ Object 



903
904
905
906
 
# File 'lib/rubyXL/convenience_methods.rb', line 903

def font_name()
  validate_worksheet
  get_cell_font.get_name
end

#font_size ⇒ Object 



908
909
910
911
 
# File 'lib/rubyXL/convenience_methods.rb', line 908

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



1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
 
# File 'lib/rubyXL/convenience_methods.rb', line 1030

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 



847
848
849
850
 
# File 'lib/rubyXL/convenience_methods.rb', line 847

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

#get_border_color(direction) ⇒ Object 



852
853
854
855
 
# File 'lib/rubyXL/convenience_methods.rb', line 852

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

#horizontal_alignment ⇒ Object 



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

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 



888
889
890
891
 
# File 'lib/rubyXL/convenience_methods.rb', line 888

def is_bolded()
  validate_worksheet
  get_cell_font.is_bold
end

#is_italicized ⇒ Object 



883
884
885
886
 
# File 'lib/rubyXL/convenience_methods.rb', line 883

def is_italicized()
  validate_worksheet
  get_cell_font.is_italic
end

#is_struckthrough ⇒ Object 



898
899
900
901
 
# File 'lib/rubyXL/convenience_methods.rb', line 898

def is_struckthrough()
  validate_worksheet
  get_cell_font.is_strikethrough
end

#is_underlined ⇒ Object 



893
894
895
896
 
# File 'lib/rubyXL/convenience_methods.rb', line 893

def is_underlined()
  validate_worksheet
  get_cell_font.is_underlined
end

#set_number_format(format_code) ⇒ Object 



944
945
946
947
948
949
 
# File 'lib/rubyXL/convenience_methods.rb', line 944

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 



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

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 



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

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