wbComment

<p>R6 class for a Workbook Comments</p>
<p>R6 class for a Workbook Comments</p>

Simplifies the creation of 'xlsx' files by
providing a high level interface to writing, styling and editing
worksheets.

Jan Marvin Garbuszus

openxlsx2

Read, Write and Edit 'xlsx' Files

Jordan Mark Barbone

 openxlsx authors

Arseny Kapoulkine

wbComment function

<p><div class="r6-fields"></div></p><dl>
<dt><code>text</code></dt>
<dd><p>Comment text</p></dd><p></p><p>
<dt><code>author</code></dt>
<dd><p>The comment author</p></dd></p><p>
<dt><code>style</code></dt>
<dd><p>A style for the comment</p></dd></p><p>
<dt><code>visible</code></dt>
<dd><p><code>logical</code>, if <code>FALSE</code> is not visible</p></dd></p><p>
<dt><code>width</code></dt>
<dd><p>Width of the comment in ... units</p></dd></p><p>
<dt><code>height</code></dt>
<dd><p>Height of comment in ... units</p></dd></p><p>
</p></dl><p></p>

Public fields


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/wbComment%24new()?package=openxlsx2&version=0.3.1" data-mini-rdoc="openxlsx2::wbComment$new()"><code>wbComment$new()</code></a></p></li>
<li><p><a href="/link/wbComment%24print()?package=openxlsx2&version=0.3.1" data-mini-rdoc="openxlsx2::wbComment$print()"><code>wbComment$print()</code></a></p></li>
<li><p><a href="/link/wbComment%24clone()?package=openxlsx2&version=0.3.1" data-mini-rdoc="openxlsx2::wbComment$clone()"><code>wbComment$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-wbComment-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Creates a new <code>wbComment</code> object</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>wbComment$new(text, author, style, visible = TRUE, width = 2, height = 4)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>text</code></dt>
<dd><p>Comment text</p></dd></dl></div></p><p>
<dt><code>author</code></dt>
<dd><p>The comment author</p></dd></p><p>
<dt><code>style</code></dt>
<dd><p>A style for the comment</p></dd></p><p>
<dt><code>visible</code></dt>
<dd><p><code>logical</code>, if <code>FALSE</code> is not visible</p></dd></p><p>
<dt><code>width</code></dt>
<dd><p>Width of the comment in ... units</p></dd></p><p>
<dt><code>height</code></dt>
<dd><p>Height of comment in ... units</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>a <code>wbComment</code> object</p>
</div><p></p><p></p><p><hr>
<a id="method-wbComment-print"></a></p><div class="section" id="method-print-">
<h3>Method <code><a href="/link/print()?package=openxlsx2&version=0.3.1" data-mini-rdoc="openxlsx2::print()">print()</a></code></h3>
<p>Prints the object</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>wbComment$print()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-wbComment-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>wbComment$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

R6 class for a Workbook Comments — wbComment

<p><div class="r6-fields"></p><dl>
<dt><code>text</code></dt>
<dd><p>Comment text</p></dd>


<dt><code>author</code></dt>
<dd><p>The comment author</p></dd>


<dt><code>style</code></dt>
<dd><p>A style for the comment</p></dd>


<dt><code>visible</code></dt>
<dd><p><code>logical</code>, if <code>FALSE</code> is not visible</p></dd>


<dt><code>width</code></dt>
<dd><p>Width of the comment in ... units</p></dd>


<dt><code>height</code></dt>
<dd><p>Height of comment in ... units</p></dd>


</dl><p></div></p>


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-wbComment-new'><code>wbComment$new()</code></a></p></li>
<li><p><a href='#method-wbComment-print'><code>wbComment$print()</code></a></p></li>
<li><p><a href='#method-wbComment-clone'><code>wbComment$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-wbComment-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Creates a new <code>wbComment</code> object</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>wbComment$new(text, author, style, visible = TRUE, width = 2, height = 4)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>text</code></dt>
<dd><p>Comment text</p></dd>


<dt><code>author</code></dt>
<dd><p>The comment author</p></dd>


<dt><code>style</code></dt>
<dd><p>A style for the comment</p></dd>


<dt><code>visible</code></dt>
<dd><p><code>logical</code>, if <code>FALSE</code> is not visible</p></dd>


<dt><code>width</code></dt>
<dd><p>Width of the comment in ... units</p></dd>


<dt><code>height</code></dt>
<dd><p>Height of comment in ... units</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>a <code>wbComment</code> object</p>
</div>

</div><p><hr>
<a id="method-wbComment-print"></a></p><div class='section' id='method-print-'>
<h3>Method <code><a href='https://rdrr.io/r/base/print.html'>print()</a></code></h3>
<p>Prints the object</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>wbComment$print()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-wbComment-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>wbComment$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


wbComment: R6 class for a Workbook Comments

Description

Arguments

Value

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Method `print()`

Usage

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Value

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Returns

Method print()

Usage

Method clone()

Usage

Arguments

Details

Method `new()`

Method `print()`

Method `clone()`