Partager via

IOpenDocumentService Interface

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.RpcContracts.OpenDocument
Assembly:
Microsoft.VisualStudio.RpcContracts.dll
Package:
Microsoft.VisualStudio.RpcContracts v17.12.12

Allows opening documents on the client.

public interface class IOpenDocumentService
public interface IOpenDocumentService
type IOpenDocumentService = interface
Public Interface IOpenDocumentService

Methods

OpenDocumentAsync(String, CancellationToken)

Opens document at the given local file path with the default editor for that document. If the path represents local file path of a remote file and can be converted to remote URI via ConvertLocalUriToRemoteUriAsync(Uri, CancellationToken), the remote file will be downloaded and opened.
OpenDocumentAsync(Uri, OpenDocumentOptions, CancellationToken)

Opens document at the given documentUri. If the document is already open, its document frame is activated and openDocumentOptions are applied. If the documentUri represents local file path of a remote file and can be converted to remote URI via ConvertLocalUriToRemoteUriAsync(Uri, CancellationToken), the remote file will be downloaded and opened. If the document is already open, openDocumentOptions are applied to that already open document instead (for example Selection).
OpenDocumentWithEditorSelectionAsync(String, CancellationToken)

Opens document at the given local file path with an editor selected by the user. If the path represents local file path of a remote file and can be converted to remote URI via ConvertLocalUriToRemoteUriAsync(Uri, CancellationToken), the remote file will be downloaded and opened.

Applies to