ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-01-23 01:25:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add docs template

Browse Source
This commit is contained in:
Karl Burtram
2016-12-15 17:06:28 -08:00
parent b9f1c2b60e 2346ffff38
commit edb3c4aa1f
275 changed files with 10751 additions and 19075 deletions
Download Patch File Download Diff File Expand all files Collapse all files

174
docs/_site/api/Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.html
View File

@@ -10,43 +10,45 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ScriptFile
">
<meta name="generator" content="docfx 1.0.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/style.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix">
<!--
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-63735192-1', 'auto');
ga('send', 'pageview');
</script>
-->
</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>
<nav class="navbar navbar-inverse">
<div class="container">
<a href="../"><img height="50px" src="../images/sqlserver.png" style="float:right;"></a>
<div class="navbar-header ">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="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="../"><span class="dotnet">SQL Tools Service</span></a>
</div>
<div id="navbar" class="collapse navbar-collapse">
</div><!--/.nav-collapse -->
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
@@ -68,7 +70,8 @@
<div class="col-md-10">
<article class="content wrap" id="_content">
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile%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="pull-right mobile-hide"><span class="fa fa-github"></span>Improve this Doc</a>
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L17" class="pull-right mobile-hide">View Source</a>
<h1 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile">Class ScriptFile
</h1>
<div class="markdown level0 summary"><p>Contains the details and contents of an open script file.</p>
@@ -79,30 +82,6 @@
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">ScriptFile</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>:Microsoft.SqlTools.ServiceLayer.Workspace.Contracts</h6>
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
<h5 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_syntax">Syntax</h5>
@@ -118,7 +97,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L104">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile__ctor" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.#ctor">ScriptFile()</h4>
<div class="markdown level1 summary"><p>Add a default constructor for testing</p>
</div>
@@ -134,7 +112,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L116">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile__ctor_System_String_System_String_System_IO_TextReader_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.#ctor(System.String,System.String,System.IO.TextReader)">ScriptFile(String, String, TextReader)</h4>
<div class="markdown level1 summary"><p>Creates a new ScriptFile instance by reading file contents from
the given TextReader.</p>
@@ -156,19 +133,19 @@ the given TextReader.</p>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">filePath</span></td>
<td><em>filePath</em></td>
<td><p>The path at which the script file resides.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">clientFilePath</span></td>
<td><em>clientFilePath</em></td>
<td><p>The path which the client uses to identify the file.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.IO.TextReader</span></td>
<td><span class="parametername">textReader</span></td>
<td><em>textReader</em></td>
<td><p>The TextReader to use for reading the file&#39;s contents.</p>
</td>
</tr>
@@ -181,7 +158,6 @@ the given TextReader.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L135">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile__ctor_System_String_System_String_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.#ctor(System.String,System.String,System.String)">ScriptFile(String, String, String)</h4>
<div class="markdown level1 summary"><p>Creates a new ScriptFile instance with the specified file contents.</p>
</div>
@@ -202,19 +178,19 @@ the given TextReader.</p>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">filePath</span></td>
<td><em>filePath</em></td>
<td><p>The path at which the script file resides.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">clientFilePath</span></td>
<td><em>clientFilePath</em></td>
<td><p>The path which the client uses to identify the file.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">initialBuffer</span></td>
<td><em>initialBuffer</em></td>
<td><p>The initial contents of the script file.</p>
</td>
</tr>
@@ -229,7 +205,6 @@ the given TextReader.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L41">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_ClientFilePath_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.ClientFilePath*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_ClientFilePath" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.ClientFilePath">ClientFilePath</h4>
<div class="markdown level1 summary"><p>Gets or sets the path which the editor client uses to identify this file.
Setter for testing purposes only
@@ -240,7 +215,7 @@ virtual to allow mocking.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual string ClientFilePath { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -262,7 +237,6 @@ virtual to allow mocking.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L60">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_Contents_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.Contents*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_Contents" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.Contents">Contents</h4>
<div class="markdown level1 summary"><p>Gets or sets a string containing the full contents of the file.
Setter for testing purposes only</p>
@@ -272,7 +246,7 @@ Setter for testing purposes only</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual string Contents { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -294,7 +268,6 @@ Setter for testing purposes only</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L34">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_FilePath_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.FilePath*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_FilePath" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.FilePath">FilePath</h4>
<div class="markdown level1 summary"><p>Gets the path at which this file resides.</p>
</div>
@@ -303,7 +276,7 @@ Setter for testing purposes only</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string FilePath { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -325,7 +298,6 @@ Setter for testing purposes only</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L76">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_FileRange_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.FileRange*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_FileRange" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.FileRange">FileRange</h4>
<div class="markdown level1 summary"><p>Gets a BufferRange that represents the entire content
range of the file.</p>
@@ -335,7 +307,7 @@ range of the file.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BufferRange FileRange { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -357,7 +329,6 @@ range of the file.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L26">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_Id_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.Id*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_Id" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.Id">Id</h4>
<div class="markdown level1 summary"><p>Gets a unique string that identifies this file. At this time,
this property returns a normalized version of the value stored
@@ -368,7 +339,7 @@ in the FilePath property.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Id { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -390,7 +361,6 @@ in the FilePath property.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L54">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_IsInMemory_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.IsInMemory*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_IsInMemory" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.IsInMemory">IsInMemory</h4>
<div class="markdown level1 summary"><p>Gets a boolean that determines whether this file is
in-memory or not (either unsaved or non-file content).</p>
@@ -400,7 +370,7 @@ in-memory or not (either unsaved or non-file content).</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsInMemory { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -422,7 +392,6 @@ in-memory or not (either unsaved or non-file content).</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L82">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_SyntaxMarkers_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.SyntaxMarkers*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_SyntaxMarkers" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.SyntaxMarkers">SyntaxMarkers</h4>
<div class="markdown level1 summary"><p>Gets the list of syntax markers found by parsing this
file&#39;s contents.</p>
@@ -432,7 +401,7 @@ file&#39;s contents.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ScriptFileMarker[] SyntaxMarkers { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -456,7 +425,6 @@ file&#39;s contents.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L244">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_ApplyChange_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.ApplyChange*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_ApplyChange_Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_FileChange_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.ApplyChange(Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FileChange)">ApplyChange(FileChange)</h4>
<div class="markdown level1 summary"><p>Applies the provided FileChange to the file&#39;s contents</p>
</div>
@@ -477,7 +445,7 @@ file&#39;s contents.</p>
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.FileChange.html">FileChange</a></td>
<td><span class="parametername">fileChange</span></td>
<td><em>fileChange</em></td>
<td><p>The FileChange to apply to the file&#39;s contents.</p>
</td>
</tr>
@@ -490,7 +458,6 @@ file&#39;s contents.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L334">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_CalculatePosition_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.CalculatePosition*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_CalculatePosition_Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_BufferPosition_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.CalculatePosition(Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.BufferPosition,System.Int32,System.Int32)">CalculatePosition(BufferPosition, Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Calculates a FilePosition relative to a starting BufferPosition
using the given 1-based line and column offset.</p>
@@ -512,19 +479,19 @@ using the given 1-based line and column offset.</p>
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.BufferPosition.html">BufferPosition</a></td>
<td><span class="parametername">originalPosition</span></td>
<td><em>originalPosition</em></td>
<td><p>The original BufferPosition from which an new position should be calculated.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">lineOffset</span></td>
<td><em>lineOffset</em></td>
<td><p>The 1-based line offset added to the original position in this file.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">columnOffset</span></td>
<td><em>columnOffset</em></td>
<td><p>The 1-based column offset added to the original position in this file.</p>
</td>
</tr>
@@ -553,7 +520,6 @@ using the given 1-based line and column offset.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L156">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_GetLine_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.GetLine*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_GetLine_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.GetLine(System.Int32)">GetLine(Int32)</h4>
<div class="markdown level1 summary"><p>Gets a line from the file&#39;s contents.</p>
</div>
@@ -574,7 +540,7 @@ using the given 1-based line and column offset.</p>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">lineNumber</span></td>
<td><em>lineNumber</em></td>
<td><p>The 1-based line number in the file.</p>
</td>
</tr>
@@ -603,7 +569,6 @@ using the given 1-based line and column offset.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L171">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_GetLinesInRange_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.GetLinesInRange*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_GetLinesInRange_Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_BufferRange_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.GetLinesInRange(Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.BufferRange)">GetLinesInRange(BufferRange)</h4>
<div class="markdown level1 summary"><p>Gets a range of lines from the file&#39;s contents. Virtual method to allow for
mocking.</p>
@@ -625,7 +590,7 @@ mocking.</p>
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.BufferRange.html">BufferRange</a></td>
<td><span class="parametername">bufferRange</span></td>
<td><em>bufferRange</em></td>
<td><p>The buffer range from which lines will be extracted.</p>
</td>
</tr>
@@ -654,7 +619,6 @@ mocking.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L302">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_GetOffsetAtPosition_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.GetOffsetAtPosition*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_GetOffsetAtPosition_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.GetOffsetAtPosition(System.Int32,System.Int32)">GetOffsetAtPosition(Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Calculates the zero-based character offset of a given
line and column position in the file.</p>
@@ -676,13 +640,13 @@ line and column position in the file.</p>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">lineNumber</span></td>
<td><em>lineNumber</em></td>
<td><p>The 1-based line number from which the offset is calculated.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">columnNumber</span></td>
<td><em>columnNumber</em></td>
<td><p>The 1-based column number from which the offset is calculated.</p>
</td>
</tr>
@@ -711,7 +675,6 @@ line and column position in the file.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L356">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_GetPositionAtOffset_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.GetPositionAtOffset*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_GetPositionAtOffset_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.GetPositionAtOffset(System.Int32)">GetPositionAtOffset(Int32)</h4>
<div class="markdown level1 summary"><p>Calculates the 1-based line and column number position based
on the given buffer offset.</p>
@@ -733,7 +696,7 @@ on the given buffer offset.</p>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">bufferOffset</span></td>
<td><em>bufferOffset</em></td>
<td><p>The buffer offset to convert.</p>
</td>
</tr>
@@ -762,7 +725,6 @@ on the given buffer offset.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L372">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_GetRangeBetweenOffsets_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.GetRangeBetweenOffsets*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_GetRangeBetweenOffsets_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.GetRangeBetweenOffsets(System.Int32,System.Int32)">GetRangeBetweenOffsets(Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Calculates the 1-based line and column number range based on
the given start and end buffer offsets.</p>
@@ -784,13 +746,13 @@ the given start and end buffer offsets.</p>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">startOffset</span></td>
<td><em>startOffset</em></td>
<td><p>The start offset of the range.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">endOffset</span></td>
<td><em>endOffset</em></td>
<td><p>The end offset of the range.</p>
</td>
</tr>
@@ -819,7 +781,6 @@ the given start and end buffer offsets.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L429">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_SetFileContents_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.SetFileContents*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_SetFileContents_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.SetFileContents(System.String)">SetFileContents(String)</h4>
<div class="markdown level1 summary"><p>Set the script files contents</p>
</div>
@@ -840,7 +801,7 @@ the given start and end buffer offsets.</p>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">fileContents</span></td>
<td><em>fileContents</em></td>
<td></td>
</tr>
</tbody>
@@ -852,7 +813,6 @@ the given start and end buffer offsets.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L209">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_ValidatePosition_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.ValidatePosition*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_ValidatePosition_Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_BufferPosition_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.ValidatePosition(Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.BufferPosition)">ValidatePosition(BufferPosition)</h4>
<div class="markdown level1 summary"><p>Throws ArgumentOutOfRangeException if the given position is outside
of the file&#39;s buffer extents.</p>
@@ -874,7 +834,7 @@ of the file&#39;s buffer extents.</p>
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.BufferPosition.html">BufferPosition</a></td>
<td><span class="parametername">bufferPosition</span></td>
<td><em>bufferPosition</em></td>
<td><p>The position in the buffer to be validated.</p>
</td>
</tr>
@@ -887,7 +847,6 @@ of the file&#39;s buffer extents.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Contracts/ScriptFile.cs/#L222">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_ValidatePosition_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.ValidatePosition*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_ValidatePosition_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile.ValidatePosition(System.Int32,System.Int32)">ValidatePosition(Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Throws ArgumentOutOfRangeException if the given position is outside
of the file&#39;s buffer extents.</p>
@@ -909,13 +868,13 @@ of the file&#39;s buffer extents.</p>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">line</span></td>
<td><em>line</em></td>
<td><p>The 1-based line to be validated.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">column</span></td>
<td><em>column</em></td>
<td><p>The 1-based column to be validated.</p>
</td>
</tr>
@@ -945,16 +904,9 @@ of the file&#39;s buffer extents.</p>
</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 class="inner-footer">
<p>© Microsoft &nbsp;//&nbsp; Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
</div>
</div>
</footer>
</div>