mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-27 00:07:58 +01:00
420 lines
16 KiB
HTML
420 lines
16 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 Pos
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class Pos
|
|
">
|
|
<meta name="generator" content="docfx 2.18.2.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">
|
|
<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="Terminal.Gui.Pos">
|
|
|
|
|
|
<h1 id="Terminal_Gui_Pos" data-uid="Terminal.Gui.Pos">Class Pos
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Describes a position which can be an absolute value, a percentage, centered, or
|
|
relative to the ending dimension. Integer values are implicitly convertible to
|
|
an absolute Pos. These objects are created using the static methods Percent,
|
|
AnchorEnd and Center. The Pos objects can be combined with the addition and
|
|
subtraction operators.</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">Pos</span></div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.Gui.html">Terminal.Gui</a></h6>
|
|
<h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
|
|
<h5 id="Terminal_Gui_Pos_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class Pos</code></pre>
|
|
</div>
|
|
<h5 id="Terminal_Gui_Pos_remarks"><strong>Remarks</strong></h5>
|
|
<div class="markdown level0 remarks"><p>
|
|
Use the Pos objects on the X or Y properties of a view to control the position.
|
|
</p>
|
|
<p>
|
|
These can be used to set the absolute position, when merely assigning an
|
|
integer value (via the implicit integer to Pos conversion), and they can be combined
|
|
to produce more useful layouts, like: Pos.Center - 3, which would shift the postion
|
|
of the view 3 characters to the left after centering for example.
|
|
</p></div>
|
|
<h3 id="constructors">Constructors
|
|
</h3>
|
|
|
|
|
|
<a id="Terminal_Gui_Pos__ctor_" data-uid="Terminal.Gui.Pos.#ctor*"></a>
|
|
<h4 id="Terminal_Gui_Pos__ctor" data-uid="Terminal.Gui.Pos.#ctor">Pos()</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">public Pos ();</code></pre>
|
|
</div>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
|
|
|
|
<a id="Terminal_Gui_Pos_AnchorEnd_" data-uid="Terminal.Gui.Pos.AnchorEnd*"></a>
|
|
<h4 id="Terminal_Gui_Pos_AnchorEnd_System_Int32_" data-uid="Terminal.Gui.Pos.AnchorEnd(System.Int32)">AnchorEnd(Int32)</h4>
|
|
<div class="markdown level1 summary"><p>Creates a Pos object that is anchored to the end of the dimension, useful to flush
|
|
the layout from the end.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Terminal.Gui.Pos AnchorEnd (int margin = 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.Int32</span></td>
|
|
<td><span class="parametername">margin</span></td>
|
|
<td><p>Optional margin to set aside.</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="Terminal.Gui.Pos.html">Pos</a></td>
|
|
<td><p>The Pos object anchored to the end (the bottom or the right side).</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_Gui_Pos_Center_" data-uid="Terminal.Gui.Pos.Center*"></a>
|
|
<h4 id="Terminal_Gui_Pos_Center" data-uid="Terminal.Gui.Pos.Center">Center()</h4>
|
|
<div class="markdown level1 summary"><p>Returns a Pos object that can be used to center the views.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Terminal.Gui.Pos Center ();</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="Terminal.Gui.Pos.html">Pos</a></td>
|
|
<td><p>The center Pos.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_Gui_Pos_Percent_" data-uid="Terminal.Gui.Pos.Percent*"></a>
|
|
<h4 id="Terminal_Gui_Pos_Percent_System_Single_" data-uid="Terminal.Gui.Pos.Percent(System.Single)">Percent(Single)</h4>
|
|
<div class="markdown level1 summary"><p>Creates a percentage Pos object</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Terminal.Gui.Pos Percent (float n);</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.Single</span></td>
|
|
<td><span class="parametername">n</span></td>
|
|
<td><p>A value between 0 and 100 representing the percentage.</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="Terminal.Gui.Pos.html">Pos</a></td>
|
|
<td><p>The percent Pos object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="operators">Operators
|
|
</h3>
|
|
|
|
|
|
<a id="Terminal_Gui_Pos_op_Addition_" data-uid="Terminal.Gui.Pos.op_Addition*"></a>
|
|
<h4 id="Terminal_Gui_Pos_op_Addition_Terminal_Gui_Pos_Terminal_Gui_Pos_" data-uid="Terminal.Gui.Pos.op_Addition(Terminal.Gui.Pos,Terminal.Gui.Pos)">op_Addition(Pos, Pos)</h4>
|
|
<div class="markdown level1 summary"><p>Adds a <a class="xref" href="Terminal.Gui.Pos.html">Pos</a> to a <a class="xref" href="Terminal.Gui.Pos.html">Pos</a>, yielding a new <a class="xref" href="Terminal.Gui.Pos.html">Pos</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Terminal.Gui.Pos op_Addition (Terminal.Gui.Pos left, Terminal.Gui.Pos right);</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><a class="xref" href="Terminal.Gui.Pos.html">Pos</a></td>
|
|
<td><span class="parametername">left</span></td>
|
|
<td><p>The first <a class="xref" href="Terminal.Gui.Pos.html">Pos</a> to add.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.Gui.Pos.html">Pos</a></td>
|
|
<td><span class="parametername">right</span></td>
|
|
<td><p>The second <a class="xref" href="Terminal.Gui.Pos.html">Pos</a> to add.</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="Terminal.Gui.Pos.html">Pos</a></td>
|
|
<td><p>The <a class="xref" href="Terminal.Gui.Pos.html">Pos</a> that is the sum of the values of <code>left</code> and <code>right</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_Gui_Pos_op_Implicit_" data-uid="Terminal.Gui.Pos.op_Implicit*"></a>
|
|
<h4 id="Terminal_Gui_Pos_op_Implicit_System_Int32_to_Terminal_Gui_Pos_" data-uid="Terminal.Gui.Pos.op_Implicit(System.Int32 to Terminal.Gui.Pos)">op_Implicit(Int32 to Pos)</h4>
|
|
<div class="markdown level1 summary"><p>Creates an Absolute Pos from the specified integer value.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Terminal.Gui.Pos op_Implicit (int n);</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.Int32</span></td>
|
|
<td><span class="parametername">n</span></td>
|
|
<td><p>The value to convert to the pos.</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="Terminal.Gui.Pos.html">Pos</a></td>
|
|
<td><p>The Absolute Pos.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_Gui_Pos_op_Subtraction_" data-uid="Terminal.Gui.Pos.op_Subtraction*"></a>
|
|
<h4 id="Terminal_Gui_Pos_op_Subtraction_Terminal_Gui_Pos_Terminal_Gui_Pos_" data-uid="Terminal.Gui.Pos.op_Subtraction(Terminal.Gui.Pos,Terminal.Gui.Pos)">op_Subtraction(Pos, Pos)</h4>
|
|
<div class="markdown level1 summary"><p>Subtracts a <a class="xref" href="Terminal.Gui.Pos.html">Pos</a> from a <a class="xref" href="Terminal.Gui.Pos.html">Pos</a>, yielding a new <a class="xref" href="Terminal.Gui.Pos.html">Pos</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Terminal.Gui.Pos op_Subtraction (Terminal.Gui.Pos left, Terminal.Gui.Pos right);</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><a class="xref" href="Terminal.Gui.Pos.html">Pos</a></td>
|
|
<td><span class="parametername">left</span></td>
|
|
<td><p>The <a class="xref" href="Terminal.Gui.Pos.html">Pos</a> to subtract from (the minuend).</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Terminal.Gui.Pos.html">Pos</a></td>
|
|
<td><span class="parametername">right</span></td>
|
|
<td><p>The <a class="xref" href="Terminal.Gui.Pos.html">Pos</a> to subtract (the subtrahend).</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="Terminal.Gui.Pos.html">Pos</a></td>
|
|
<td><p>The <a class="xref" href="Terminal.Gui.Pos.html">Pos</a> that is the <code>left</code> minus <code>right</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
|
</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>Copyright © 2015-2017 Microsoft<br>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>
|