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 



798
799
800
801
 
# File 'lib/rubyXL/convenience_methods.rb', line 798

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

#change_contents(data, formula_expression = nil) ⇒ Object 



760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/rubyXL/convenience_methods.rb', line 760

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



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

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



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

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



898
899
900
901
902
903
904
905
 
# File 'lib/rubyXL/convenience_methods.rb', line 898

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



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

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



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

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



888
889
890
891
892
893
894
895
 
# File 'lib/rubyXL/convenience_methods.rb', line 888

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 



934
935
936
937
938
939
940
 
# File 'lib/rubyXL/convenience_methods.rb', line 934

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



926
927
928
929
930
931
932
 
# File 'lib/rubyXL/convenience_methods.rb', line 926

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 



783
784
785
786
 
# File 'lib/rubyXL/convenience_methods.rb', line 783

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 



793
794
795
796
 
# File 'lib/rubyXL/convenience_methods.rb', line 793

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 



788
789
790
791
 
# File 'lib/rubyXL/convenience_methods.rb', line 788

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 



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

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

#font_color ⇒ Object 



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

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

#font_name ⇒ Object 



823
824
825
826
 
# File 'lib/rubyXL/convenience_methods.rb', line 823

def font_name()
  validate_worksheet
  get_cell_font.get_name
end

#font_size ⇒ Object 



828
829
830
831
 
# File 'lib/rubyXL/convenience_methods.rb', line 828

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



950
951
952
953
954
955
956
957
958
959
960
961
 
# File 'lib/rubyXL/convenience_methods.rb', line 950

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 



778
779
780
781
 
# File 'lib/rubyXL/convenience_methods.rb', line 778

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

#horizontal_alignment ⇒ Object 



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

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 



808
809
810
811
 
# File 'lib/rubyXL/convenience_methods.rb', line 808

def is_bolded()
  validate_worksheet
  get_cell_font.is_bold
end

#is_italicized ⇒ Object 



803
804
805
806
 
# File 'lib/rubyXL/convenience_methods.rb', line 803

def is_italicized()
  validate_worksheet
  get_cell_font.is_italic
end

#is_struckthrough ⇒ Object 



818
819
820
821
 
# File 'lib/rubyXL/convenience_methods.rb', line 818

def is_struckthrough()
  validate_worksheet
  get_cell_font.is_strikethrough
end

#is_underlined ⇒ Object 



813
814
815
816
 
# File 'lib/rubyXL/convenience_methods.rb', line 813

def is_underlined()
  validate_worksheet
  get_cell_font.is_underlined
end

#set_number_format(format_code) ⇒ Object 



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

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 



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

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 



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

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