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

141
docs/_site/api/Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService-1.html
View File

@@ -10,43 +10,45 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class WorkspaceService&lt;TConfig&gt;
">
<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_WorkspaceService_1.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService%601%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/WorkspaceService.cs/#L26" class="pull-right mobile-hide">View Source</a>
<h1 id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1">Class WorkspaceService&lt;TConfig&gt;
</h1>
<div class="markdown level0 summary"><p>Class for handling requests/events that deal with the state of the workspace, including the
@@ -80,30 +83,6 @@ opening and closing of files, the changing of configuration, etc.</p>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">WorkspaceService&lt;TConfig&gt;</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_WorkspaceService_1_syntax">Syntax</h5>
@@ -111,24 +90,6 @@ opening and closing of files, the changing of configuration, etc.</p>
<pre><code class="lang-csharp hljs">public class WorkspaceService&lt;TConfig&gt;
where TConfig : class, new ()</code></pre>
</div>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">TConfig</span></td>
<td>
The type of the class used for serializing and deserializing the configuration. Must be the
actual type of the instance otherwise deserialization will be incomplete.
</td>
</tr>
</tbody>
</table>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
@@ -138,7 +99,6 @@ actual type of the instance otherwise deserialization will be incomplete.
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/WorkspaceService.cs/#L42">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1__ctor" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.#ctor">WorkspaceService()</h4>
<div class="markdown level1 summary"><p>Default, parameterless constructor.
TODO: Figure out how to make this truely singleton even with dependency injection for tests</p>
@@ -157,7 +117,6 @@ TODO: Figure out how to make this truely singleton even with dependency injectio
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/WorkspaceService.cs/#L64">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_CurrentSettings_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.CurrentSettings*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_CurrentSettings" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.CurrentSettings">CurrentSettings</h4>
<div class="markdown level1 summary"><p>Current settings for the workspace</p>
</div>
@@ -166,7 +125,7 @@ TODO: Figure out how to make this truely singleton even with dependency injectio
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TConfig CurrentSettings { 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>
@@ -188,7 +147,6 @@ TODO: Figure out how to make this truely singleton even with dependency injectio
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/WorkspaceService.cs/#L33">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_Instance_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.Instance*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_Instance" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.Instance">Instance</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
@@ -196,7 +154,7 @@ TODO: Figure out how to make this truely singleton even with dependency injectio
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static WorkspaceService&lt;TConfig&gt; Instance { 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>
@@ -218,7 +176,6 @@ TODO: Figure out how to make this truely singleton even with dependency injectio
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/WorkspaceService.cs/#L59">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_Workspace_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.Workspace*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_Workspace" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.Workspace">Workspace</h4>
<div class="markdown level1 summary"><p>Workspace object for the service. Virtual to allow for mocking</p>
</div>
@@ -227,7 +184,7 @@ TODO: Figure out how to make this truely singleton even with dependency injectio
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual Workspace Workspace { 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>
@@ -251,7 +208,6 @@ TODO: Figure out how to make this truely singleton even with dependency injectio
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/WorkspaceService.cs/#L120">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_InitializeService_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.InitializeService*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_InitializeService_Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.InitializeService(Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost)">InitializeService(ServiceHost)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
@@ -271,7 +227,7 @@ TODO: Figure out how to make this truely singleton even with dependency injectio
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.html">ServiceHost</a></td>
<td><span class="parametername">serviceHost</span></td>
<td><em>serviceHost</em></td>
<td></td>
</tr>
</tbody>
@@ -283,7 +239,6 @@ TODO: Figure out how to make this truely singleton even with dependency injectio
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/WorkspaceService.cs/#L162">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_RegisterConfigChangeCallback_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.RegisterConfigChangeCallback*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_RegisterConfigChangeCallback_Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService__0__ConfigChangeCallback_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.RegisterConfigChangeCallback(Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService{`0}.ConfigChangeCallback)">RegisterConfigChangeCallback(WorkspaceService&lt;TConfig&gt;.ConfigChangeCallback)</h4>
<div class="markdown level1 summary"><p>Adds a new task to be called when the configuration has been changed. Use this to
handle changing configuration and changing the current configuration.</p>
@@ -305,7 +260,7 @@ handle changing configuration and changing the current configuration.</p>
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService-1.ConfigChangeCallback.html">WorkspaceService.ConfigChangeCallback</a>&lt;&gt;</td>
<td><span class="parametername">task</span></td>
<td><em>task</em></td>
<td><p>Task to handle the request</p>
</td>
</tr>
@@ -318,7 +273,6 @@ handle changing configuration and changing the current configuration.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/WorkspaceService.cs/#L171">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_RegisterTextDocChangeCallback_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.RegisterTextDocChangeCallback*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_RegisterTextDocChangeCallback_Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService__0__TextDocChangeCallback_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.RegisterTextDocChangeCallback(Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService{`0}.TextDocChangeCallback)">RegisterTextDocChangeCallback(WorkspaceService&lt;TConfig&gt;.TextDocChangeCallback)</h4>
<div class="markdown level1 summary"><p>Adds a new task to be called when the text of a document changes.</p>
</div>
@@ -339,7 +293,7 @@ handle changing configuration and changing the current configuration.</p>
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService-1.TextDocChangeCallback.html">WorkspaceService.TextDocChangeCallback</a>&lt;&gt;</td>
<td><span class="parametername">task</span></td>
<td><em>task</em></td>
<td><p>Delegate to call when the document changes</p>
</td>
</tr>
@@ -352,7 +306,6 @@ handle changing configuration and changing the current configuration.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/WorkspaceService.cs/#L180">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_RegisterTextDocCloseCallback_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.RegisterTextDocCloseCallback*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_RegisterTextDocCloseCallback_Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService__0__TextDocCloseCallback_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.RegisterTextDocCloseCallback(Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService{`0}.TextDocCloseCallback)">RegisterTextDocCloseCallback(WorkspaceService&lt;TConfig&gt;.TextDocCloseCallback)</h4>
<div class="markdown level1 summary"><p>Adds a new task to be called when a text document closes.</p>
</div>
@@ -373,7 +326,7 @@ handle changing configuration and changing the current configuration.</p>
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService-1.TextDocCloseCallback.html">WorkspaceService.TextDocCloseCallback</a>&lt;&gt;</td>
<td><span class="parametername">task</span></td>
<td><em>task</em></td>
<td><p>Delegate to call when the document closes</p>
</td>
</tr>
@@ -386,7 +339,6 @@ handle changing configuration and changing the current configuration.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/WorkspaceService.cs/#L189">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_RegisterTextDocOpenCallback_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.RegisterTextDocOpenCallback*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1_RegisterTextDocOpenCallback_Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService__0__TextDocOpenCallback_" data-uid="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService`1.RegisterTextDocOpenCallback(Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService{`0}.TextDocOpenCallback)">RegisterTextDocOpenCallback(WorkspaceService&lt;TConfig&gt;.TextDocOpenCallback)</h4>
<div class="markdown level1 summary"><p>Adds a new task to be called when a file is opened</p>
</div>
@@ -407,7 +359,7 @@ handle changing configuration and changing the current configuration.</p>
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService-1.TextDocOpenCallback.html">WorkspaceService.TextDocOpenCallback</a>&lt;&gt;</td>
<td><span class="parametername">task</span></td>
<td><em>task</em></td>
<td><p>Delegate to call when a document is opened</p>
</td>
</tr>
@@ -437,16 +389,9 @@ handle changing configuration and changing the current configuration.</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>