Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-27 00:07:58 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
6ffe2c76c944bb3e354572d3c1e30f14385b00c7
Terminal.Gui/docs/api/Terminal/Terminal.Label.html
Miguel de Icaza 58f99c0bd8 API doc update
2018-01-17 14:24:58 -05:00

500 lines
18 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>Class Label
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Label
">
<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.Label">
<h1 id="Terminal_Label" data-uid="Terminal.Label">Class Label
</h1>
<div class="markdown level0 summary"><p>Label widget, displays a string at a given position, can include multiple lines.</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"><a class="xref" href="Terminal.Responder.html">Responder</a></div>
<div class="level2"><a class="xref" href="Terminal.View.html">View</a></div>
<div class="level3"><span class="xref">Label</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Terminal.Responder.html#Terminal_Responder_CanFocus">Responder.CanFocus</a>
</div>
<div>
<a class="xref" href="Terminal.Responder.html#Terminal_Responder_MouseEvent_Terminal_MouseEvent_">Responder.MouseEvent(MouseEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Add_Terminal_View_">View.Add(View)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Add_Terminal_View___">View.Add(View[])</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_AddCh_System_Int32_System_Int32_System_Int32_">View.AddCh(Int32, Int32, Int32)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Bounds">View.Bounds</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Clear">View.Clear()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_ColorScheme">View.ColorScheme</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_DrawFrame_Terminal_Rect_System_Boolean_">View.DrawFrame(Rect, Boolean)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_DrawHotString_System_String_System_Boolean_Terminal_ColorScheme_">View.DrawHotString(String, Boolean, ColorScheme)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_DrawHotString_System_String_Terminal_Attribute_Terminal_Attribute_">View.DrawHotString(String, Attribute, Attribute)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Driver">View.Driver</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_EnsureFocus">View.EnsureFocus()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Focused">View.Focused</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_FocusFirst">View.FocusFirst()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_FocusLast">View.FocusLast()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_FocusNext">View.FocusNext()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_FocusPrev">View.FocusPrev()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Frame">View.Frame</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_GetEnumerator">View.GetEnumerator()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_HasFocus">View.HasFocus</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Id">View.Id</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_LayoutSubviews">View.LayoutSubviews()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_MostFocused">View.MostFocused</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_PositionCursor">View.PositionCursor()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_ProcessColdKey_Terminal_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_ProcessHotKey_Terminal_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_ProcessKey_Terminal_KeyEvent_">View.ProcessKey(KeyEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Remove_Terminal_View_">View.Remove(View)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_RemoveAll">View.RemoveAll()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_SetFocus_Terminal_View_">View.SetFocus(View)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_SetNeedsDisplay_Terminal_Rect_">View.SetNeedsDisplay(Rect)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Subviews">View.Subviews</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_SuperView">View.SuperView</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_ToString">View.ToString()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_WantMousePositionReports">View.WantMousePositionReports</a>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.html">Terminal</a></h6>
<h6><strong>Assembly</strong>: Terminal.dll</h6>
<h5 id="Terminal_Label_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class Label : Terminal.View</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Terminal_Label__ctor_" data-uid="Terminal.Label.#ctor*"></a>
<h4 id="Terminal_Label__ctor_Terminal_Rect_System_String_" data-uid="Terminal.Label.#ctor(Terminal.Rect,System.String)">Label(Rect, String)</h4>
<div class="markdown level1 summary"><p>Public constructor: creates a label at the given
coordinate with the given string and uses the specified
frame for the string.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Label (Terminal.Rect rect, string text);</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.Rect.html">Rect</a></td>
<td><span class="parametername">rect</span></td>
<td><p>To be added.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">text</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_Label__ctor_" data-uid="Terminal.Label.#ctor*"></a>
<h4 id="Terminal_Label__ctor_System_Int32_System_Int32_System_String_" data-uid="Terminal.Label.#ctor(System.Int32,System.Int32,System.String)">Label(Int32, Int32, String)</h4>
<div class="markdown level1 summary"><p>Public constructor: creates a label at the given
coordinate with the given string, computes the bounding box
based on the size of the string, assumes that the string contains
newlines for multiple lines, no special breaking rules are used.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Label (int x, int y, string text);</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><p>To be added.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">y</span></td>
<td><p>To be added.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">text</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Terminal_Label_Text_" data-uid="Terminal.Label.Text*"></a>
<h4 id="Terminal_Label_Text" data-uid="Terminal.Label.Text">Text</h4>
<div class="markdown level1 summary"><p>The text displayed by this widget.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual string Text { 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><span class="xref">System.String</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_Label_TextAlignment_" data-uid="Terminal.Label.TextAlignment*"></a>
<h4 id="Terminal_Label_TextAlignment" data-uid="Terminal.Label.TextAlignment">TextAlignment</h4>
<div class="markdown level1 summary"><p>Controls the text-alignemtn property of the label, changing it will redisplay the label.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Terminal.TextAlignment TextAlignment { 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.TextAlignment.html">TextAlignment</a></td>
<td><p>The text alignment.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_Label_TextColor_" data-uid="Terminal.Label.TextColor*"></a>
<h4 id="Terminal_Label_TextColor" data-uid="Terminal.Label.TextColor">TextColor</h4>
<div class="markdown level1 summary"><p>The color used for the label</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Terminal.Attribute TextColor { 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.Attribute.html">Attribute</a></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="Terminal_Label_MeasureLines_" data-uid="Terminal.Label.MeasureLines*"></a>
<h4 id="Terminal_Label_MeasureLines_System_String_System_Int32_" data-uid="Terminal.Label.MeasureLines(System.String,System.Int32)">MeasureLines(String, Int32)</h4>
<div class="markdown level1 summary"><p>Computes the number of lines needed to render the specified text by the Label control</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static int MeasureLines (string text, int width);</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">text</span></td>
<td><p>Text, may contain newlines.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">width</span></td>
<td><p>The width for the text.</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><span class="xref">System.Int32</span></td>
<td><p>Number of lines.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_Label_Redraw_" data-uid="Terminal.Label.Redraw*"></a>
<h4 id="Terminal_Label_Redraw_Terminal_Rect_" data-uid="Terminal.Label.Redraw(Terminal.Rect)">Redraw(Rect)</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 override void Redraw (Terminal.Rect region);</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.Rect.html">Rect</a></td>
<td><span class="parametername">region</span></td>
<td><p>To be added.</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>
Reference in New Issue View Git Blame Copy Permalink