ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-01-22 17:24:07 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
e3c080b2a06ec24ac39b9664a414fa494f61a361
sqltoolsservice/docs/_site/api/Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.html
Karl Burtram e3c080b2a0 Add initial doxfx content
2016-12-15 16:37:50 -08:00

382 lines
23 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 FilePosition
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class FilePosition
">
<meta name="generator" content="docfx 1.0.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">
</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">
<h1 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition">Class FilePosition
</h1>
<div class="markdown level0 summary"><p>Provides details and operations for a buffer position in a
specific file.</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="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.BufferPosition.html">BufferPosition</a></div>
<div class="level2"><span class="xref">FilePosition</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.BufferPosition.html#Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_BufferPosition_None">BufferPosition.None</a>
</div>
<div>
<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.BufferPosition.html#Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_BufferPosition_Line">BufferPosition.Line</a>
</div>
<div>
<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.BufferPosition.html#Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_BufferPosition_Column">BufferPosition.Column</a>
</div>
<div>
<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.BufferPosition.html#Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_BufferPosition_Equals_System_Object_">BufferPosition.Equals(Object)</a>
</div>
<div>
<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.BufferPosition.html#Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_BufferPosition_GetHashCode">BufferPosition.GetHashCode()</a>
</div>
<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.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>:Microsoft.SqlTools.ServiceLayer.Workspace.Contracts</h6>
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
<h5 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class FilePosition : BufferPosition</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition__ctor_Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_BufferPosition_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.%23ctor(Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile%2CMicrosoft.SqlTools.ServiceLayer.Workspace.Contracts.BufferPosition)%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/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/FilePosition.cs/#L44">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition__ctor_Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_BufferPosition_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.#ctor(Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile,Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.BufferPosition)">FilePosition(ScriptFile, BufferPosition)</h4>
<div class="markdown level1 summary"><p>Creates a new FilePosition instance for the specified file by
copying the specified BufferPosition</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FilePosition(ScriptFile scriptFile, BufferPosition copiedPosition)</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="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.html">ScriptFile</a></td>
<td><span class="parametername">scriptFile</span></td>
<td><p>The ScriptFile in which the position is located.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.BufferPosition.html">BufferPosition</a></td>
<td><span class="parametername">copiedPosition</span></td>
<td><p>The original BufferPosition from which the line and column will be copied.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition__ctor_Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.%23ctor(Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile%2CSystem.Int32%2CSystem.Int32)%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/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/FilePosition.cs/#L29">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition__ctor_Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.#ctor(Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile,System.Int32,System.Int32)">FilePosition(ScriptFile, Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Creates a new FilePosition instance for the 1-based line and
column numbers in the specified file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FilePosition(ScriptFile scriptFile, int line, int column)</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="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.html">ScriptFile</a></td>
<td><span class="parametername">scriptFile</span></td>
<td><p>The ScriptFile in which the position is located.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">line</span></td>
<td><p>The 1-based line number in the file.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">column</span></td>
<td><p>The 1-based column number in the file.</p>
</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/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition_AddOffset_System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.AddOffset(System.Int32%2CSystem.Int32)%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/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/FilePosition.cs/#L64">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition_AddOffset_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.AddOffset*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition_AddOffset_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.AddOffset(System.Int32,System.Int32)">AddOffset(Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Gets a FilePosition relative to this position by adding the
provided line and column offset relative to the contents of
the current file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FilePosition AddOffset(int lineOffset, int columnOffset)</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">lineOffset</span></td>
<td><p>The line offset to add to this position.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">columnOffset</span></td>
<td><p>The column offset to add to this position.</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="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.html">FilePosition</a></td>
<td><p>A new FilePosition instance for the calculated position.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition_GetLineEnd.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.GetLineEnd%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/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/FilePosition.cs/#L100">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition_GetLineEnd_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.GetLineEnd*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition_GetLineEnd" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.GetLineEnd">GetLineEnd()</h4>
<div class="markdown level1 summary"><p>Gets a FilePosition for the line and column position
of the end of the current line.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FilePosition GetLineEnd()</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="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.html">FilePosition</a></td>
<td><p>A new FilePosition instance for the calculated position.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition_GetLineStart.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.GetLineStart%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/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/FilePosition.cs/#L78">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition_GetLineStart_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.GetLineStart*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition_GetLineStart" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.GetLineStart">GetLineStart()</h4>
<div class="markdown level1 summary"><p>Gets a FilePosition for the line and column position
of the beginning of the current line after any initial
whitespace for indentation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FilePosition GetLineStart()</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="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition.html">FilePosition</a></td>
<td><p>A new FilePosition instance for the calculated position.</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">
<li>
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FilePosition.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FilePosition%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/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/FilePosition.cs/#L12" class="contribution-link">View Source</a>
</li>
</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-2016 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