<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module RubyXL::LegacyCell - rubyXL 3.2.6</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>
<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>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<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-border_bottom">#border_bottom</a>
<li ><a href="#method-i-border_diagonal">#border_diagonal</a>
<li ><a href="#method-i-border_left">#border_left</a>
<li ><a href="#method-i-border_right">#border_right</a>
<li ><a href="#method-i-border_top">#border_top</a>
<li ><a href="#method-i-change_border">#change_border</a>
<li ><a href="#method-i-change_border_bottom">#change_border_bottom</a>
<li ><a href="#method-i-change_border_diagonal">#change_border_diagonal</a>
<li ><a href="#method-i-change_border_left">#change_border_left</a>
<li ><a href="#method-i-change_border_right">#change_border_right</a>
<li ><a href="#method-i-change_border_top">#change_border_top</a>
<li ><a href="#method-i-change_contents">#change_contents</a>
<li ><a href="#method-i-change_fill">#change_fill</a>
<li ><a href="#method-i-change_font_bold">#change_font_bold</a>
<li ><a href="#method-i-change_font_color">#change_font_color</a>
<li ><a href="#method-i-change_font_italics">#change_font_italics</a>
<li ><a href="#method-i-change_font_name">#change_font_name</a>
<li ><a href="#method-i-change_font_size">#change_font_size</a>
<li ><a href="#method-i-change_font_strikethrough">#change_font_strikethrough</a>
<li ><a href="#method-i-change_font_underline">#change_font_underline</a>
<li ><a href="#method-i-change_horizontal_alignment">#change_horizontal_alignment</a>
<li ><a href="#method-i-change_text_wrap">#change_text_wrap</a>
<li ><a href="#method-i-change_vertical_alignment">#change_vertical_alignment</a>
<li ><a href="#method-i-fill_color">#fill_color</a>
<li ><a href="#method-i-font_color">#font_color</a>
<li ><a href="#method-i-font_name">#font_name</a>
<li ><a href="#method-i-font_size">#font_size</a>
<li ><a href="#method-i-font_switch">#font_switch</a>
<li ><a href="#method-i-horizontal_alignment">#horizontal_alignment</a>
<li ><a href="#method-i-inspect">#inspect</a>
<li ><a href="#method-i-is_bolded">#is_bolded</a>
<li ><a href="#method-i-is_italicized">#is_italicized</a>
<li ><a href="#method-i-is_struckthrough">#is_struckthrough</a>
<li ><a href="#method-i-is_underlined">#is_underlined</a>
<li ><a href="#method-i-text_wrap">#text_wrap</a>
<li ><a href="#method-i-vertical_alignment">#vertical_alignment</a>
<li ><a href="#method-i-workbook">#workbook</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-RubyXL::LegacyCell">
<h1 id="module-RubyXL::LegacyCell" class="module">
module RubyXL::LegacyCell
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-formula" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">formula</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-worksheet" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">worksheet</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-border_bottom" class="method-detail ">
<div class="method-heading">
<span class="method-name">border_bottom</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns cell's bottom border</p>
<div class="method-source-code" id="border_bottom-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 248</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">border_bottom</span>()
<span class="ruby-keyword">return</span> <span class="ruby-identifier">get_border</span>(<span class="ruby-value">:bottom</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-border_diagonal" class="method-detail ">
<div class="method-heading">
<span class="method-name">border_diagonal</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns cell's diagonal border</p>
<div class="method-source-code" id="border_diagonal-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 253</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">border_diagonal</span>()
<span class="ruby-keyword">return</span> <span class="ruby-identifier">get_border</span>(<span class="ruby-value">:diagonal</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-border_left" class="method-detail ">
<div class="method-heading">
<span class="method-name">border_left</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns cell's left border</p>
<div class="method-source-code" id="border_left-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 238</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">border_left</span>()
<span class="ruby-keyword">return</span> <span class="ruby-identifier">get_border</span>(<span class="ruby-value">:left</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-border_right" class="method-detail ">
<div class="method-heading">
<span class="method-name">border_right</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns cell's right border</p>
<div class="method-source-code" id="border_right-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 243</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">border_right</span>()
<span class="ruby-keyword">return</span> <span class="ruby-identifier">get_border</span>(<span class="ruby-value">:right</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-border_top" class="method-detail ">
<div class="method-heading">
<span class="method-name">border_top</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns cell's top border</p>
<div class="method-source-code" id="border_top-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 233</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">border_top</span>()
<span class="ruby-keyword">return</span> <span class="ruby-identifier">get_border</span>(<span class="ruby-value">:top</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-change_border" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_border</span><span
class="method-args">(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_border-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 117</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_border</span>(<span class="ruby-identifier">direction</span>, <span class="ruby-identifier">weight</span>)
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">modify_border</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span>, <span class="ruby-identifier">direction</span>, <span class="ruby-identifier">weight</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-change_border_bottom" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_border_bottom</span><span
class="method-args">(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_border_bottom-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 137</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_border_bottom</span>(<span class="ruby-identifier">weight</span> = <span class="ruby-string">'thin'</span>)
<span class="ruby-identifier">warn</span> <span class="ruby-node">"[DEPRECATION] `#{__method__}` is deprecated. Please use `change_border` instead."</span>
<span class="ruby-identifier">change_border</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_border_diagonal" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_border_diagonal</span><span
class="method-args">(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_border_diagonal-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 142</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_border_diagonal</span>(<span class="ruby-identifier">weight</span> = <span class="ruby-string">'thin'</span>)
<span class="ruby-identifier">warn</span> <span class="ruby-node">"[DEPRECATION] `#{__method__}` is deprecated. Please use `change_border` instead."</span>
<span class="ruby-identifier">change_border</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_border_left" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_border_left</span><span
class="method-args">(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_border_left-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 127</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_border_left</span>(<span class="ruby-identifier">weight</span> = <span class="ruby-string">'thin'</span>)
<span class="ruby-identifier">warn</span> <span class="ruby-node">"[DEPRECATION] `#{__method__}` is deprecated. Please use `change_border` instead."</span>
<span class="ruby-identifier">change_border</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_border_right" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_border_right</span><span
class="method-args">(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_border_right-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 132</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_border_right</span>(<span class="ruby-identifier">weight</span> = <span class="ruby-string">'thin'</span>)
<span class="ruby-identifier">warn</span> <span class="ruby-node">"[DEPRECATION] `#{__method__}` is deprecated. Please use `change_border` instead."</span>
<span class="ruby-identifier">change_border</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_border_top" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_border_top</span><span
class="method-args">(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_border_top-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 122</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_border_top</span>(<span class="ruby-identifier">weight</span> = <span class="ruby-string">'thin'</span>)
<span class="ruby-identifier">warn</span> <span class="ruby-node">"[DEPRECATION] `#{__method__}` is deprecated. Please use `change_border` instead."</span>
<span class="ruby-identifier">change_border</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_contents" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_contents</span><span
class="method-args">(data, formula_expression = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="change_contents-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 147</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_contents</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">formula_expression</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">formula_expression</span> <span class="ruby-keyword">then</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">datatype</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">formula</span> = <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Formula</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:expression</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">formula_expression</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">datatype</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">data</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Date</span>, <span class="ruby-constant">Integer</span>, <span class="ruby-constant">Float</span> <span class="ruby-keyword">then</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">else</span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">DataType</span><span class="ruby-operator">::</span><span class="ruby-constant">RAW_STRING</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">date_to_num</span>(<span class="ruby-identifier">data</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Date</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">raw_value</span> = <span class="ruby-identifier">data</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-change_fill" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_fill</span><span
class="method-args">(rgb = 'ffffff')</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>changes fill color of cell</p>
<div class="method-source-code" id="change_fill-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 22</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_fill</span>(<span class="ruby-identifier">rgb</span> = <span class="ruby-string">'ffffff'</span>)
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-constant">Color</span>.<span class="ruby-identifier">validate_color</span>(<span class="ruby-identifier">rgb</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">modify_fill</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span>, <span class="ruby-identifier">rgb</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-change_font_bold" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_font_bold</span><span
class="method-args">(bolded = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Changes font bold settings of cell</p>
<div class="method-source-code" id="change_font_bold-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_font_bold</span>(<span class="ruby-identifier">bolded</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">font</span> = <span class="ruby-identifier">get_cell_font</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">update_font_references</span>(<span class="ruby-identifier">font</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-change_font_color" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_font_color</span><span
class="method-args">(font_color = '000000')</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Changes font color of cell</p>
<div class="method-source-code" id="change_font_color-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_font_color</span>(<span class="ruby-identifier">font_color</span> = <span class="ruby-string">'000000'</span>)
<span class="ruby-identifier">validate_worksheet</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">get_cell_font</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">update_font_references</span>(<span class="ruby-identifier">font</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-change_font_italics" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_font_italics</span><span
class="method-args">(italicized = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Changes font italics settings of cell</p>
<div class="method-source-code" id="change_font_italics-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 58</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_font_italics</span>(<span class="ruby-identifier">italicized</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">font</span> = <span class="ruby-identifier">get_cell_font</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">update_font_references</span>(<span class="ruby-identifier">font</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-change_font_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_font_name</span><span
class="method-args">(new_font_name = 'Verdana')</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Changes font name of cell</p>
<div class="method-source-code" id="change_font_name-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 29</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_font_name</span>(<span class="ruby-identifier">new_font_name</span> = <span class="ruby-string">'Verdana'</span>)
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">font</span> = <span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-identifier">font</span>.<span class="ruby-identifier">set_name</span>(<span class="ruby-identifier">new_font_name</span>)
<span class="ruby-identifier">update_font_references</span>(<span class="ruby-identifier">font</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-change_font_size" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_font_size</span><span
class="method-args">(font_size = 10)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Changes font size of cell</p>
<div class="method-source-code" id="change_font_size-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 38</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_font_size</span>(<span class="ruby-identifier">font_size</span> = <span class="ruby-value">10</span>)
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">raise</span> <span class="ruby-string">'Argument must be a number'</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">font_size</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Integer</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">font_size</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Float</span>)
<span class="ruby-identifier">font</span> = <span class="ruby-identifier">get_cell_font</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">update_font_references</span>(<span class="ruby-identifier">font</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-change_font_strikethrough" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_font_strikethrough</span><span
class="method-args">(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_font_strikethrough-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 84</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_font_strikethrough</span>(<span class="ruby-identifier">struckthrough</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">font</span> = <span class="ruby-identifier">get_cell_font</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">update_font_references</span>(<span class="ruby-identifier">font</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-change_font_underline" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_font_underline</span><span
class="method-args">(underlined = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Changes font underline settings of cell</p>
<div class="method-source-code" id="change_font_underline-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 76</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_font_underline</span>(<span class="ruby-identifier">underlined</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">font</span> = <span class="ruby-identifier">get_cell_font</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">update_font_references</span>(<span class="ruby-identifier">font</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-change_horizontal_alignment" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_horizontal_alignment</span><span
class="method-args">(alignment = 'center')</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>changes horizontal alignment of cell</p>
<div class="method-source-code" id="change_horizontal_alignment-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 100</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_horizontal_alignment</span>(<span class="ruby-identifier">alignment</span> = <span class="ruby-string">'center'</span>)
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">modify_alignment</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span>, <span class="ruby-keyword">true</span>, <span class="ruby-identifier">alignment</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-change_text_wrap" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_text_wrap</span><span
class="method-args">(wrap = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>changes wrap of cell</p>
<div class="method-source-code" id="change_text_wrap-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 112</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_text_wrap</span>(<span class="ruby-identifier">wrap</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">modify_text_wrap</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span>, <span class="ruby-identifier">wrap</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-change_vertical_alignment" class="method-detail ">
<div class="method-heading">
<span class="method-name">change_vertical_alignment</span><span
class="method-args">(alignment = 'center')</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>changes vertical alignment of cell</p>
<div class="method-source-code" id="change_vertical_alignment-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 106</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">change_vertical_alignment</span>(<span class="ruby-identifier">alignment</span> = <span class="ruby-string">'center'</span>)
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">modify_alignment</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">style_index</span>, <span class="ruby-keyword">false</span>, <span class="ruby-identifier">alignment</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fill_color" class="method-detail ">
<div class="method-heading">
<span class="method-name">fill_color</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns cell's fill color</p>
<div class="method-source-code" id="fill_color-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 203</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">fill_color</span>()
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">get_fill_color</span>(<span class="ruby-identifier">get_cell_xf</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-font_color" class="method-detail ">
<div class="method-heading">
<span class="method-name">font_color</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="font_color-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 197</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">font_color</span>()
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">get_rgb_color</span> <span class="ruby-operator">||</span> <span class="ruby-string">'000000'</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-font_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">font_name</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="font_name-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 187</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">font_name</span>()
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">get_name</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-font_size" class="method-detail ">
<div class="method-heading">
<span class="method-name">font_size</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="font_size-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 192</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">font_size</span>()
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">get_size</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-font_switch" class="method-detail ">
<div class="method-heading">
<span class="method-name">font_switch</span><span
class="method-args">(change_type, arg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Performs correct modification based on what type of change_type is
specified</p>
<div class="method-source-code" id="font_switch-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 265</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">font_switch</span>(<span class="ruby-identifier">change_type</span>, <span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">change_type</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">NAME</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">change_font_name</span>(<span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">SIZE</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">change_font_size</span>(<span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">COLOR</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">change_font_color</span>(<span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">ITALICS</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">change_font_italics</span>(<span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">BOLD</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">change_font_bold</span>(<span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">UNDERLINE</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">change_font_underline</span>(<span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Worksheet</span><span class="ruby-operator">::</span><span class="ruby-constant">STRIKETHROUGH</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">change_font_strikethrough</span>(<span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">else</span> <span class="ruby-identifier">raise</span> <span class="ruby-string">'Invalid change_type'</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-horizontal_alignment" class="method-detail ">
<div class="method-heading">
<span class="method-name">horizontal_alignment</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns cell's horizontal alignment</p>
<div class="method-source-code" id="horizontal_alignment-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 209</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">horizontal_alignment</span>()
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">xf_obj</span> = <span class="ruby-identifier">get_cell_xf</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">horizontal</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-inspect" class="method-detail ">
<div class="method-heading">
<span class="method-name">inspect</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="inspect-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 257</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">inspect</span>
<span class="ruby-identifier">str</span> = <span class="ruby-node">"#<#{self.class}(#{row},#{column}): #{raw_value.inspect}"</span>
<span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-node">" =#{self.formula.expression}"</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">formula</span>
<span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-node">", datatype = #{self.datatype}, style_index = #{self.style_index}>"</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">str</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-is_bolded" class="method-detail ">
<div class="method-heading">
<span class="method-name">is_bolded</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns if font is bolded</p>
<div class="method-source-code" id="is_bolded-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 172</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_bolded</span>()
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">is_bold</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-is_italicized" class="method-detail ">
<div class="method-heading">
<span class="method-name">is_italicized</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns if font is italicized</p>
<div class="method-source-code" id="is_italicized-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 166</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_italicized</span>()
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">is_italic</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-is_struckthrough" class="method-detail ">
<div class="method-heading">
<span class="method-name">is_struckthrough</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="is_struckthrough-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 182</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_struckthrough</span>()
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">is_strikethrough</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-is_underlined" class="method-detail ">
<div class="method-heading">
<span class="method-name">is_underlined</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="is_underlined-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 177</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_underlined</span>()
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">get_cell_font</span>.<span class="ruby-identifier">is_underlined</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-text_wrap" class="method-detail ">
<div class="method-heading">
<span class="method-name">text_wrap</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns cell's wrap</p>
<div class="method-source-code" id="text_wrap-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 225</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">text_wrap</span>()
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">xf_obj</span> = <span class="ruby-identifier">get_cell_xf</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">wrap_text</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-vertical_alignment" class="method-detail ">
<div class="method-heading">
<span class="method-name">vertical_alignment</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns cell's vertical alignment</p>
<div class="method-source-code" id="vertical_alignment-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 217</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">vertical_alignment</span>()
<span class="ruby-identifier">validate_worksheet</span>
<span class="ruby-identifier">xf_obj</span> = <span class="ruby-identifier">get_cell_xf</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">xf_obj</span>.<span class="ruby-identifier">alignment</span>.<span class="ruby-identifier">vertical</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-workbook" class="method-detail ">
<div class="method-heading">
<span class="method-name">workbook</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="workbook-source">
<pre><span class="ruby-comment"># File lib/rubyXL/cell.rb, line 17</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">workbook</span>
<span class="ruby-ivar">@worksheet</span>.<span class="ruby-identifier">workbook</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>.
</footer>