Class: Writexlsx::Worksheet::InternalHyperlink

Inherits:
Hyperlink
  • Object
show all
Defined in:
lib/write_xlsx/worksheet/hyperlink.rb

Constant Summary

Constants inherited from Hyperlink

Hyperlink::MAXIMUM_URLS_SIZE

Constants included from Utility

Utility::CHAR_WIDTHS, Utility::COL_MAX, Utility::PERL_TRUE_VALUES, Utility::ROW_MAX, Utility::SHEETNAME_MAX, Utility::STR_MAX

Instance Attribute Summary

Attributes inherited from Hyperlink

#str, #tip

Instance Method Summary collapse

Methods inherited from Hyperlink

#display_on, #external_hyper_link, factory

Methods included from Utility

#absolute_char, #check_dimensions, #check_dimensions_and_update_max_min_values, #check_parameter, #color, #convert_date_time, #convert_font_args, #dash_types, delete_files, #escape_url, #fill_properties, #float_to_str, #get_font_latin_attributes, #get_font_style_attributes, #get_image_properties, #layout_properties, #legend_properties, #line_fill_properties, #line_properties, #palette_color, #params_to_font, #pattern_properties, #pixels_to_points, #process_bmp, #process_gif, #process_jpg, #process_png, #process_workbook_options, #ptrue?, #put_deprecate_message, #quote_sheetname, #r_id_attributes, #row_col_notation, #shape_style_base, #store_col_max_min_values, #store_row_max_min_values, #substitute_cellref, #underline_attributes, #v_shape_attributes_base, #v_shape_style_base, #value_or_raise, #write_a_body_pr, #write_a_def_rpr, #write_a_end_para_rpr, #write_a_lst_style, #write_a_p_formula, #write_a_p_pr_formula, #write_a_solid_fill, #write_a_srgb_clr, #write_anchor, #write_auto_fill, #write_color, #write_comment_path, #write_def_rpr_r_pr_common, #write_div, #write_fill, #write_font, #write_stroke, #write_tx_pr, #write_xml_declaration, #xl_cell_to_rowcol, #xl_col_to_name, #xl_range, #xl_range_formula, #xl_rowcol_to_cell, #xl_string_pixel_width, #xml_str

Constructor Details

#initialize(url, str, tip, max_url_length) ⇒ InternalHyperlink

Returns a new instance of InternalHyperlink.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/write_xlsx/worksheet/hyperlink.rb', line 69

def initialize(url, str, tip, max_url_length)
  @url = url
  # The displayed string defaults to the url string.
  str ||= @url.dup

  # Strip the mailto header.
  @str = str.sub(/^mailto:/, '')

  # Copy string for use in hyperlink elements.
  @url_str = @str.dup

  # Excel limits escaped URL to #{max_url_length} characters.
  raise "URL '#{@url}' > #{max_url_length} characters, it exceeds Excel's limit for URLS." if @url.bytesize > max_url_length

  @tip = tip
end

Instance Method Details

#attributes(row, col, _dummy = nil) ⇒ Object 



86
87
88
89
90
91
92
93
94
 
# File 'lib/write_xlsx/worksheet/hyperlink.rb', line 86

def attributes(row, col, _dummy = nil)
  attr = [
    ['ref', xl_rowcol_to_cell(row, col)],
    ['location', @url]
  ]

  attr << ['tooltip', @tip] if @tip
  attr << ['display', @str]
end