Dalamud/docs/api/FFXIVClientStructs.FFXIV.Component.Excel.ExcelModule.html
2022-01-29 05:15:26 +01:00

288 lines
13 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Struct ExcelModule
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Struct ExcelModule
">
<meta name="generator" content="docfx 2.59.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="FFXIVClientStructs.FFXIV.Component.Excel.ExcelModule">
<h1 id="FFXIVClientStructs_FFXIV_Component_Excel_ExcelModule" data-uid="FFXIVClientStructs.FFXIV.Component.Excel.ExcelModule" class="text-break">Struct ExcelModule
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.ValueType.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.ValueType.GetHashCode()</span>
</div>
<div>
<span class="xref">System.ValueType.ToString()</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="FFXIVClientStructs.FFXIV.Component.Excel.html">FFXIVClientStructs.FFXIV.Component.Excel</a></h6>
<h6><strong>Assembly</strong>: FFXIVClientStructs.dll</h6>
<h5 id="FFXIVClientStructs_FFXIV_Component_Excel_ExcelModule_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public struct ExcelModule</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/goat_unbreaks_the_abi/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Component_Excel_ExcelModule_GetSheetByIndex_System_UInt32_.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Component.Excel.ExcelModule.GetSheetByIndex(System.UInt32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/FFXIVClientStructs/blob/goat_unbreaks_the_abi/FFXIVClientStructs/FFXIV/Component/Excel/ExcelModule.cs/#L7">View Source</a>
</span>
<a id="FFXIVClientStructs_FFXIV_Component_Excel_ExcelModule_GetSheetByIndex_" data-uid="FFXIVClientStructs.FFXIV.Component.Excel.ExcelModule.GetSheetByIndex*"></a>
<h4 id="FFXIVClientStructs_FFXIV_Component_Excel_ExcelModule_GetSheetByIndex_System_UInt32_" data-uid="FFXIVClientStructs.FFXIV.Component.Excel.ExcelModule.GetSheetByIndex(System.UInt32)">GetSheetByIndex(UInt32)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[VirtualFunction(1)]
public ExcelSheet*GetSheetByIndex(uint sheetIndex)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">sheetIndex</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="FFXIVClientStructs.FFXIV.Component.Excel.ExcelSheet.html">ExcelSheet</a>*</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/goat_unbreaks_the_abi/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Component_Excel_ExcelModule_GetSheetByName_System_String_.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Component.Excel.ExcelModule.GetSheetByName(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/FFXIVClientStructs/blob/goat_unbreaks_the_abi/FFXIVClientStructs/FFXIV/Component/Excel/ExcelModule.cs/#L10">View Source</a>
</span>
<a id="FFXIVClientStructs_FFXIV_Component_Excel_ExcelModule_GetSheetByName_" data-uid="FFXIVClientStructs.FFXIV.Component.Excel.ExcelModule.GetSheetByName*"></a>
<h4 id="FFXIVClientStructs_FFXIV_Component_Excel_ExcelModule_GetSheetByName_System_String_" data-uid="FFXIVClientStructs.FFXIV.Component.Excel.ExcelModule.GetSheetByName(System.String)">GetSheetByName(String)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[VirtualFunction(2)]
public ExcelSheet*GetSheetByName(string sheetName)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">sheetName</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="FFXIVClientStructs.FFXIV.Component.Excel.ExcelSheet.html">ExcelSheet</a>*</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/goat_unbreaks_the_abi/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Component_Excel_ExcelModule_LoadSheet_System_String_System_Byte_System_Byte_.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Component.Excel.ExcelModule.LoadSheet(System.String%2CSystem.Byte%2CSystem.Byte)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/FFXIVClientStructs/blob/goat_unbreaks_the_abi/FFXIVClientStructs/FFXIV/Component/Excel/ExcelModule.cs/#L13">View Source</a>
</span>
<a id="FFXIVClientStructs_FFXIV_Component_Excel_ExcelModule_LoadSheet_" data-uid="FFXIVClientStructs.FFXIV.Component.Excel.ExcelModule.LoadSheet*"></a>
<h4 id="FFXIVClientStructs_FFXIV_Component_Excel_ExcelModule_LoadSheet_System_String_System_Byte_System_Byte_" data-uid="FFXIVClientStructs.FFXIV.Component.Excel.ExcelModule.LoadSheet(System.String,System.Byte,System.Byte)">LoadSheet(String, Byte, Byte)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[VirtualFunction(3)]
public void LoadSheet(string sheetName, byte a3 = 0, byte a4 = 0)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">sheetName</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Byte</span></td>
<td><span class="parametername">a3</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Byte</span></td>
<td><span class="parametername">a4</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/goat_unbreaks_the_abi/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Component_Excel_ExcelModule.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Component.Excel.ExcelModule%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/goatcorp/FFXIVClientStructs/blob/goat_unbreaks_the_abi/FFXIVClientStructs/FFXIV/Component/Excel/ExcelModule.cs/#L5" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>