123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549 |
- <!DOCTYPE html>
- <!--[if IE]><![endif]-->
- <html>
-
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
- <title>Class Dim
- </title>
- <meta name="viewport" content="width=device-width">
- <meta name="title" content="Class Dim
- ">
- <meta name="generator" content="docfx 2.54.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="../../toc.html">
- <meta property="docfx:tocrel" content="toc.html">
-
- <meta property="docfx:rel" content="../../">
-
- </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="../../images/logo48.png" 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 class="container body-content">
-
- <div id="search-results">
- <div class="search-list"></div>
- <div class="sr-items">
- <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
- </div>
- <ul id="pagination"></ul>
- </div>
- </div>
- <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.Dim">
-
-
- <h1 id="Terminal_Gui_Dim" data-uid="Terminal.Gui.Dim" class="text-break">Class Dim
- </h1>
- <div class="markdown level0 summary">
- Dim properties of a <a class="xref" href="Terminal.Gui.View.html">View</a> to control the position.
- </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">Dim</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>
- <span class="xref">System.Object.ToString()</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_Dim_syntax">Syntax</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public class Dim</code></pre>
- </div>
- <h5 id="Terminal_Gui_Dim_remarks"><strong>Remarks</strong></h5>
- <div class="markdown level0 remarks">
- <p>
- Use the Dim objects on the Width or Height properties of a <a class="xref" href="Terminal.Gui.View.html">View</a> 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 <a class="xref" href="Terminal.Gui.View.html">View</a> 3 characters to the left after centering for example.
- </p>
- </div>
- <h3 id="methods">Methods
- </h3>
-
-
- <a id="Terminal_Gui_Dim_Fill_" data-uid="Terminal.Gui.Dim.Fill*"></a>
- <h4 id="Terminal_Gui_Dim_Fill_System_Int32_" data-uid="Terminal.Gui.Dim.Fill(System.Int32)">Fill(Int32)</h4>
- <div class="markdown level1 summary">
- Initializes a new instance of the <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> class that fills the dimension, but leaves the specified number of colums for a margin.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public static Dim Fill(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>Margin to use.</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.Dim.html">Dim</a></td>
- <td>The Fill dimension.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_Dim_Height_" data-uid="Terminal.Gui.Dim.Height*"></a>
- <h4 id="Terminal_Gui_Dim_Height_Terminal_Gui_View_" data-uid="Terminal.Gui.Dim.Height(Terminal.Gui.View)">Height(View)</h4>
- <div class="markdown level1 summary">
- Returns a <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> object tracks the Height of the specified <a class="xref" href="Terminal.Gui.View.html">View</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public static Dim Height(View view)</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.View.html">View</a></td>
- <td><span class="parametername">view</span></td>
- <td>The view that will be tracked.</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.Dim.html">Dim</a></td>
- <td>The <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> of the other <a class="xref" href="Terminal.Gui.View.html">View</a>.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_Dim_Percent_" data-uid="Terminal.Gui.Dim.Percent*"></a>
- <h4 id="Terminal_Gui_Dim_Percent_System_Single_" data-uid="Terminal.Gui.Dim.Percent(System.Single)">Percent(Single)</h4>
- <div class="markdown level1 summary">
- Creates a percentage <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> object
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public static Dim 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>A value between 0 and 100 representing the percentage.</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.Dim.html">Dim</a></td>
- <td>The percent <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> object.</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_Dim_Percent_System_Single__examples">Examples</h5>
-
- This initializes a <a class="xref" href="Terminal.Gui.TextField.html">TextField</a>that is centered horizontally, is 50% of the way down,
- is 30% the height, and is 80% the width of the <a class="xref" href="Terminal.Gui.View.html">View</a> it added to.
- <pre><code>var textView = new TextView () {
- X = Pos.Center (),
- Y = Pos.Percent (50),
- Width = Dim.Percent (80),
- Height = Dim.Percent (30),
- };</code></pre>
-
-
- <a id="Terminal_Gui_Dim_Sized_" data-uid="Terminal.Gui.Dim.Sized*"></a>
- <h4 id="Terminal_Gui_Dim_Sized_System_Int32_" data-uid="Terminal.Gui.Dim.Sized(System.Int32)">Sized(Int32)</h4>
- <div class="markdown level1 summary">
- Creates an Absolute <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> from the specified integer value.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public static Dim Sized(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>The value to convert to the <a class="xref" href="Terminal.Gui.Dim.html">Dim</a>.</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.Dim.html">Dim</a></td>
- <td>The Absolute <a class="xref" href="Terminal.Gui.Dim.html">Dim</a>.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_Dim_Width_" data-uid="Terminal.Gui.Dim.Width*"></a>
- <h4 id="Terminal_Gui_Dim_Width_Terminal_Gui_View_" data-uid="Terminal.Gui.Dim.Width(Terminal.Gui.View)">Width(View)</h4>
- <div class="markdown level1 summary">
- Returns a <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> object tracks the Width of the specified <a class="xref" href="Terminal.Gui.View.html">View</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public static Dim Width(View view)</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.View.html">View</a></td>
- <td><span class="parametername">view</span></td>
- <td>The view that will be tracked.</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.Dim.html">Dim</a></td>
- <td>The <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> of the other <a class="xref" href="Terminal.Gui.View.html">View</a>.</td>
- </tr>
- </tbody>
- </table>
- <h3 id="operators">Operators
- </h3>
-
-
- <a id="Terminal_Gui_Dim_op_Addition_" data-uid="Terminal.Gui.Dim.op_Addition*"></a>
- <h4 id="Terminal_Gui_Dim_op_Addition_Terminal_Gui_Dim_Terminal_Gui_Dim_" data-uid="Terminal.Gui.Dim.op_Addition(Terminal.Gui.Dim,Terminal.Gui.Dim)">Addition(Dim, Dim)</h4>
- <div class="markdown level1 summary">
- Adds a <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> to a <a class="xref" href="Terminal.Gui.Dim.html">Dim</a>, yielding a new <a class="xref" href="Terminal.Gui.Dim.html">Dim</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public static Dim operator +(Dim left, Dim 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.Dim.html">Dim</a></td>
- <td><span class="parametername">left</span></td>
- <td>The first <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> to add.</td>
- </tr>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Dim.html">Dim</a></td>
- <td><span class="parametername">right</span></td>
- <td>The second <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> to add.</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.Dim.html">Dim</a></td>
- <td>The <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> that is the sum of the values of <code>left</code> and <code>right</code>.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_Dim_op_Implicit_" data-uid="Terminal.Gui.Dim.op_Implicit*"></a>
- <h4 id="Terminal_Gui_Dim_op_Implicit_System_Int32__Terminal_Gui_Dim" data-uid="Terminal.Gui.Dim.op_Implicit(System.Int32)~Terminal.Gui.Dim">Implicit(Int32 to Dim)</h4>
- <div class="markdown level1 summary">
- Creates an Absolute <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> from the specified integer value.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public static implicit operator Dim(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>The value to convert to the pos.</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.Dim.html">Dim</a></td>
- <td>The Absolute <a class="xref" href="Terminal.Gui.Dim.html">Dim</a>.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_Dim_op_Subtraction_" data-uid="Terminal.Gui.Dim.op_Subtraction*"></a>
- <h4 id="Terminal_Gui_Dim_op_Subtraction_Terminal_Gui_Dim_Terminal_Gui_Dim_" data-uid="Terminal.Gui.Dim.op_Subtraction(Terminal.Gui.Dim,Terminal.Gui.Dim)">Subtraction(Dim, Dim)</h4>
- <div class="markdown level1 summary">
- Subtracts a <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> from a <a class="xref" href="Terminal.Gui.Dim.html">Dim</a>, yielding a new <a class="xref" href="Terminal.Gui.Dim.html">Dim</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public static Dim operator -(Dim left, Dim 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.Dim.html">Dim</a></td>
- <td><span class="parametername">left</span></td>
- <td>The <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> to subtract from (the minuend).</td>
- </tr>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Dim.html">Dim</a></td>
- <td><span class="parametername">right</span></td>
- <td>The <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> to subtract (the subtrahend).</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.Dim.html">Dim</a></td>
- <td>The <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> that is the <code>left</code> minus <code>right</code>.</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>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>
|