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 



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

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 



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/rubyXL/convenience_methods.rb', line 769

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



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

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



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

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



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

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



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

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



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

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



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

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 



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

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



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

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 



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

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 



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

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 



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

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 



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

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

#font_color ⇒ Object 



842
843
844
845
 
# File 'lib/rubyXL/convenience_methods.rb', line 842

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

#font_name ⇒ Object 



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

def font_name()
  validate_worksheet
  get_cell_font.get_name
end

#font_size ⇒ Object 



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

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



959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'lib/rubyXL/convenience_methods.rb', line 959

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 



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

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

#horizontal_alignment ⇒ Object 



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

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 



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

def is_bolded()
  validate_worksheet
  get_cell_font.is_bold
end

#is_italicized ⇒ Object 



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

def is_italicized()
  validate_worksheet
  get_cell_font.is_italic
end

#is_struckthrough ⇒ Object 



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

def is_struckthrough()
  validate_worksheet
  get_cell_font.is_strikethrough
end

#is_underlined ⇒ Object 



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

def is_underlined()
  validate_worksheet
  get_cell_font.is_underlined
end

#set_number_format(format_code) ⇒ Object 



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

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 



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

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 



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

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