mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
766 lines
39 KiB
HTML
766 lines
39 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>Class IndentedStringBuilder
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class IndentedStringBuilder
|
|
">
|
|
<meta name="generator" content="docfx 2.59.4.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.InteropGenerator.IndentedStringBuilder">
|
|
|
|
|
|
<h1 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder" class="text-break">Class IndentedStringBuilder
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>
|
|
A thin wrapper over <span class="xref">System.Text.StringBuilder</span> that adds indentation to each line built.
|
|
</p>
|
|
<p>
|
|
This type is typically used by database providers (and other extensions). It is generally
|
|
not used in application code.
|
|
</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">IndentedStringBuilder</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</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.InteropGenerator.html">FFXIVClientStructs.InteropGenerator</a></h6>
|
|
<h6><strong>Assembly</strong>: FFXIVClientStructs.InteropSourceGenerators.dll</h6>
|
|
<h5 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class IndentedStringBuilder</code></pre>
|
|
</div>
|
|
<h5 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_remarks"><strong>Remarks</strong></h5>
|
|
<div class="markdown level0 remarks"><p>See <a href="https://aka.ms/efcore-docs-providers">Implementation of database providers and extensions</a>
|
|
for more information and examples.</p>
|
|
</div>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_IndentCount.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.IndentCount%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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L38">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_IndentCount_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.IndentCount*"></a>
|
|
<h4 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_IndentCount" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.IndentCount">IndentCount</h4>
|
|
<div class="markdown level1 summary"><p>Gets the current indent level.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual int IndentCount { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><p>The current indent level.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Length.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Length%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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L44">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Length_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Length*"></a>
|
|
<h4 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Length" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Length">Length</h4>
|
|
<div class="markdown level1 summary"><p>The current length of the built string.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual int Length { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Append_System_Char_.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Append(System.Char)%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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L66">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Append_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Append*"></a>
|
|
<h4 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Append_System_Char_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Append(System.Char)">Append(Char)</h4>
|
|
<div class="markdown level1 summary"><p>Appends the current indent and then the given char to the string being built.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual IndentedStringBuilder Append(char value)</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.Char</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The char to append.</p>
|
|
</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.InteropGenerator.IndentedStringBuilder.html">IndentedStringBuilder</a></td>
|
|
<td><p>This builder so that additional calls can be chained.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Append_System_Collections_Generic_IEnumerable_System_Char__.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Append(System.Collections.Generic.IEnumerable%7BSystem.Char%7D)%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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L97">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Append_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Append*"></a>
|
|
<h4 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Append_System_Collections_Generic_IEnumerable_System_Char__" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Append(System.Collections.Generic.IEnumerable{System.Char})">Append(IEnumerable<Char>)</h4>
|
|
<div class="markdown level1 summary"><p>Appends the current indent and then the given chars to the string being built.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual IndentedStringBuilder Append(IEnumerable<char> value)</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.Collections.Generic.IEnumerable</span><<span class="xref">System.Char</span>></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The chars to append.</p>
|
|
</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.InteropGenerator.IndentedStringBuilder.html">IndentedStringBuilder</a></td>
|
|
<td><p>This builder so that additional calls can be chained.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Append_System_Collections_Generic_IEnumerable_System_String__.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Append(System.Collections.Generic.IEnumerable%7BSystem.String%7D)%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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L80">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Append_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Append*"></a>
|
|
<h4 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Append_System_Collections_Generic_IEnumerable_System_String__" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Append(System.Collections.Generic.IEnumerable{System.String})">Append(IEnumerable<String>)</h4>
|
|
<div class="markdown level1 summary"><p>Appends the current indent and then the given strings to the string being built.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual IndentedStringBuilder Append(IEnumerable<string> value)</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.Collections.Generic.IEnumerable</span><<span class="xref">System.String</span>></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The strings to append.</p>
|
|
</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.InteropGenerator.IndentedStringBuilder.html">IndentedStringBuilder</a></td>
|
|
<td><p>This builder so that additional calls can be chained.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Append_System_String_.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Append(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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L52">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Append_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Append*"></a>
|
|
<h4 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Append_System_String_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Append(System.String)">Append(String)</h4>
|
|
<div class="markdown level1 summary"><p>Appends the current indent and then the given string to the string being built.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual IndentedStringBuilder Append(string value)</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">value</span></td>
|
|
<td><p>The string to append.</p>
|
|
</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.InteropGenerator.IndentedStringBuilder.html">IndentedStringBuilder</a></td>
|
|
<td><p>This builder so that additional calls can be chained.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_AppendLine.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.AppendLine%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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L113">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_AppendLine_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.AppendLine*"></a>
|
|
<h4 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_AppendLine" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.AppendLine">AppendLine()</h4>
|
|
<div class="markdown level1 summary"><p>Appends a new line to the string being built.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual IndentedStringBuilder AppendLine()</code></pre>
|
|
</div>
|
|
<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.InteropGenerator.IndentedStringBuilder.html">IndentedStringBuilder</a></td>
|
|
<td><p>This builder so that additional calls can be chained.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_AppendLine_System_String_.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.AppendLine(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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L128">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_AppendLine_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.AppendLine*"></a>
|
|
<h4 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_AppendLine_System_String_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.AppendLine(System.String)">AppendLine(String)</h4>
|
|
<div class="markdown level1 summary"><p>Appends the current indent, the given string, and a new line to the string being built.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual IndentedStringBuilder AppendLine(string value)</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">value</span></td>
|
|
<td><p>The string to append.</p>
|
|
</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.InteropGenerator.IndentedStringBuilder.html">IndentedStringBuilder</a></td>
|
|
<td><p>This builder so that additional calls can be chained.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_AppendLine_System_String__remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>If the given string itself contains a new line, the part of the string after that new line will not be indented.</p>
|
|
</div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_AppendLines_System_String_System_Boolean_.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.AppendLines(System.String%2CSystem.Boolean)%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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L149">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_AppendLines_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.AppendLines*"></a>
|
|
<h4 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_AppendLines_System_String_System_Boolean_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.AppendLines(System.String,System.Boolean)">AppendLines(String, Boolean)</h4>
|
|
<div class="markdown level1 summary"><p>Separates the given string into lines, and then appends each line, prefixed
|
|
by the current indent and followed by a new line, to the string being built.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual IndentedStringBuilder AppendLines(string value, bool skipFinalNewline = false)</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">value</span></td>
|
|
<td><p>The string to append.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">skipFinalNewline</span></td>
|
|
<td><p>If <span class="xref">true</span>, then the terminating new line is not added after the last line.</p>
|
|
</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.InteropGenerator.IndentedStringBuilder.html">IndentedStringBuilder</a></td>
|
|
<td><p>This builder so that additional calls can be chained.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Clear.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Clear%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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L185">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Clear_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Clear*"></a>
|
|
<h4 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Clear" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Clear">Clear()</h4>
|
|
<div class="markdown level1 summary"><p>Resets this builder ready to build a new string.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual IndentedStringBuilder Clear()</code></pre>
|
|
</div>
|
|
<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.InteropGenerator.IndentedStringBuilder.html">IndentedStringBuilder</a></td>
|
|
<td><p>This builder so that additional calls can be chained.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_DecrementIndent.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.DecrementIndent%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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L208">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_DecrementIndent_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.DecrementIndent*"></a>
|
|
<h4 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_DecrementIndent" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.DecrementIndent">DecrementIndent()</h4>
|
|
<div class="markdown level1 summary"><p>Decrements the indent.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual IndentedStringBuilder DecrementIndent()</code></pre>
|
|
</div>
|
|
<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.InteropGenerator.IndentedStringBuilder.html">IndentedStringBuilder</a></td>
|
|
<td><p>This builder so that additional calls can be chained.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_IncrementIndent.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.IncrementIndent%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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L197">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_IncrementIndent_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.IncrementIndent*"></a>
|
|
<h4 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_IncrementIndent" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.IncrementIndent">IncrementIndent()</h4>
|
|
<div class="markdown level1 summary"><p>Increments the indent.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual IndentedStringBuilder IncrementIndent()</code></pre>
|
|
</div>
|
|
<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.InteropGenerator.IndentedStringBuilder.html">IndentedStringBuilder</a></td>
|
|
<td><p>This builder so that additional calls can be chained.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Indent.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Indent%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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L222">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Indent_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Indent*"></a>
|
|
<h4 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_Indent" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.Indent">Indent()</h4>
|
|
<div class="markdown level1 summary"><p>Creates a scoped indenter that will increment the indent, then decrement it when disposed.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual IDisposable Indent()</code></pre>
|
|
</div>
|
|
<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><span class="xref">System.IDisposable</span></td>
|
|
<td><p>An indenter.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_SuspendIndent.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.SuspendIndent%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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L229">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_SuspendIndent_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.SuspendIndent*"></a>
|
|
<h4 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_SuspendIndent" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.SuspendIndent">SuspendIndent()</h4>
|
|
<div class="markdown level1 summary"><p>Temporarily disables all indentation. Restores the original indentation when the returned object is disposed.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual IDisposable SuspendIndent()</code></pre>
|
|
</div>
|
|
<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><span class="xref">System.IDisposable</span></td>
|
|
<td><p>An object that restores the original indentation when disposed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_ToString.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.ToString%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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L236">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_ToString_" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.ToString*"></a>
|
|
<h4 id="FFXIVClientStructs_InteropGenerator_IndentedStringBuilder_ToString" data-uid="FFXIVClientStructs.InteropGenerator.IndentedStringBuilder.ToString">ToString()</h4>
|
|
<div class="markdown level1 summary"><p>Returns the built string.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
|
|
</div>
|
|
<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><span class="xref">System.String</span></td>
|
|
<td><p>The built string.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><span class="xref">System.Object.ToString()</span></div>
|
|
</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/main/apiSpec/new?filename=FFXIVClientStructs_InteropGenerator_IndentedStringBuilder.md&value=---%0Auid%3A%20FFXIVClientStructs.InteropGenerator.IndentedStringBuilder%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/main/FFXIVClientStructs.InteropSourceGenerators/IndentedStringBuilder.cs/#L26" 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>
|