rdoc/RubyXL/WorksheetConvenienceMethods.html in rubyXL-3.3.1 vs rdoc/RubyXL/WorksheetConvenienceMethods.html in rubyXL-3.3.2

- old
+ new

@@ -2,27 +2,24 @@ <html> <head> <meta charset="UTF-8"> -<title>module RubyXL::WorksheetConvenienceMethods - rubyXL 3.3.1</title> +<title>module RubyXL::WorksheetConvenienceMethods - rubyXL 3.3.2</title> -<link href="../fonts.css" rel="stylesheet"> -<link href="../rdoc.css" rel="stylesheet"> - <script type="text/javascript"> var rdoc_rel_prefix = "../"; </script> <script src="../js/jquery.js"></script> -<script src="../js/navigation.js"></script> -<script src="../js/search_index.js"></script> -<script src="../js/search.js"></script> -<script src="../js/searcher.js"></script> <script src="../js/darkfish.js"></script> +<link href="../css/fonts.css" rel="stylesheet"> +<link href="../css/rdoc.css" rel="stylesheet"> + + <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> <div id="home-section" role="region" title="Quick navigation" class="nav-section"> <h2> @@ -58,11 +55,159 @@ <div id="class-metadata"> + <!-- Method Quickref --> +<div id="method-list-section" class="nav-section"> + <h3>Methods</h3> + + <ul class="link-list" role="directory"> + <li ><a href="#method-i-change_column_alignment">#change_column_alignment</a> + + <li ><a href="#method-i-change_column_bold">#change_column_bold</a> + + <li ><a href="#method-i-change_column_border">#change_column_border</a> + + <li ><a href="#method-i-change_column_border_bottom">#change_column_border_bottom</a> + + <li ><a href="#method-i-change_column_border_diagonal">#change_column_border_diagonal</a> + + <li ><a href="#method-i-change_column_border_left">#change_column_border_left</a> + + <li ><a href="#method-i-change_column_border_right">#change_column_border_right</a> + + <li ><a href="#method-i-change_column_border_top">#change_column_border_top</a> + + <li ><a href="#method-i-change_column_font_color">#change_column_font_color</a> + + <li ><a href="#method-i-change_column_font_name">#change_column_font_name</a> + + <li ><a href="#method-i-change_column_font_size">#change_column_font_size</a> + + <li ><a href="#method-i-change_column_horizontal_alignment">#change_column_horizontal_alignment</a> + + <li ><a href="#method-i-change_column_italics">#change_column_italics</a> + + <li ><a href="#method-i-change_column_strikethrough">#change_column_strikethrough</a> + + <li ><a href="#method-i-change_column_underline">#change_column_underline</a> + + <li ><a href="#method-i-change_column_vertical_alignment">#change_column_vertical_alignment</a> + + <li ><a href="#method-i-change_row_alignment">#change_row_alignment</a> + + <li ><a href="#method-i-change_row_bold">#change_row_bold</a> + + <li ><a href="#method-i-change_row_border">#change_row_border</a> + + <li ><a href="#method-i-change_row_border_bottom">#change_row_border_bottom</a> + + <li ><a href="#method-i-change_row_border_diagonal">#change_row_border_diagonal</a> + + <li ><a href="#method-i-change_row_border_left">#change_row_border_left</a> + + <li ><a href="#method-i-change_row_border_right">#change_row_border_right</a> + + <li ><a href="#method-i-change_row_border_top">#change_row_border_top</a> + + <li ><a href="#method-i-change_row_fill">#change_row_fill</a> + + <li ><a href="#method-i-change_row_font_color">#change_row_font_color</a> + + <li ><a href="#method-i-change_row_font_name">#change_row_font_name</a> + + <li ><a href="#method-i-change_row_font_size">#change_row_font_size</a> + + <li ><a href="#method-i-change_row_height">#change_row_height</a> + + <li ><a href="#method-i-change_row_horizontal_alignment">#change_row_horizontal_alignment</a> + + <li ><a href="#method-i-change_row_italics">#change_row_italics</a> + + <li ><a href="#method-i-change_row_strikethrough">#change_row_strikethrough</a> + + <li ><a href="#method-i-change_row_underline">#change_row_underline</a> + + <li ><a href="#method-i-change_row_vertical_alignment">#change_row_vertical_alignment</a> + + <li ><a href="#method-i-get_column_alignment">#get_column_alignment</a> + + <li ><a href="#method-i-get_column_border">#get_column_border</a> + + <li ><a href="#method-i-get_column_border_bottom">#get_column_border_bottom</a> + + <li ><a href="#method-i-get_column_border_diagonal">#get_column_border_diagonal</a> + + <li ><a href="#method-i-get_column_border_left">#get_column_border_left</a> + + <li ><a href="#method-i-get_column_border_right">#get_column_border_right</a> + + <li ><a href="#method-i-get_column_border_top">#get_column_border_top</a> + + <li ><a href="#method-i-get_column_fill">#get_column_fill</a> + + <li ><a href="#method-i-get_column_font_color">#get_column_font_color</a> + + <li ><a href="#method-i-get_column_font_name">#get_column_font_name</a> + + <li ><a href="#method-i-get_column_font_size">#get_column_font_size</a> + + <li ><a href="#method-i-get_column_horizontal_alignment">#get_column_horizontal_alignment</a> + + <li ><a href="#method-i-get_column_vertical_alignment">#get_column_vertical_alignment</a> + + <li ><a href="#method-i-get_column_width">#get_column_width</a> + + <li ><a href="#method-i-get_column_width_raw">#get_column_width_raw</a> + + <li ><a href="#method-i-get_row_border">#get_row_border</a> + + <li ><a href="#method-i-get_row_border_bottom">#get_row_border_bottom</a> + + <li ><a href="#method-i-get_row_border_diagonal">#get_row_border_diagonal</a> + + <li ><a href="#method-i-get_row_border_left">#get_row_border_left</a> + + <li ><a href="#method-i-get_row_border_right">#get_row_border_right</a> + + <li ><a href="#method-i-get_row_border_top">#get_row_border_top</a> + + <li ><a href="#method-i-get_row_fill">#get_row_fill</a> + + <li ><a href="#method-i-get_row_font_color">#get_row_font_color</a> + + <li ><a href="#method-i-get_row_font_name">#get_row_font_name</a> + + <li ><a href="#method-i-get_row_font_size">#get_row_font_size</a> + + <li ><a href="#method-i-get_row_height">#get_row_height</a> + + <li ><a href="#method-i-get_row_horizontal_alignment">#get_row_horizontal_alignment</a> + + <li ><a href="#method-i-get_row_vertical_alignment">#get_row_vertical_alignment</a> + + <li ><a href="#method-i-is_column_bolded">#is_column_bolded</a> + + <li ><a href="#method-i-is_column_italicized">#is_column_italicized</a> + + <li ><a href="#method-i-is_column_struckthrough">#is_column_struckthrough</a> + + <li ><a href="#method-i-is_column_underlined">#is_column_underlined</a> + + <li ><a href="#method-i-is_row_bolded">#is_row_bolded</a> + + <li ><a href="#method-i-is_row_italicized">#is_row_italicized</a> + + <li ><a href="#method-i-is_row_struckthrough">#is_row_struckthrough</a> + + <li ><a href="#method-i-is_row_underlined">#is_row_underlined</a> + + </ul> +</div> + </div> </nav> <main role="main" aria-labelledby="module-RubyXL::WorksheetConvenienceMethods"> <h1 id="module-RubyXL::WorksheetConvenienceMethods" class="module"> @@ -84,15 +229,2484 @@ + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Public Instance Methods</h3> + </header> + + + <div id="method-i-change_column_alignment" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_alignment</span><span + class="method-args">(column_index, &block)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_alignment-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 605</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_alignment</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) + <span class="ruby-identifier">validate_workbook</span> + <span class="ruby-identifier">ensure_cell_exists</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">column_index</span>) + + <span class="ruby-identifier">cols</span>.<span class="ruby-identifier">get_range</span>(<span class="ruby-identifier">column_index</span>).<span class="ruby-identifier">style_index</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">modify_alignment</span>(<span class="ruby-identifier">get_col_style</span>(<span class="ruby-identifier">column_index</span>), <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) + <span class="ruby-comment"># Excel gets confused if width is not explicitly set for a column that had alignment changes</span> + <span class="ruby-identifier">change_column_width</span>(<span class="ruby-identifier">column_index</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">get_column_width_raw</span>(<span class="ruby-identifier">column_index</span>).<span class="ruby-identifier">nil?</span> + + <span class="ruby-identifier">sheet_data</span>.<span class="ruby-identifier">rows</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">row</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">c</span> = <span class="ruby-identifier">row</span>[<span class="ruby-identifier">column_index</span>] + <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">nil?</span> + <span class="ruby-identifier">c</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">modify_alignment</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">style_index</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) + } +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_column_bold" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_bold</span><span + class="method-args">(column_index, bolded = false)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_bold-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 526</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_bold</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-identifier">bolded</span> = <span class="ruby-keyword">false</span>) + <span class="ruby-identifier">xf</span> = <span class="ruby-identifier">get_col_xf</span>(<span class="ruby-identifier">column_index</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">fonts</span>[<span class="ruby-identifier">xf</span>.<span class="ruby-identifier">font_id</span>].<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_bold</span>(<span class="ruby-identifier">bolded</span>) + <span class="ruby-identifier">change_column_font</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">BOLD</span>, <span class="ruby-identifier">bolded</span>, <span class="ruby-identifier">font</span>, <span class="ruby-identifier">xf</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_column_border" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_border</span><span + class="method-args">(column_index, direction, weight)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_border-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 580</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_border</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-identifier">direction</span>, <span class="ruby-identifier">weight</span>) + <span class="ruby-identifier">validate_workbook</span> + <span class="ruby-identifier">ensure_cell_exists</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">column_index</span>) + + <span class="ruby-identifier">cols</span>.<span class="ruby-identifier">get_range</span>(<span class="ruby-identifier">column_index</span>).<span class="ruby-identifier">style_index</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">modify_border</span>(<span class="ruby-identifier">get_col_style</span>(<span class="ruby-identifier">column_index</span>), <span class="ruby-identifier">direction</span>, <span class="ruby-identifier">weight</span>) + + <span class="ruby-identifier">sheet_data</span>.<span class="ruby-identifier">rows</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">row</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">c</span> = <span class="ruby-identifier">row</span>.<span class="ruby-identifier">cells</span>[<span class="ruby-identifier">column_index</span>] + <span class="ruby-identifier">c</span>.<span class="ruby-identifier">change_border</span>(<span class="ruby-identifier">direction</span>, <span class="ruby-identifier">weight</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">nil?</span> + } +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_column_border_bottom" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_border_bottom</span><span + class="method-args">(column_index, weight = 'thin')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_border_bottom-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 570</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_border_bottom</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-identifier">weight</span> = <span class="ruby-string">&#39;thin&#39;</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `change_column_border` instead.&quot;</span> + <span class="ruby-identifier">change_column_border</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-value">:bottom</span>, <span class="ruby-identifier">weight</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_column_border_diagonal" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_border_diagonal</span><span + class="method-args">(column_index, weight = 'thin')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_border_diagonal-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 575</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_border_diagonal</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-identifier">weight</span> = <span class="ruby-string">&#39;thin&#39;</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `change_column_border` instead.&quot;</span> + <span class="ruby-identifier">change_column_border</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-value">:diagonal</span>, <span class="ruby-identifier">weight</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_column_border_left" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_border_left</span><span + class="method-args">(column_index, weight = 'thin')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_border_left-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 560</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_border_left</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-identifier">weight</span> = <span class="ruby-string">&#39;thin&#39;</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `change_column_border` instead.&quot;</span> + <span class="ruby-identifier">change_column_border</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-value">:left</span>, <span class="ruby-identifier">weight</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_column_border_right" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_border_right</span><span + class="method-args">(column_index, weight = 'thin')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_border_right-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 565</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_border_right</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-identifier">weight</span> = <span class="ruby-string">&#39;thin&#39;</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `change_column_border` instead.&quot;</span> + <span class="ruby-identifier">change_column_border</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-value">:right</span>, <span class="ruby-identifier">weight</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_column_border_top" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_border_top</span><span + class="method-args">(column_index, weight = 'thin')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_border_top-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 555</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_border_top</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-identifier">weight</span> = <span class="ruby-string">&#39;thin&#39;</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `change_column_border` instead.&quot;</span> + <span class="ruby-identifier">change_column_border</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-value">:top</span>, <span class="ruby-identifier">weight</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_column_font_color" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_font_color</span><span + class="method-args">(column_index, font_color='000000')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_font_color-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 510</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_font_color</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-identifier">font_color</span>=<span class="ruby-string">&#39;000000&#39;</span>) + <span class="ruby-constant">Color</span>.<span class="ruby-identifier">validate_color</span>(<span class="ruby-identifier">font_color</span>) + + <span class="ruby-identifier">xf</span> = <span class="ruby-identifier">get_col_xf</span>(<span class="ruby-identifier">column_index</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">fonts</span>[<span class="ruby-identifier">xf</span>.<span class="ruby-identifier">font_id</span>].<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_rgb_color</span>(<span class="ruby-identifier">font_color</span>) + <span class="ruby-identifier">change_column_font</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">COLOR</span>, <span class="ruby-identifier">font_color</span>, <span class="ruby-identifier">font</span>, <span class="ruby-identifier">xf</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_column_font_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_font_name</span><span + class="method-args">(column_index = 0, font_name = 'Verdana')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_font_name-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 496</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_font_name</span>(<span class="ruby-identifier">column_index</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">font_name</span> = <span class="ruby-string">&#39;Verdana&#39;</span>) + <span class="ruby-identifier">xf</span> = <span class="ruby-identifier">get_col_xf</span>(<span class="ruby-identifier">column_index</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">fonts</span>[<span class="ruby-identifier">xf</span>.<span class="ruby-identifier">font_id</span>].<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_name</span>(<span class="ruby-identifier">font_name</span>) + <span class="ruby-identifier">change_column_font</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">NAME</span>, <span class="ruby-identifier">font_name</span>, <span class="ruby-identifier">font</span>, <span class="ruby-identifier">xf</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_column_font_size" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_font_size</span><span + class="method-args">(column_index, font_size=10)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_font_size-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 503</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_font_size</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-identifier">font_size</span>=<span class="ruby-value">10</span>) + <span class="ruby-identifier">xf</span> = <span class="ruby-identifier">get_col_xf</span>(<span class="ruby-identifier">column_index</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">fonts</span>[<span class="ruby-identifier">xf</span>.<span class="ruby-identifier">font_id</span>].<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_size</span>(<span class="ruby-identifier">font_size</span>) + <span class="ruby-identifier">change_column_font</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">SIZE</span>, <span class="ruby-identifier">font_size</span>, <span class="ruby-identifier">font</span>, <span class="ruby-identifier">xf</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_column_horizontal_alignment" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_horizontal_alignment</span><span + class="method-args">(column_index, alignment = 'center')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_horizontal_alignment-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 547</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_horizontal_alignment</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-identifier">alignment</span> = <span class="ruby-string">&#39;center&#39;</span>) + <span class="ruby-identifier">change_column_alignment</span>(<span class="ruby-identifier">column_index</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">horizontal</span> = <span class="ruby-identifier">alignment</span> } +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_column_italics" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_italics</span><span + class="method-args">(column_index, italicized = false)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_italics-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 519</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_italics</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-identifier">italicized</span> = <span class="ruby-keyword">false</span>) + <span class="ruby-identifier">xf</span> = <span class="ruby-identifier">get_col_xf</span>(<span class="ruby-identifier">column_index</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">fonts</span>[<span class="ruby-identifier">xf</span>.<span class="ruby-identifier">font_id</span>].<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_italic</span>(<span class="ruby-identifier">italicized</span>) + <span class="ruby-identifier">change_column_font</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">ITALICS</span>, <span class="ruby-identifier">italicized</span>, <span class="ruby-identifier">font</span>, <span class="ruby-identifier">xf</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_column_strikethrough" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_strikethrough</span><span + class="method-args">(column_index, struckthrough=false)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_strikethrough-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 540</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_strikethrough</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-identifier">struckthrough</span>=<span class="ruby-keyword">false</span>) + <span class="ruby-identifier">xf</span> = <span class="ruby-identifier">get_col_xf</span>(<span class="ruby-identifier">column_index</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">fonts</span>[<span class="ruby-identifier">xf</span>.<span class="ruby-identifier">font_id</span>].<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_strikethrough</span>(<span class="ruby-identifier">struckthrough</span>) + <span class="ruby-identifier">change_column_font</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">STRIKETHROUGH</span>, <span class="ruby-identifier">struckthrough</span>, <span class="ruby-identifier">font</span>, <span class="ruby-identifier">xf</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_column_underline" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_underline</span><span + class="method-args">(column_index, underlined = false)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_underline-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 533</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_underline</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-identifier">underlined</span> = <span class="ruby-keyword">false</span>) + <span class="ruby-identifier">xf</span> = <span class="ruby-identifier">get_col_xf</span>(<span class="ruby-identifier">column_index</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">fonts</span>[<span class="ruby-identifier">xf</span>.<span class="ruby-identifier">font_id</span>].<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_underline</span>(<span class="ruby-identifier">underlined</span>) + <span class="ruby-identifier">change_column_font</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">UNDERLINE</span>, <span class="ruby-identifier">underlined</span>, <span class="ruby-identifier">font</span>, <span class="ruby-identifier">xf</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_column_vertical_alignment" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_column_vertical_alignment</span><span + class="method-args">(column_index, alignment = 'center')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_column_vertical_alignment-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 551</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_column_vertical_alignment</span>(<span class="ruby-identifier">column_index</span>, <span class="ruby-identifier">alignment</span> = <span class="ruby-string">&#39;center&#39;</span>) + <span class="ruby-identifier">change_column_alignment</span>(<span class="ruby-identifier">column_index</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">vertical</span> = <span class="ruby-identifier">alignment</span> } +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_alignment" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_alignment</span><span + class="method-args">(row, &block)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_alignment-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 592</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_alignment</span>(<span class="ruby-identifier">row</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) + <span class="ruby-identifier">validate_workbook</span> + <span class="ruby-identifier">validate_nonnegative</span>(<span class="ruby-identifier">row</span>) + <span class="ruby-identifier">ensure_cell_exists</span>(<span class="ruby-identifier">row</span>) + + <span class="ruby-identifier">sheet_data</span>.<span class="ruby-identifier">rows</span>[<span class="ruby-identifier">row</span>].<span class="ruby-identifier">style_index</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">modify_alignment</span>(<span class="ruby-identifier">get_row_style</span>(<span class="ruby-identifier">row</span>), <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) + + <span class="ruby-identifier">sheet_data</span>[<span class="ruby-identifier">row</span>].<span class="ruby-identifier">cells</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> + <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">nil?</span> + <span class="ruby-identifier">c</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">modify_alignment</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">style_index</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) + } +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_bold" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_bold</span><span + class="method-args">(row = 0, bolded = false)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_bold-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 466</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_bold</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">bolded</span> = <span class="ruby-keyword">false</span>) + <span class="ruby-identifier">ensure_cell_exists</span>(<span class="ruby-identifier">row</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-identifier">row_font</span>(<span class="ruby-identifier">row</span>).<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_bold</span>(<span class="ruby-identifier">bolded</span>) + <span class="ruby-identifier">change_row_font</span>(<span class="ruby-identifier">row</span>, <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">BOLD</span>, <span class="ruby-identifier">bolded</span>, <span class="ruby-identifier">font</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_border" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_border</span><span + class="method-args">(row, direction, weight)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_border-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 417</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_border</span>(<span class="ruby-identifier">row</span>, <span class="ruby-identifier">direction</span>, <span class="ruby-identifier">weight</span>) + <span class="ruby-identifier">validate_workbook</span> + <span class="ruby-identifier">ensure_cell_exists</span>(<span class="ruby-identifier">row</span>) + + <span class="ruby-identifier">sheet_data</span>.<span class="ruby-identifier">rows</span>[<span class="ruby-identifier">row</span>].<span class="ruby-identifier">style_index</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">modify_border</span>(<span class="ruby-identifier">get_row_style</span>(<span class="ruby-identifier">row</span>), <span class="ruby-identifier">direction</span>, <span class="ruby-identifier">weight</span>) + + <span class="ruby-identifier">sheet_data</span>[<span class="ruby-identifier">row</span>].<span class="ruby-identifier">cells</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">c</span>.<span class="ruby-identifier">change_border</span>(<span class="ruby-identifier">direction</span>, <span class="ruby-identifier">weight</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">nil?</span> + } +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_border_bottom" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_border_bottom</span><span + class="method-args">(row = 0, weight = 'thin')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_border_bottom-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 407</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_border_bottom</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">weight</span> = <span class="ruby-string">&#39;thin&#39;</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `change_row_border` instead.&quot;</span> + <span class="ruby-identifier">change_row_border</span>(<span class="ruby-identifier">row</span>, <span class="ruby-value">:bottom</span>, <span class="ruby-identifier">weight</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_border_diagonal" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_border_diagonal</span><span + class="method-args">(row = 0, weight = 'thin')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_border_diagonal-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 412</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_border_diagonal</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">weight</span> = <span class="ruby-string">&#39;thin&#39;</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `change_row_border` instead.&quot;</span> + <span class="ruby-identifier">change_row_border</span>(<span class="ruby-identifier">row</span>, <span class="ruby-value">:diagonal</span>, <span class="ruby-identifier">weight</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_border_left" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_border_left</span><span + class="method-args">(row = 0, weight = 'thin')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_border_left-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 397</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_border_left</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">weight</span> = <span class="ruby-string">&#39;thin&#39;</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `change_row_border` instead.&quot;</span> + <span class="ruby-identifier">change_row_border</span>(<span class="ruby-identifier">row</span>, <span class="ruby-value">:left</span>, <span class="ruby-identifier">weight</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_border_right" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_border_right</span><span + class="method-args">(row = 0, weight = 'thin')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_border_right-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 402</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_border_right</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">weight</span> = <span class="ruby-string">&#39;thin&#39;</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `change_row_border` instead.&quot;</span> + <span class="ruby-identifier">change_row_border</span>(<span class="ruby-identifier">row</span>, <span class="ruby-value">:right</span>, <span class="ruby-identifier">weight</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_border_top" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_border_top</span><span + class="method-args">(row = 0, weight = 'thin')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_border_top-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 392</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_border_top</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">weight</span> = <span class="ruby-string">&#39;thin&#39;</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `change_row_border` instead.&quot;</span> + <span class="ruby-identifier">change_row_border</span>(<span class="ruby-identifier">row</span>, <span class="ruby-value">:top</span>, <span class="ruby-identifier">weight</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_fill" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_fill</span><span + class="method-args">(row_index = 0, rgb = 'ffffff')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_fill-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 428</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_fill</span>(<span class="ruby-identifier">row_index</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">rgb</span> = <span class="ruby-string">&#39;ffffff&#39;</span>) + <span class="ruby-identifier">validate_workbook</span> + <span class="ruby-identifier">ensure_cell_exists</span>(<span class="ruby-identifier">row_index</span>) + <span class="ruby-constant">Color</span>.<span class="ruby-identifier">validate_color</span>(<span class="ruby-identifier">rgb</span>) + + <span class="ruby-identifier">sheet_data</span>.<span class="ruby-identifier">rows</span>[<span class="ruby-identifier">row_index</span>].<span class="ruby-identifier">style_index</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">modify_fill</span>(<span class="ruby-identifier">get_row_style</span>(<span class="ruby-identifier">row_index</span>), <span class="ruby-identifier">rgb</span>) + <span class="ruby-identifier">sheet_data</span>[<span class="ruby-identifier">row_index</span>].<span class="ruby-identifier">cells</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">change_fill</span>(<span class="ruby-identifier">rgb</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">nil?</span> } +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_font_color" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_font_color</span><span + class="method-args">(row = 0, font_color = '000000')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_font_color-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 451</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_font_color</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">font_color</span> = <span class="ruby-string">&#39;000000&#39;</span>) + <span class="ruby-identifier">ensure_cell_exists</span>(<span class="ruby-identifier">row</span>) + <span class="ruby-constant">Color</span>.<span class="ruby-identifier">validate_color</span>(<span class="ruby-identifier">font_color</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-identifier">row_font</span>(<span class="ruby-identifier">row</span>).<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_rgb_color</span>(<span class="ruby-identifier">font_color</span>) + <span class="ruby-identifier">change_row_font</span>(<span class="ruby-identifier">row</span>, <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">COLOR</span>, <span class="ruby-identifier">font_color</span>, <span class="ruby-identifier">font</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_font_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_font_name</span><span + class="method-args">(row = 0, font_name = 'Verdana')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_font_name-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 437</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_font_name</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">font_name</span> = <span class="ruby-string">&#39;Verdana&#39;</span>) + <span class="ruby-identifier">ensure_cell_exists</span>(<span class="ruby-identifier">row</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-identifier">row_font</span>(<span class="ruby-identifier">row</span>).<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_name</span>(<span class="ruby-identifier">font_name</span>) + <span class="ruby-identifier">change_row_font</span>(<span class="ruby-identifier">row</span>, <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">NAME</span>, <span class="ruby-identifier">font_name</span>, <span class="ruby-identifier">font</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_font_size" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_font_size</span><span + class="method-args">(row = 0, font_size=10)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_font_size-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 444</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_font_size</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">font_size</span>=<span class="ruby-value">10</span>) + <span class="ruby-identifier">ensure_cell_exists</span>(<span class="ruby-identifier">row</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-identifier">row_font</span>(<span class="ruby-identifier">row</span>).<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_size</span>(<span class="ruby-identifier">font_size</span>) + <span class="ruby-identifier">change_row_font</span>(<span class="ruby-identifier">row</span>, <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">SIZE</span>, <span class="ruby-identifier">font_size</span>, <span class="ruby-identifier">font</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_height" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_height</span><span + class="method-args">(row = 0, height = 10)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_height-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 487</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_height</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">height</span> = <span class="ruby-value">10</span>) + <span class="ruby-identifier">validate_workbook</span> + <span class="ruby-identifier">ensure_cell_exists</span>(<span class="ruby-identifier">row</span>) + + <span class="ruby-identifier">c</span> = <span class="ruby-identifier">sheet_data</span>.<span class="ruby-identifier">rows</span>[<span class="ruby-identifier">row</span>] + <span class="ruby-identifier">c</span>.<span class="ruby-identifier">ht</span> = <span class="ruby-identifier">height</span> + <span class="ruby-identifier">c</span>.<span class="ruby-identifier">custom_height</span> = <span class="ruby-keyword">true</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_horizontal_alignment" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_horizontal_alignment</span><span + class="method-args">(row = 0, alignment = 'center')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_horizontal_alignment-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 380</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_horizontal_alignment</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">alignment</span> = <span class="ruby-string">&#39;center&#39;</span>) + <span class="ruby-identifier">validate_workbook</span> + <span class="ruby-identifier">validate_nonnegative</span>(<span class="ruby-identifier">row</span>) + <span class="ruby-identifier">change_row_alignment</span>(<span class="ruby-identifier">row</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">horizontal</span> = <span class="ruby-identifier">alignment</span> } +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_italics" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_italics</span><span + class="method-args">(row = 0, italicized = false)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_italics-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 459</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_italics</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">italicized</span> = <span class="ruby-keyword">false</span>) + <span class="ruby-identifier">ensure_cell_exists</span>(<span class="ruby-identifier">row</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-identifier">row_font</span>(<span class="ruby-identifier">row</span>).<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_italic</span>(<span class="ruby-identifier">italicized</span>) + <span class="ruby-identifier">change_row_font</span>(<span class="ruby-identifier">row</span>, <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">ITALICS</span>, <span class="ruby-identifier">italicized</span>, <span class="ruby-identifier">font</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_strikethrough" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_strikethrough</span><span + class="method-args">(row = 0, struckthrough=false)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_strikethrough-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 480</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_strikethrough</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">struckthrough</span>=<span class="ruby-keyword">false</span>) + <span class="ruby-identifier">ensure_cell_exists</span>(<span class="ruby-identifier">row</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-identifier">row_font</span>(<span class="ruby-identifier">row</span>).<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_strikethrough</span>(<span class="ruby-identifier">struckthrough</span>) + <span class="ruby-identifier">change_row_font</span>(<span class="ruby-identifier">row</span>, <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">STRIKETHROUGH</span>, <span class="ruby-identifier">struckthrough</span>, <span class="ruby-identifier">font</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_underline" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_underline</span><span + class="method-args">(row = 0, underlined=false)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_underline-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 473</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_underline</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">underlined</span>=<span class="ruby-keyword">false</span>) + <span class="ruby-identifier">ensure_cell_exists</span>(<span class="ruby-identifier">row</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-identifier">row_font</span>(<span class="ruby-identifier">row</span>).<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_underline</span>(<span class="ruby-identifier">underlined</span>) + <span class="ruby-identifier">change_row_font</span>(<span class="ruby-identifier">row</span>, <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">UNDERLINE</span>, <span class="ruby-identifier">underlined</span>, <span class="ruby-identifier">font</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-change_row_vertical_alignment" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">change_row_vertical_alignment</span><span + class="method-args">(row = 0, alignment = 'center')</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="change_row_vertical_alignment-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 386</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_row_vertical_alignment</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">alignment</span> = <span class="ruby-string">&#39;center&#39;</span>) + <span class="ruby-identifier">validate_workbook</span> + <span class="ruby-identifier">validate_nonnegative</span>(<span class="ruby-identifier">row</span>) + <span class="ruby-identifier">change_row_alignment</span>(<span class="ruby-identifier">row</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">vertical</span> = <span class="ruby-identifier">alignment</span> } +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_column_alignment" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_column_alignment</span><span + class="method-args">(col, type)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_column_alignment-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 337</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_column_alignment</span>(<span class="ruby-identifier">col</span>, <span class="ruby-identifier">type</span>) + <span class="ruby-identifier">validate_workbook</span> + <span class="ruby-identifier">validate_nonnegative</span>(<span class="ruby-identifier">col</span>) + + <span class="ruby-identifier">xf</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">cell_xfs</span>[<span class="ruby-identifier">get_cols_style_index</span>(<span class="ruby-identifier">col</span>)] + <span class="ruby-identifier">xf</span>.<span class="ruby-identifier">alignment</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">xf</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">type</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_column_border" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_column_border</span><span + class="method-args">(col, border_direction)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_column_border-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 328</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_column_border</span>(<span class="ruby-identifier">col</span>, <span class="ruby-identifier">border_direction</span>) + <span class="ruby-identifier">validate_workbook</span> + <span class="ruby-identifier">validate_nonnegative</span>(<span class="ruby-identifier">col</span>) + + <span class="ruby-identifier">xf</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">cell_xfs</span>[<span class="ruby-identifier">get_cols_style_index</span>(<span class="ruby-identifier">col</span>)] + <span class="ruby-identifier">border</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">borders</span>[<span class="ruby-identifier">xf</span>.<span class="ruby-identifier">border_id</span>] + <span class="ruby-identifier">border</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">border</span>.<span class="ruby-identifier">get_edge_style</span>(<span class="ruby-identifier">border_direction</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_column_border_bottom" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_column_border_bottom</span><span + class="method-args">(col=0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_column_border_bottom-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 370</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_column_border_bottom</span>(<span class="ruby-identifier">col</span>=<span class="ruby-value">0</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `get_column_border` instead.&quot;</span> + <span class="ruby-identifier">get_column_border</span>(<span class="ruby-identifier">col</span>, <span class="ruby-value">:bottom</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_column_border_diagonal" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_column_border_diagonal</span><span + class="method-args">(col=0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_column_border_diagonal-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 375</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_column_border_diagonal</span>(<span class="ruby-identifier">col</span>=<span class="ruby-value">0</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `get_column_border` instead.&quot;</span> + <span class="ruby-identifier">get_column_border</span>(<span class="ruby-identifier">col</span>, <span class="ruby-value">:diagonal</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_column_border_left" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_column_border_left</span><span + class="method-args">(col=0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_column_border_left-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 360</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_column_border_left</span>(<span class="ruby-identifier">col</span>=<span class="ruby-value">0</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `get_column_border` instead.&quot;</span> + <span class="ruby-identifier">get_column_border</span>(<span class="ruby-identifier">col</span>, <span class="ruby-value">:left</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_column_border_right" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_column_border_right</span><span + class="method-args">(col=0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_column_border_right-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 365</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_column_border_right</span>(<span class="ruby-identifier">col</span>=<span class="ruby-value">0</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `get_column_border` instead.&quot;</span> + <span class="ruby-identifier">get_column_border</span>(<span class="ruby-identifier">col</span>, <span class="ruby-value">:right</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_column_border_top" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_column_border_top</span><span + class="method-args">(col=0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_column_border_top-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 355</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_column_border_top</span>(<span class="ruby-identifier">col</span>=<span class="ruby-value">0</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `get_column_border` instead.&quot;</span> + <span class="ruby-identifier">get_column_border</span>(<span class="ruby-identifier">col</span>, <span class="ruby-value">:top</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_column_fill" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_column_fill</span><span + class="method-args">(col=0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_column_fill-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 321</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_column_fill</span>(<span class="ruby-identifier">col</span>=<span class="ruby-value">0</span>) + <span class="ruby-identifier">validate_workbook</span> + <span class="ruby-identifier">validate_nonnegative</span>(<span class="ruby-identifier">col</span>) + + <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">get_fill_color</span>(<span class="ruby-identifier">get_col_xf</span>(<span class="ruby-identifier">col</span>)) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_column_font_color" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_column_font_color</span><span + class="method-args">(col = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_column_font_color-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 279</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_column_font_color</span>(<span class="ruby-identifier">col</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-identifier">column_font</span>(<span class="ruby-identifier">col</span>) + <span class="ruby-identifier">font</span> <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">font</span>.<span class="ruby-identifier">get_rgb_color</span> <span class="ruby-operator">||</span> <span class="ruby-string">&#39;000000&#39;</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_column_font_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_column_font_name</span><span + class="method-args">(col = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_column_font_name-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 269</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_column_font_name</span>(<span class="ruby-identifier">col</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-identifier">column_font</span>(<span class="ruby-identifier">col</span>) + <span class="ruby-identifier">font</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">font</span>.<span class="ruby-identifier">get_name</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_column_font_size" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_column_font_size</span><span + class="method-args">(col = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_column_font_size-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 274</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_column_font_size</span>(<span class="ruby-identifier">col</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-identifier">column_font</span>(<span class="ruby-identifier">col</span>) + <span class="ruby-identifier">font</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">font</span>.<span class="ruby-identifier">get_size</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_column_horizontal_alignment" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_column_horizontal_alignment</span><span + class="method-args">(col=0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_column_horizontal_alignment-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 345</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_column_horizontal_alignment</span>(<span class="ruby-identifier">col</span>=<span class="ruby-value">0</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `get_column_alignment` instead.&quot;</span> + <span class="ruby-identifier">get_column_alignment</span>(<span class="ruby-identifier">col</span>, <span class="ruby-value">:horizontal</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_column_vertical_alignment" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_column_vertical_alignment</span><span + class="method-args">(col=0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_column_vertical_alignment-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 350</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_column_vertical_alignment</span>(<span class="ruby-identifier">col</span>=<span class="ruby-value">0</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `get_column_alignment` instead.&quot;</span> + <span class="ruby-identifier">get_column_alignment</span>(<span class="ruby-identifier">col</span>, <span class="ruby-value">:vertical</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_column_width" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_column_width</span><span + class="method-args">(column_index = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Get column width measured in number of digits, as per <a +href="http://msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.column%28v=office.14%29.aspx">msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.column%28v=office.14%29.aspx</a></p> + + + + + <div class="method-source-code" id="get_column_width-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 315</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_column_width</span>(<span class="ruby-identifier">column_index</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">width</span> = <span class="ruby-identifier">get_column_width_raw</span>(<span class="ruby-identifier">column_index</span>) + <span class="ruby-keyword">return</span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">ColumnRange</span><span class="ruby-operator">::</span><span class="ruby-constant">DEFAULT_WIDTH</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">width</span>.<span class="ruby-identifier">nil?</span> + (<span class="ruby-identifier">width</span> <span class="ruby-operator">-</span> (<span class="ruby-value">5.0</span> <span class="ruby-operator">/</span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Font</span><span class="ruby-operator">::</span><span class="ruby-constant">MAX_DIGIT_WIDTH</span>)).<span class="ruby-identifier">round</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_column_width_raw" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_column_width_raw</span><span + class="method-args">(column_index = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Get raw column width value as stored in the file</p> + + + + + <div class="method-source-code" id="get_column_width_raw-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 305</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_column_width_raw</span>(<span class="ruby-identifier">column_index</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">validate_workbook</span> + <span class="ruby-identifier">validate_nonnegative</span>(<span class="ruby-identifier">column_index</span>) + + <span class="ruby-identifier">range</span> = <span class="ruby-identifier">cols</span>.<span class="ruby-identifier">locate_range</span>(<span class="ruby-identifier">column_index</span>) + <span class="ruby-identifier">range</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">range</span>.<span class="ruby-identifier">width</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_row_border" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_row_border</span><span + class="method-args">(row, border_direction)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_row_border-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 228</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_row_border</span>(<span class="ruby-identifier">row</span>, <span class="ruby-identifier">border_direction</span>) + <span class="ruby-identifier">validate_workbook</span> + <span class="ruby-identifier">validate_nonnegative</span>(<span class="ruby-identifier">row</span>) + + <span class="ruby-identifier">border</span> = <span class="ruby-ivar">@workbook</span>.<span class="ruby-identifier">borders</span>[<span class="ruby-identifier">get_row_xf</span>(<span class="ruby-identifier">row</span>).<span class="ruby-identifier">border_id</span>] + <span class="ruby-identifier">border</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">border</span>.<span class="ruby-identifier">get_edge_style</span>(<span class="ruby-identifier">border_direction</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_row_border_bottom" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_row_border_bottom</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_row_border_bottom-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 259</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_row_border_bottom</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `get_row_border` instead.&quot;</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">get_row_border</span>(<span class="ruby-identifier">row</span>, <span class="ruby-value">:bottom</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_row_border_diagonal" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_row_border_diagonal</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_row_border_diagonal-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 264</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_row_border_diagonal</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `get_row_border` instead.&quot;</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">get_row_border</span>(<span class="ruby-identifier">row</span>, <span class="ruby-value">:diagonal</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_row_border_left" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_row_border_left</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_row_border_left-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 249</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_row_border_left</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `get_row_border` instead.&quot;</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">get_row_border</span>(<span class="ruby-identifier">row</span>, <span class="ruby-value">:left</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_row_border_right" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_row_border_right</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_row_border_right-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 254</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_row_border_right</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `get_row_border` instead.&quot;</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">get_row_border</span>(<span class="ruby-identifier">row</span>, <span class="ruby-value">:right</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_row_border_top" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_row_border_top</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_row_border_top-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 244</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_row_border_top</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;[DEPRECATION] `#{__method__}` is deprecated. Please use `get_row_border` instead.&quot;</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">get_row_border</span>(<span class="ruby-identifier">row</span>, <span class="ruby-value">:top</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_row_fill" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_row_fill</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_row_fill-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 187</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_row_fill</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + (<span class="ruby-identifier">row</span> = <span class="ruby-identifier">sheet_data</span>.<span class="ruby-identifier">rows</span>[<span class="ruby-identifier">row</span>]) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">row</span>.<span class="ruby-identifier">get_fill_color</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_row_font_color" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_row_font_color</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_row_font_color-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 199</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_row_font_color</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-identifier">row_font</span>(<span class="ruby-identifier">row</span>) + <span class="ruby-identifier">color</span> = <span class="ruby-identifier">font</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">font</span>.<span class="ruby-identifier">color</span> + <span class="ruby-identifier">color</span> <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">color</span>.<span class="ruby-identifier">rgb</span> <span class="ruby-operator">||</span> <span class="ruby-string">&#39;000000&#39;</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_row_font_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_row_font_name</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_row_font_name-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 191</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_row_font_name</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + (<span class="ruby-identifier">font</span> = <span class="ruby-identifier">row_font</span>(<span class="ruby-identifier">row</span>)) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">font</span>.<span class="ruby-identifier">get_name</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_row_font_size" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_row_font_size</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_row_font_size-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 195</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_row_font_size</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + (<span class="ruby-identifier">font</span> = <span class="ruby-identifier">row_font</span>(<span class="ruby-identifier">row</span>)) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">font</span>.<span class="ruby-identifier">get_size</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_row_height" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_row_height</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_row_height-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 221</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_row_height</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">validate_workbook</span> + <span class="ruby-identifier">validate_nonnegative</span>(<span class="ruby-identifier">row</span>) + <span class="ruby-identifier">row</span> = <span class="ruby-identifier">sheet_data</span>.<span class="ruby-identifier">rows</span>[<span class="ruby-identifier">row</span>] + <span class="ruby-identifier">row</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">row</span>.<span class="ruby-identifier">ht</span> <span class="ruby-operator">||</span> <span class="ruby-value">13</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_row_horizontal_alignment" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_row_horizontal_alignment</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_row_horizontal_alignment-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 236</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_row_horizontal_alignment</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + <span class="ruby-keyword">return</span> <span class="ruby-identifier">get_row_alignment</span>(<span class="ruby-identifier">row</span>, <span class="ruby-keyword">true</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-get_row_vertical_alignment" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">get_row_vertical_alignment</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="get_row_vertical_alignment-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 240</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_row_vertical_alignment</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + <span class="ruby-keyword">return</span> <span class="ruby-identifier">get_row_alignment</span>(<span class="ruby-identifier">row</span>, <span class="ruby-keyword">false</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-is_column_bolded" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">is_column_bolded</span><span + class="method-args">(col = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="is_column_bolded-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 289</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_column_bolded</span>(<span class="ruby-identifier">col</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-identifier">column_font</span>(<span class="ruby-identifier">col</span>) + <span class="ruby-identifier">font</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">font</span>.<span class="ruby-identifier">is_bold</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-is_column_italicized" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">is_column_italicized</span><span + class="method-args">(col = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="is_column_italicized-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 284</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_column_italicized</span>(<span class="ruby-identifier">col</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-identifier">column_font</span>(<span class="ruby-identifier">col</span>) + <span class="ruby-identifier">font</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">font</span>.<span class="ruby-identifier">is_italic</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-is_column_struckthrough" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">is_column_struckthrough</span><span + class="method-args">(col = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="is_column_struckthrough-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 299</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_column_struckthrough</span>(<span class="ruby-identifier">col</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-identifier">column_font</span>(<span class="ruby-identifier">col</span>) + <span class="ruby-identifier">font</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">font</span>.<span class="ruby-identifier">is_strikethrough</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-is_column_underlined" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">is_column_underlined</span><span + class="method-args">(col = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="is_column_underlined-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 294</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_column_underlined</span>(<span class="ruby-identifier">col</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">font</span> = <span class="ruby-identifier">column_font</span>(<span class="ruby-identifier">col</span>) + <span class="ruby-identifier">font</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">font</span>.<span class="ruby-identifier">is_underlined</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-is_row_bolded" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">is_row_bolded</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="is_row_bolded-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 209</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_row_bolded</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + (<span class="ruby-identifier">font</span> = <span class="ruby-identifier">row_font</span>(<span class="ruby-identifier">row</span>)) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">font</span>.<span class="ruby-identifier">is_bold</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-is_row_italicized" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">is_row_italicized</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="is_row_italicized-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 205</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_row_italicized</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + (<span class="ruby-identifier">font</span> = <span class="ruby-identifier">row_font</span>(<span class="ruby-identifier">row</span>)) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">font</span>.<span class="ruby-identifier">is_italic</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-is_row_struckthrough" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">is_row_struckthrough</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="is_row_struckthrough-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 217</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_row_struckthrough</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + (<span class="ruby-identifier">font</span> = <span class="ruby-identifier">row_font</span>(<span class="ruby-identifier">row</span>)) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">font</span>.<span class="ruby-identifier">is_strikethrough</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-is_row_underlined" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">is_row_underlined</span><span + class="method-args">(row = 0)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="is_row_underlined-source"> + <pre><span class="ruby-comment"># File lib/rubyXL/convenience_methods.rb, line 213</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_row_underlined</span>(<span class="ruby-identifier">row</span> = <span class="ruby-value">0</span>) + (<span class="ruby-identifier">font</span> = <span class="ruby-identifier">row_font</span>(<span class="ruby-identifier">row</span>)) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">font</span>.<span class="ruby-identifier">is_underlined</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + </section> + </section> </main> <footer id="validator-badges" role="contentinfo"> <p><a href="http://validator.w3.org/check/referer">Validate</a> - <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.2. - <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. + <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0. + <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. </footer>