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

120
docs/_site/api/Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.html
View File

@@ -10,43 +10,45 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Workspace
">
<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_Workspace.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.Workspace%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/Workspace.cs/#L21" class="pull-right mobile-hide">View Source</a>
<h1 id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace">Class Workspace
</h1>
<div class="markdown level0 summary"><p>Manages a &quot;workspace&quot; of script files that are open for a particular
@@ -80,30 +83,6 @@ editing session. Also helps to navigate references between ScriptFiles.</p>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">Workspace</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</h6>
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
<h5 id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace_syntax">Syntax</h5>
@@ -119,7 +98,6 @@ editing session. Also helps to navigate references between ScriptFiles.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Workspace.cs/#L43">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace__ctor" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.#ctor">Workspace()</h4>
<div class="markdown level1 summary"><p>Creates a new instance of the Workspace class.</p>
</div>
@@ -137,7 +115,6 @@ editing session. Also helps to navigate references between ScriptFiles.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Workspace.cs/#L34">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace_WorkspacePath_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.WorkspacePath*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace_WorkspacePath" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.WorkspacePath">WorkspacePath</h4>
<div class="markdown level1 summary"><p>Gets or sets the root path of the workspace.</p>
</div>
@@ -146,7 +123,7 @@ editing session. Also helps to navigate references between ScriptFiles.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string WorkspacePath { 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>
@@ -170,7 +147,6 @@ editing session. Also helps to navigate references between ScriptFiles.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Workspace.cs/#L190">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace_CloseFile_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.CloseFile*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace_CloseFile_Microsoft_SqlTools_ServiceLayer_Workspace_Contracts_ScriptFile_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.CloseFile(Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.ScriptFile)">CloseFile(ScriptFile)</h4>
<div class="markdown level1 summary"><p>Closes a currently open script file with the given file path.</p>
</div>
@@ -191,7 +167,7 @@ editing session. Also helps to navigate references between ScriptFiles.</p>
<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><em>scriptFile</em></td>
<td><p>The file path at which the script resides.</p>
</td>
</tr>
@@ -204,7 +180,6 @@ editing session. Also helps to navigate references between ScriptFiles.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Workspace.cs/#L244">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace_Dispose_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.Dispose*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace_Dispose" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.Dispose">Dispose()</h4>
<div class="markdown level1 summary"><p>Disposes of any Runspaces that were created for the
services used in this session.</p>
@@ -214,8 +189,6 @@ services used in this session.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
</div>
<h5 class="implements">Implements</h5>
<div><span class="xref">System.IDisposable.Dispose()</span></div>
<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_Workspace_GetFile_System_String_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.GetFile(System.String)%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>
@@ -223,7 +196,6 @@ services used in this session.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Workspace.cs/#L63">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace_GetFile_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.GetFile*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace_GetFile_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.GetFile(System.String)">GetFile(String)</h4>
<div class="markdown level1 summary"><p>Gets an open file in the workspace. If the file isn&#39;t open but
exists on the filesystem, load and return it. Virtual method to
@@ -246,7 +218,7 @@ allow for mocking</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 file path at which the script resides.</p>
</td>
</tr>
@@ -295,7 +267,6 @@ allow for mocking</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Workspace.cs/#L155">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace_GetFileBuffer_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.GetFileBuffer*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace_GetFileBuffer_System_String_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.GetFileBuffer(System.String,System.String)">GetFileBuffer(String, String)</h4>
<div class="markdown level1 summary"><p>Gets a new ScriptFile instance which is identified by the given file
path and initially contains the given buffer contents.</p>
@@ -317,12 +288,12 @@ path and initially contains the given buffer contents.</p>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">filePath</span></td>
<td><em>filePath</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">initialBuffer</span></td>
<td><em>initialBuffer</em></td>
<td></td>
</tr>
</tbody>
@@ -349,7 +320,6 @@ path and initially contains the given buffer contents.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Workspace.cs/#L181">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace_GetOpenedFiles_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.GetOpenedFiles*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace_GetOpenedFiles" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.GetOpenedFiles">GetOpenedFiles()</h4>
<div class="markdown level1 summary"><p>Gets an array of all opened ScriptFiles in the workspace.</p>
</div>
@@ -381,7 +351,6 @@ path and initially contains the given buffer contents.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/Workspace.cs/#L138">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace_UnescapePath_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.UnescapePath*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_Workspace_UnescapePath_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.UnescapePath(System.String)">UnescapePath(String)</h4>
<div class="markdown level1 summary"><p>Unescapes any escaped [, ] or space characters. Typically use this before calling a
.NET API that doesn&#39;t understand PowerShell escaped chars.</p>
@@ -403,7 +372,7 @@ path and initially contains the given buffer contents.</p>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">path</span></td>
<td><em>path</em></td>
<td><p>The path to unescape.</p>
</td>
</tr>
@@ -449,16 +418,9 @@ path and initially contains the given buffer contents.</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>