Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-27 16:27:55 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
bb6cd20b3b44248a248d0064a53c3d4ba6109fbc
Terminal.Gui/docs/api/Terminal.Gui/Terminal.Gui.Rect.html
Charlie Kindel 04ab5540bf final doc update
2020-05-27 19:30:45 -06:00

1427 lines
45 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Struct Rect
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Struct Rect
">
<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">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<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.Rect">
<h1 id="Terminal_Gui_Rect" data-uid="Terminal.Gui.Rect" class="text-break">Struct Rect
</h1>
<div class="markdown level0 summary">
Stores a set of four integers that represent the location and size of a rectangle
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<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="Terminal.Gui.html">Terminal.Gui</a></h6>
<h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
<h5 id="Terminal_Gui_Rect_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public struct Rect</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Terminal_Gui_Rect__ctor_" data-uid="Terminal.Gui.Rect.#ctor*"></a>
<h4 id="Terminal_Gui_Rect__ctor_System_Int32_System_Int32_System_Int32_System_Int32_" data-uid="Terminal.Gui.Rect.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">Rect(Int32, Int32, Int32, Int32)</h4>
<div class="markdown level1 summary">
Rectangle Constructor
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Rect(int x, int y, int width, int height)</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">x</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">y</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">width</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">height</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect__ctor_System_Int32_System_Int32_System_Int32_System_Int32__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Creates a Rectangle from a specified x,y location and
width and height values.
</div>
<a id="Terminal_Gui_Rect__ctor_" data-uid="Terminal.Gui.Rect.#ctor*"></a>
<h4 id="Terminal_Gui_Rect__ctor_Terminal_Gui_Point_Terminal_Gui_Size_" data-uid="Terminal.Gui.Rect.#ctor(Terminal.Gui.Point,Terminal.Gui.Size)">Rect(Point, Size)</h4>
<div class="markdown level1 summary">
Rectangle Constructor
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Rect(Point location, Size size)</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.Point.html">Point</a></td>
<td><span class="parametername">location</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Terminal.Gui.Size.html">Size</a></td>
<td><span class="parametername">size</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect__ctor_Terminal_Gui_Point_Terminal_Gui_Size__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Creates a Rectangle from Point and Size values.
</div>
<h3 id="fields">Fields
</h3>
<h4 id="Terminal_Gui_Rect_Empty" data-uid="Terminal.Gui.Rect.Empty">Empty</h4>
<div class="markdown level1 summary">
Empty Shared Field
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly Rect Empty</code></pre>
</div>
<h5 class="fieldValue">Field Value</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.Rect.html">Rect</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_Empty_remarks">Remarks</h5>
<div class="markdown level1 remarks">
An uninitialized Rectangle Structure.
</div>
<h4 id="Terminal_Gui_Rect_Height" data-uid="Terminal.Gui.Rect.Height">Height</h4>
<div class="markdown level1 summary">
Gets or sets the height of this Rectangle structure.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Height</code></pre>
</div>
<h5 class="fieldValue">Field 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>
<h4 id="Terminal_Gui_Rect_Width" data-uid="Terminal.Gui.Rect.Width">Width</h4>
<div class="markdown level1 summary">
Gets or sets the width of this Rect structure.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Width</code></pre>
</div>
<h5 class="fieldValue">Field 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>
<h4 id="Terminal_Gui_Rect_X" data-uid="Terminal.Gui.Rect.X">X</h4>
<div class="markdown level1 summary">
Gets or sets the x-coordinate of the upper-left corner of this Rectangle structure.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int X</code></pre>
</div>
<h5 class="fieldValue">Field 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>
<h4 id="Terminal_Gui_Rect_Y" data-uid="Terminal.Gui.Rect.Y">Y</h4>
<div class="markdown level1 summary">
Gets or sets the y-coordinate of the upper-left corner of this Rectangle structure.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Y</code></pre>
</div>
<h5 class="fieldValue">Field 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="properties">Properties
</h3>
<a id="Terminal_Gui_Rect_Bottom_" data-uid="Terminal.Gui.Rect.Bottom*"></a>
<h4 id="Terminal_Gui_Rect_Bottom" data-uid="Terminal.Gui.Rect.Bottom">Bottom</h4>
<div class="markdown level1 summary">
Bottom Property
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Bottom { 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>
<h5 id="Terminal_Gui_Rect_Bottom_remarks">Remarks</h5>
<div class="markdown level1 remarks">
The Y coordinate of the bottom edge of the Rectangle.
Read only.
</div>
<a id="Terminal_Gui_Rect_IsEmpty_" data-uid="Terminal.Gui.Rect.IsEmpty*"></a>
<h4 id="Terminal_Gui_Rect_IsEmpty" data-uid="Terminal.Gui.Rect.IsEmpty">IsEmpty</h4>
<div class="markdown level1 summary">
IsEmpty Property
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsEmpty { 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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_IsEmpty_remarks">Remarks</h5>
<div class="markdown level1 remarks">
Indicates if the width or height are zero. Read only.
</div>
<a id="Terminal_Gui_Rect_Left_" data-uid="Terminal.Gui.Rect.Left*"></a>
<h4 id="Terminal_Gui_Rect_Left" data-uid="Terminal.Gui.Rect.Left">Left</h4>
<div class="markdown level1 summary">
Left Property
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Left { 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>
<h5 id="Terminal_Gui_Rect_Left_remarks">Remarks</h5>
<div class="markdown level1 remarks">
The X coordinate of the left edge of the Rectangle.
Read only.
</div>
<a id="Terminal_Gui_Rect_Location_" data-uid="Terminal.Gui.Rect.Location*"></a>
<h4 id="Terminal_Gui_Rect_Location" data-uid="Terminal.Gui.Rect.Location">Location</h4>
<div class="markdown level1 summary">
Location Property
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Point Location { get; set; }</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><a class="xref" href="Terminal.Gui.Point.html">Point</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_Location_remarks">Remarks</h5>
<div class="markdown level1 remarks">
The Location of the top-left corner of the Rectangle.
</div>
<a id="Terminal_Gui_Rect_Right_" data-uid="Terminal.Gui.Rect.Right*"></a>
<h4 id="Terminal_Gui_Rect_Right" data-uid="Terminal.Gui.Rect.Right">Right</h4>
<div class="markdown level1 summary">
Right Property
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Right { 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>
<h5 id="Terminal_Gui_Rect_Right_remarks">Remarks</h5>
<div class="markdown level1 remarks">
The X coordinate of the right edge of the Rectangle.
Read only.
</div>
<a id="Terminal_Gui_Rect_Size_" data-uid="Terminal.Gui.Rect.Size*"></a>
<h4 id="Terminal_Gui_Rect_Size" data-uid="Terminal.Gui.Rect.Size">Size</h4>
<div class="markdown level1 summary">
Size Property
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Size Size { get; set; }</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><a class="xref" href="Terminal.Gui.Size.html">Size</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_Size_remarks">Remarks</h5>
<div class="markdown level1 remarks">
The Size of the Rectangle.
</div>
<a id="Terminal_Gui_Rect_Top_" data-uid="Terminal.Gui.Rect.Top*"></a>
<h4 id="Terminal_Gui_Rect_Top" data-uid="Terminal.Gui.Rect.Top">Top</h4>
<div class="markdown level1 summary">
Top Property
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Top { 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>
<h5 id="Terminal_Gui_Rect_Top_remarks">Remarks</h5>
<div class="markdown level1 remarks">
The Y coordinate of the top edge of the Rectangle.
Read only.
</div>
<h3 id="methods">Methods
</h3>
<a id="Terminal_Gui_Rect_Contains_" data-uid="Terminal.Gui.Rect.Contains*"></a>
<h4 id="Terminal_Gui_Rect_Contains_System_Int32_System_Int32_" data-uid="Terminal.Gui.Rect.Contains(System.Int32,System.Int32)">Contains(Int32, Int32)</h4>
<div class="markdown level1 summary">
Contains Method
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Contains(int x, int y)</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">x</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">y</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><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_Contains_System_Int32_System_Int32__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Checks if an x,y coordinate lies within this Rectangle.
</div>
<a id="Terminal_Gui_Rect_Contains_" data-uid="Terminal.Gui.Rect.Contains*"></a>
<h4 id="Terminal_Gui_Rect_Contains_Terminal_Gui_Point_" data-uid="Terminal.Gui.Rect.Contains(Terminal.Gui.Point)">Contains(Point)</h4>
<div class="markdown level1 summary">
Contains Method
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Contains(Point pt)</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.Point.html">Point</a></td>
<td><span class="parametername">pt</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><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_Contains_Terminal_Gui_Point__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Checks if a Point lies within this Rectangle.
</div>
<a id="Terminal_Gui_Rect_Contains_" data-uid="Terminal.Gui.Rect.Contains*"></a>
<h4 id="Terminal_Gui_Rect_Contains_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Rect.Contains(Terminal.Gui.Rect)">Contains(Rect)</h4>
<div class="markdown level1 summary">
Contains Method
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Contains(Rect rect)</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.Rect.html">Rect</a></td>
<td><span class="parametername">rect</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><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_Contains_Terminal_Gui_Rect__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Checks if a Rectangle lies entirely within this
Rectangle.
</div>
<a id="Terminal_Gui_Rect_Equals_" data-uid="Terminal.Gui.Rect.Equals*"></a>
<h4 id="Terminal_Gui_Rect_Equals_System_Object_" data-uid="Terminal.Gui.Rect.Equals(System.Object)">Equals(Object)</h4>
<div class="markdown level1 summary">
Equals Method
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool Equals(object obj)</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.Object</span></td>
<td><span class="parametername">obj</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><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.ValueType.Equals(System.Object)</span></div>
<h5 id="Terminal_Gui_Rect_Equals_System_Object__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Checks equivalence of this Rectangle and another object.
</div>
<a id="Terminal_Gui_Rect_FromLTRB_" data-uid="Terminal.Gui.Rect.FromLTRB*"></a>
<h4 id="Terminal_Gui_Rect_FromLTRB_System_Int32_System_Int32_System_Int32_System_Int32_" data-uid="Terminal.Gui.Rect.FromLTRB(System.Int32,System.Int32,System.Int32,System.Int32)">FromLTRB(Int32, Int32, Int32, Int32)</h4>
<div class="markdown level1 summary">
FromLTRB Shared Method
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Rect FromLTRB(int left, int top, int right, int bottom)</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">left</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">top</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">right</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">bottom</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="Terminal.Gui.Rect.html">Rect</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_FromLTRB_System_Int32_System_Int32_System_Int32_System_Int32__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Produces a Rectangle structure from left, top, right
and bottom coordinates.
</div>
<a id="Terminal_Gui_Rect_GetHashCode_" data-uid="Terminal.Gui.Rect.GetHashCode*"></a>
<h4 id="Terminal_Gui_Rect_GetHashCode" data-uid="Terminal.Gui.Rect.GetHashCode">GetHashCode()</h4>
<div class="markdown level1 summary">
GetHashCode Method
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int GetHashCode()</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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.ValueType.GetHashCode()</span></div>
<h5 id="Terminal_Gui_Rect_GetHashCode_remarks">Remarks</h5>
<div class="markdown level1 remarks">
Calculates a hashing value.
</div>
<a id="Terminal_Gui_Rect_Inflate_" data-uid="Terminal.Gui.Rect.Inflate*"></a>
<h4 id="Terminal_Gui_Rect_Inflate_System_Int32_System_Int32_" data-uid="Terminal.Gui.Rect.Inflate(System.Int32,System.Int32)">Inflate(Int32, Int32)</h4>
<div class="markdown level1 summary">
Inflate Method
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Inflate(int width, int height)</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">width</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">height</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_Inflate_System_Int32_System_Int32__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Inflates the Rectangle by a specified width and height.
</div>
<a id="Terminal_Gui_Rect_Inflate_" data-uid="Terminal.Gui.Rect.Inflate*"></a>
<h4 id="Terminal_Gui_Rect_Inflate_Terminal_Gui_Rect_System_Int32_System_Int32_" data-uid="Terminal.Gui.Rect.Inflate(Terminal.Gui.Rect,System.Int32,System.Int32)">Inflate(Rect, Int32, Int32)</h4>
<div class="markdown level1 summary">
Inflate Shared Method
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Rect Inflate(Rect rect, int x, int y)</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.Rect.html">Rect</a></td>
<td><span class="parametername">rect</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">x</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">y</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="Terminal.Gui.Rect.html">Rect</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_Inflate_Terminal_Gui_Rect_System_Int32_System_Int32__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Produces a new Rectangle by inflating an existing
Rectangle by the specified coordinate values.
</div>
<a id="Terminal_Gui_Rect_Inflate_" data-uid="Terminal.Gui.Rect.Inflate*"></a>
<h4 id="Terminal_Gui_Rect_Inflate_Terminal_Gui_Size_" data-uid="Terminal.Gui.Rect.Inflate(Terminal.Gui.Size)">Inflate(Size)</h4>
<div class="markdown level1 summary">
Inflate Method
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Inflate(Size size)</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.Size.html">Size</a></td>
<td><span class="parametername">size</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_Inflate_Terminal_Gui_Size__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Inflates the Rectangle by a specified Size.
</div>
<a id="Terminal_Gui_Rect_Intersect_" data-uid="Terminal.Gui.Rect.Intersect*"></a>
<h4 id="Terminal_Gui_Rect_Intersect_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Rect.Intersect(Terminal.Gui.Rect)">Intersect(Rect)</h4>
<div class="markdown level1 summary">
Intersect Method
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Intersect(Rect rect)</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.Rect.html">Rect</a></td>
<td><span class="parametername">rect</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_Intersect_Terminal_Gui_Rect__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Replaces the Rectangle with the intersection of itself
and another Rectangle.
</div>
<a id="Terminal_Gui_Rect_Intersect_" data-uid="Terminal.Gui.Rect.Intersect*"></a>
<h4 id="Terminal_Gui_Rect_Intersect_Terminal_Gui_Rect_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Rect.Intersect(Terminal.Gui.Rect,Terminal.Gui.Rect)">Intersect(Rect, Rect)</h4>
<div class="markdown level1 summary">
Intersect Shared Method
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Rect Intersect(Rect a, Rect b)</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.Rect.html">Rect</a></td>
<td><span class="parametername">a</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
<td><span class="parametername">b</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="Terminal.Gui.Rect.html">Rect</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_Intersect_Terminal_Gui_Rect_Terminal_Gui_Rect__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Produces a new Rectangle by intersecting 2 existing
Rectangles. Returns null if there is no intersection.
</div>
<a id="Terminal_Gui_Rect_IntersectsWith_" data-uid="Terminal.Gui.Rect.IntersectsWith*"></a>
<h4 id="Terminal_Gui_Rect_IntersectsWith_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Rect.IntersectsWith(Terminal.Gui.Rect)">IntersectsWith(Rect)</h4>
<div class="markdown level1 summary">
IntersectsWith Method
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IntersectsWith(Rect rect)</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.Rect.html">Rect</a></td>
<td><span class="parametername">rect</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><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_IntersectsWith_Terminal_Gui_Rect__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Checks if a Rectangle intersects with this one.
</div>
<a id="Terminal_Gui_Rect_Offset_" data-uid="Terminal.Gui.Rect.Offset*"></a>
<h4 id="Terminal_Gui_Rect_Offset_System_Int32_System_Int32_" data-uid="Terminal.Gui.Rect.Offset(System.Int32,System.Int32)">Offset(Int32, Int32)</h4>
<div class="markdown level1 summary">
Offset Method
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Offset(int x, int y)</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">x</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">y</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_Offset_System_Int32_System_Int32__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Moves the Rectangle a specified distance.
</div>
<a id="Terminal_Gui_Rect_Offset_" data-uid="Terminal.Gui.Rect.Offset*"></a>
<h4 id="Terminal_Gui_Rect_Offset_Terminal_Gui_Point_" data-uid="Terminal.Gui.Rect.Offset(Terminal.Gui.Point)">Offset(Point)</h4>
<div class="markdown level1 summary">
Offset Method
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Offset(Point pos)</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.Point.html">Point</a></td>
<td><span class="parametername">pos</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_Offset_Terminal_Gui_Point__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Moves the Rectangle a specified distance.
</div>
<a id="Terminal_Gui_Rect_ToString_" data-uid="Terminal.Gui.Rect.ToString*"></a>
<h4 id="Terminal_Gui_Rect_ToString" data-uid="Terminal.Gui.Rect.ToString">ToString()</h4>
<div class="markdown level1 summary">
ToString Method
</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></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.ValueType.ToString()</span></div>
<h5 id="Terminal_Gui_Rect_ToString_remarks">Remarks</h5>
<div class="markdown level1 remarks">
Formats the Rectangle as a string in (x,y,w,h) notation.
</div>
<a id="Terminal_Gui_Rect_Union_" data-uid="Terminal.Gui.Rect.Union*"></a>
<h4 id="Terminal_Gui_Rect_Union_Terminal_Gui_Rect_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Rect.Union(Terminal.Gui.Rect,Terminal.Gui.Rect)">Union(Rect, Rect)</h4>
<div class="markdown level1 summary">
Union Shared Method
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Rect Union(Rect a, Rect b)</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.Rect.html">Rect</a></td>
<td><span class="parametername">a</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
<td><span class="parametername">b</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="Terminal.Gui.Rect.html">Rect</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_Union_Terminal_Gui_Rect_Terminal_Gui_Rect__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Produces a new Rectangle from the union of 2 existing
Rectangles.
</div>
<h3 id="operators">Operators
</h3>
<a id="Terminal_Gui_Rect_op_Equality_" data-uid="Terminal.Gui.Rect.op_Equality*"></a>
<h4 id="Terminal_Gui_Rect_op_Equality_Terminal_Gui_Rect_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Rect.op_Equality(Terminal.Gui.Rect,Terminal.Gui.Rect)">Equality(Rect, Rect)</h4>
<div class="markdown level1 summary">
Equality Operator
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool operator ==(Rect left, Rect 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.Rect.html">Rect</a></td>
<td><span class="parametername">left</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
<td><span class="parametername">right</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><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_op_Equality_Terminal_Gui_Rect_Terminal_Gui_Rect__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Compares two Rectangle objects. The return value is
based on the equivalence of the Location and Size
properties of the two Rectangles.
</div>
<a id="Terminal_Gui_Rect_op_Inequality_" data-uid="Terminal.Gui.Rect.op_Inequality*"></a>
<h4 id="Terminal_Gui_Rect_op_Inequality_Terminal_Gui_Rect_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Rect.op_Inequality(Terminal.Gui.Rect,Terminal.Gui.Rect)">Inequality(Rect, Rect)</h4>
<div class="markdown level1 summary">
Inequality Operator
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool operator !=(Rect left, Rect 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.Rect.html">Rect</a></td>
<td><span class="parametername">left</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
<td><span class="parametername">right</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><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_Rect_op_Inequality_Terminal_Gui_Rect_Terminal_Gui_Rect__remarks">Remarks</h5>
<div class="markdown level1 remarks">
Compares two Rectangle objects. The return value is
based on the equivalence of the Location and Size
properties of the two Rectangles.
</div>
</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>
Reference in New Issue View Git Blame Copy Permalink