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

458 lines
30 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 WorkspaceService&lt;TConfig&gt;
</title>
<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="../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_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
opening and closing of files, the changing of configuration, etc.</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"><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>
<div class="codewrapper">
<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">
<span class="divider">|</span>
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService_1__ctor.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService%601.%23ctor%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/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>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public WorkspaceService()</code></pre>
</div>
<h3 id="properties">Properties
</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_WorkspaceService_1_CurrentSettings.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService%601.CurrentSettings%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/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>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TConfig CurrentSettings { get; }</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">TConfig</span></td>
<td></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_WorkspaceService_1_Instance.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService%601.Instance%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/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>
<h5 class="decalaration">Declaration</h5>
<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>
<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.WorkspaceService-1.html">WorkspaceService</a>&lt;TConfig&gt;</td>
<td></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_WorkspaceService_1_Workspace.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService%601.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">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/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>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual Workspace Workspace { get; }</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="Microsoft.SqlTools.ServiceLayer.Workspace.Workspace.html">Workspace</a></td>
<td></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_WorkspaceService_1_InitializeService_Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService%601.InitializeService(Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost)%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/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>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void InitializeService(ServiceHost serviceHost)</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.Hosting.ServiceHost.html">ServiceHost</a></td>
<td><span class="parametername">serviceHost</span></td>
<td></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_WorkspaceService_1_RegisterConfigChangeCallback_Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService__0__ConfigChangeCallback_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService%601.RegisterConfigChangeCallback(Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService%7B%600%7D.ConfigChangeCallback)%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/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>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void RegisterConfigChangeCallback(WorkspaceService&lt;TConfig&gt;.ConfigChangeCallback task)</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.WorkspaceService-1.ConfigChangeCallback.html">WorkspaceService.ConfigChangeCallback</a>&lt;&gt;</td>
<td><span class="parametername">task</span></td>
<td><p>Task to handle the request</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_WorkspaceService_1_RegisterTextDocChangeCallback_Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService__0__TextDocChangeCallback_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService%601.RegisterTextDocChangeCallback(Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService%7B%600%7D.TextDocChangeCallback)%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/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>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void RegisterTextDocChangeCallback(WorkspaceService&lt;TConfig&gt;.TextDocChangeCallback task)</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.WorkspaceService-1.TextDocChangeCallback.html">WorkspaceService.TextDocChangeCallback</a>&lt;&gt;</td>
<td><span class="parametername">task</span></td>
<td><p>Delegate to call when the document changes</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_WorkspaceService_1_RegisterTextDocCloseCallback_Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService__0__TextDocCloseCallback_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService%601.RegisterTextDocCloseCallback(Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService%7B%600%7D.TextDocCloseCallback)%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/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>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void RegisterTextDocCloseCallback(WorkspaceService&lt;TConfig&gt;.TextDocCloseCallback task)</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.WorkspaceService-1.TextDocCloseCallback.html">WorkspaceService.TextDocCloseCallback</a>&lt;&gt;</td>
<td><span class="parametername">task</span></td>
<td><p>Delegate to call when the document closes</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_WorkspaceService_1_RegisterTextDocOpenCallback_Microsoft_SqlTools_ServiceLayer_Workspace_WorkspaceService__0__TextDocOpenCallback_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService%601.RegisterTextDocOpenCallback(Microsoft.SqlTools.ServiceLayer.Workspace.WorkspaceService%7B%600%7D.TextDocOpenCallback)%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/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>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void RegisterTextDocOpenCallback(WorkspaceService&lt;TConfig&gt;.TextDocOpenCallback task)</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.WorkspaceService-1.TextDocOpenCallback.html">WorkspaceService.TextDocOpenCallback</a>&lt;&gt;</td>
<td><span class="parametername">task</span></td>
<td><p>Delegate to call when a document is opened</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_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="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Workspace/WorkspaceService.cs/#L26" 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