-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathOPY_CLASS_Column-GetSubFormat.html
More file actions
31 lines (28 loc) · 3.4 KB
/
OPY_CLASS_Column-GetSubFormat.html
File metadata and controls
31 lines (28 loc) · 3.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<h1 class="firstHeading">8.1.2.16 Column::GetSubFormat</h1><table class="noborder"><tr>
<td style="vertical-align:top" width="60"><img src="../images/OPY_CLASS_Column-GetSubFormat/Tip_icon.png?v=21427" width="57" border="0" /></td><td><h3><a name="It_is_recommended_that_you_switch_to_the_originpro_package._PyOrigin_is_primarily_for_users_who_need_to_work_with_Origin_version_prior_to_2021."></a><span class="mw-headline"><span style="color: red">It is recommended that you switch to the <a href="../../Python/Python/RunPython_(Python).html" title="Python:RunPython (Python)">originpro</a> package. PyOrigin is primarily for users who need to work with Origin version prior to 2021.</span></span></h3>
</td></tr></table>
<p><br />
</p>
<div id="toc" class="toc"><div id="toctitle"><h2>Contents</h2></div>
<ul>
<li class="toclevel-1 tocsection-1"><a href="#Description"><span class="tocnumber">1</span> <span class="toctext">Description</span></a></li>
<li class="toclevel-1 tocsection-2"><a href="#Syntax"><span class="tocnumber">2</span> <span class="toctext">Syntax</span></a></li>
<li class="toclevel-1 tocsection-3"><a href="#Parameters"><span class="tocnumber">3</span> <span class="toctext">Parameters</span></a></li>
<li class="toclevel-1 tocsection-4"><a href="#Return"><span class="tocnumber">4</span> <span class="toctext">Return</span></a></li>
<li class="toclevel-1 tocsection-5"><a href="#Examples"><span class="tocnumber">5</span> <span class="toctext">Examples</span></a></li>
</ul>
</div>
<h2><a name="Description"></a><span class="mw-headline">Description</span></h2>
<p>Get the SubFormat used by a column.
</p>
<h2><a name="Syntax"></a><span class="mw-headline">Syntax</span></h2>
<pre class="python" style="font-family:monospace;">GetSubFormat<span style="color: #000;">(</span><span style="color: #000;">)</span></pre>
<h2><a name="Parameters"></a><span class="mw-headline">Parameters</span></h2>
<h2><a name="Return"></a><span class="mw-headline">Return</span></h2>
<p>The subformat as an integer enumerated from 0
</p>
<h2><a name="Examples"></a><span class="mw-headline">Examples</span></h2>
<pre class="python" style="font-family:monospace;"><span style="color: #ff7700;font-weight:bold;">import</span> PyOrigin
PyOrigin.<span style="color: #000;">FindWorksheet</span><span style="color: #000;">(</span><span style="color: #0a0;">'[Book1]Sheet1'</span><span style="color: #000;">)</span>.<span style="color: #000;">Columns</span><span style="color: #000;">(</span><span style="color: #000;">0</span><span style="color: #000;">)</span>.<span style="color: #000;">SetFormat</span><span style="color: #000;">(</span><span style="color: #000;">2</span><span style="color: #000;">)</span>
SubFmt<span style="color: #000;">=</span>PyOrigin.<span style="color: #000;">FindWorksheet</span><span style="color: #000;">(</span><span style="color: #0a0;">'[Book1]Sheet1'</span><span style="color: #000;">)</span>.<span style="color: #000;">Columns</span><span style="color: #000;">(</span><span style="color: #000;">0</span><span style="color: #000;">)</span>.<span style="color: #000;">GetSubFormat</span><span style="color: #000;">(</span><span style="color: #000;">)</span>
<span style="color: #ff7700;font-weight:bold;">print</span><span style="color: #000;">(</span><span style="color: #0a0;">'The subformat number is %d'</span> % SubFmt<span style="color: #000;">)</span></pre>