sphinx-autoapi/tests/Microsoft.CodeAnalysis.AdhocWorkspace.yaml

id: Microsoft.CodeAnalysis.AdhocWorkspace
yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
href: api/Microsoft.CodeAnalysis.AdhocWorkspace
name:
  CSharp: AdhocWorkspace
qualifiedName:
  CSharp: Microsoft.CodeAnalysis.AdhocWorkspace
type: Class
source:
  remote:
    branch: master
    repo: https://github.com/chenkennt/roslyn.git
    local: C:/roslyn/
    sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
  path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
  startLine: 16
summary: >+
  A workspace that allows full manipulation of projects and documents,

  but does not persist changes.

syntax:
  content:
    CSharp: public sealed class AdhocWorkspace
inheritance:
- id: System.Object
  name: System.Object
  isExternal: true
- id: Microsoft.CodeAnalysis.Workspace
  name: Workspace
  href: api/Microsoft.CodeAnalysis.Workspace
items:
- id: Microsoft.CodeAnalysis.AdhocWorkspace.#ctor(Microsoft.CodeAnalysis.Host.HostServices,System.String)
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: AdhocWorkspace(Microsoft.CodeAnalysis.Host.HostServices,System.String)
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.AdhocWorkspace(Microsoft.CodeAnalysis.Host.HostServices,System.String)
  type: Constructor
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 18
  syntax:
    content:
      CSharp: 'public AdhocWorkspace(HostServices host, string workspaceKind = "Custom"): base (host, workspaceKind)'
    parameters:
    - id: host
      type:
        id: Microsoft.CodeAnalysis.Host.HostServices
        name: HostServices
        href: api/Microsoft.CodeAnalysis.Host.HostServices
    - id: workspaceKind
      type:
        id: System.String
        name: System.String
        isExternal: true
- id: Microsoft.CodeAnalysis.AdhocWorkspace.#ctor
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: AdhocWorkspace
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.AdhocWorkspace
  type: Constructor
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 23
  syntax:
    content:
      CSharp: 'public AdhocWorkspace(): this (Host.Mef.MefHostServices.DefaultHost)'
    parameters: []
- id: Microsoft.CodeAnalysis.AdhocWorkspace.CanApplyChange(Microsoft.CodeAnalysis.ApplyChangesKind)
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: CanApplyChange
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.CanApplyChange(Microsoft.CodeAnalysis.ApplyChangesKind)
  type: Method
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 28
  syntax:
    content:
      CSharp: public override bool CanApplyChange(ApplyChangesKind feature)
    parameters:
    - id: feature
      type:
        id: Microsoft.CodeAnalysis.ApplyChangesKind
        name: ApplyChangesKind
        href: api/Microsoft.CodeAnalysis.ApplyChangesKind
    return:
      id: Boolean
- id: Microsoft.CodeAnalysis.AdhocWorkspace.CanOpenDocuments
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: CanOpenDocuments
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.CanOpenDocuments
  type: Property
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 34
  syntax:
    content:
      CSharp: public override bool CanOpenDocuments
    parameters:
    - id: CanOpenDocuments
      type:
        id: System.Boolean
        name: System.Boolean
        isExternal: true
- id: Microsoft.CodeAnalysis.AdhocWorkspace.get_CanOpenDocuments
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: get_CanOpenDocuments
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.get_CanOpenDocuments
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 36
- id: Microsoft.CodeAnalysis.AdhocWorkspace.ClearSolution
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: ClearSolution
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.ClearSolution
  type: Method
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 46
  summary: >+
    Clears all projects and documents from the workspace.

  syntax:
    content:
      CSharp: public new void ClearSolution()
    parameters: []
    return:
      id: Void
- id: Microsoft.CodeAnalysis.AdhocWorkspace.AddSolution(Microsoft.CodeAnalysis.SolutionInfo)
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: AddSolution
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.AddSolution(Microsoft.CodeAnalysis.SolutionInfo)
  type: Method
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 54
  summary: >+
    Adds an entire solution to the workspace, replacing any existing solution.

  syntax:
    content:
      CSharp: public Solution AddSolution(SolutionInfo solutionInfo)
    parameters:
    - id: solutionInfo
      type:
        id: Microsoft.CodeAnalysis.SolutionInfo
        name: SolutionInfo
        href: api/Microsoft.CodeAnalysis.SolutionInfo
    return:
      id: Solution
- id: Microsoft.CodeAnalysis.AdhocWorkspace.AddProject(System.String,System.String)
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: AddProject
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.AddProject(System.String,System.String)
  type: Method
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 69
  summary: >+
    Adds a project to the workspace. All previous projects remain intact.

  syntax:
    content:
      CSharp: public Project AddProject(string name, string language)
    parameters:
    - id: name
      type:
        id: System.String
        name: System.String
        isExternal: true
    - id: language
      type:
        id: System.String
        name: System.String
        isExternal: true
    return:
      id: Project
- id: Microsoft.CodeAnalysis.AdhocWorkspace.AddProject(Microsoft.CodeAnalysis.ProjectInfo)
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: AddProject
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.AddProject(Microsoft.CodeAnalysis.ProjectInfo)
  type: Method
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 78
  summary: >+
    Adds a project to the workspace. All previous projects remain intact.

  syntax:
    content:
      CSharp: public Project AddProject(ProjectInfo projectInfo)
    parameters:
    - id: projectInfo
      type:
        id: Microsoft.CodeAnalysis.ProjectInfo
        name: ProjectInfo
        href: api/Microsoft.CodeAnalysis.ProjectInfo
    return:
      id: Project
- id: Microsoft.CodeAnalysis.AdhocWorkspace.AddProjects(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.ProjectInfo})
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: AddProjects
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.AddProjects(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.ProjectInfo})
  type: Method
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 94
  summary: >+
    Adds multiple projects to the workspace at once. All existing projects remain intact.

  syntax:
    content:
      CSharp: public void AddProjects(IEnumerable<ProjectInfo> projectInfos)
    parameters:
    - id: projectInfos
      type:
        id: System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.ProjectInfo}
        name: System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.ProjectInfo}
        isExternal: true
    return:
      id: Void
- id: Microsoft.CodeAnalysis.AdhocWorkspace.AddDocument(Microsoft.CodeAnalysis.ProjectId,System.String,Microsoft.CodeAnalysis.Text.SourceText)
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: AddDocument
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.AddDocument(Microsoft.CodeAnalysis.ProjectId,System.String,Microsoft.CodeAnalysis.Text.SourceText)
  type: Method
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 110
  summary: >+
    Adds a document to the workspace.

  syntax:
    content:
      CSharp: public Document AddDocument(ProjectId projectId, string name, SourceText text)
    parameters:
    - id: projectId
      type:
        id: Microsoft.CodeAnalysis.ProjectId
        name: ProjectId
        href: api/Microsoft.CodeAnalysis.ProjectId
    - id: name
      type:
        id: System.String
        name: System.String
        isExternal: true
    - id: text
      type:
        id: Microsoft.CodeAnalysis.Text.SourceText
        name: SourceText
        href: Microsoft.CodeAnalysis.Text.SourceText
    return:
      id: Document
- id: Microsoft.CodeAnalysis.AdhocWorkspace.AddDocument(Microsoft.CodeAnalysis.DocumentInfo)
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: AddDocument
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.AddDocument(Microsoft.CodeAnalysis.DocumentInfo)
  type: Method
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 136
  summary: >+
    Adds a document to the workspace.

  syntax:
    content:
      CSharp: public Document AddDocument(DocumentInfo documentInfo)
    parameters:
    - id: documentInfo
      type:
        id: Microsoft.CodeAnalysis.DocumentInfo
        name: DocumentInfo
        href: api/Microsoft.CodeAnalysis.DocumentInfo
    return:
      id: Document
- id: Microsoft.CodeAnalysis.AdhocWorkspace.OpenDocument(Microsoft.CodeAnalysis.DocumentId,System.Boolean)
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: OpenDocument
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.OpenDocument(Microsoft.CodeAnalysis.DocumentId,System.Boolean)
  type: Method
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 151
  summary: >+
    Puts the specified document into the open state.

  syntax:
    content:
      CSharp: public override void OpenDocument(DocumentId documentId, bool activate = true)
    parameters:
    - id: documentId
      type:
        id: Microsoft.CodeAnalysis.DocumentId
        name: DocumentId
        href: api/Microsoft.CodeAnalysis.DocumentId
    - id: activate
      type:
        id: System.Boolean
        name: System.Boolean
        isExternal: true
    return:
      id: Void
- id: Microsoft.CodeAnalysis.AdhocWorkspace.CloseDocument(Microsoft.CodeAnalysis.DocumentId)
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: CloseDocument
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.CloseDocument(Microsoft.CodeAnalysis.DocumentId)
  type: Method
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 164
  summary: >+
    Puts the specified document into the closed state.

  syntax:
    content:
      CSharp: public override void CloseDocument(DocumentId documentId)
    parameters:
    - id: documentId
      type:
        id: Microsoft.CodeAnalysis.DocumentId
        name: DocumentId
        href: api/Microsoft.CodeAnalysis.DocumentId
    return:
      id: Void
- id: Microsoft.CodeAnalysis.AdhocWorkspace.OpenAdditionalDocument(Microsoft.CodeAnalysis.DocumentId,System.Boolean)
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: OpenAdditionalDocument
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.OpenAdditionalDocument(Microsoft.CodeAnalysis.DocumentId,System.Boolean)
  type: Method
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 179
  summary: >+
    Puts the specified additional document into the open state.

  syntax:
    content:
      CSharp: public override void OpenAdditionalDocument(DocumentId documentId, bool activate = true)
    parameters:
    - id: documentId
      type:
        id: Microsoft.CodeAnalysis.DocumentId
        name: DocumentId
        href: api/Microsoft.CodeAnalysis.DocumentId
    - id: activate
      type:
        id: System.Boolean
        name: System.Boolean
        isExternal: true
    return:
      id: Void
- id: Microsoft.CodeAnalysis.AdhocWorkspace.CloseAdditionalDocument(Microsoft.CodeAnalysis.DocumentId)
  yaml: api/Microsoft.CodeAnalysis.AdhocWorkspace.yaml
  href: api/Microsoft.CodeAnalysis.AdhocWorkspace
  name:
    CSharp: CloseAdditionalDocument
  qualifiedName:
    CSharp: Microsoft.CodeAnalysis.AdhocWorkspace.CloseAdditionalDocument(Microsoft.CodeAnalysis.DocumentId)
  type: Method
  source:
    remote:
      branch: master
      repo: https://github.com/chenkennt/roslyn.git
      local: C:/roslyn/
      sha1: 8c49d3e937ebadb974cebab7db31e1800918265d
    path: src/Workspaces/Core/Portable/Workspace/AdhocWorkspace.cs
    startLine: 192
  summary: >+
    Puts the specified additional document into the closed state

  syntax:
    content:
      CSharp: public override void CloseAdditionalDocument(DocumentId documentId)
    parameters:
    - id: documentId
      type:
        id: Microsoft.CodeAnalysis.DocumentId
        name: DocumentId
        href: api/Microsoft.CodeAnalysis.DocumentId
    return:
      id: Void