Class ExecuteCommandArguments

Namespace

NMF.AnyText

Assembly

NMF.AnyText.Core.dll

Represents the arguments for executing a command on a document.

public abstract class ExecuteCommandArguments

Inheritance

object

ExecuteCommandArguments

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Context

ParseContext of the Document

public ParseContext Context { get; set; }

Property Value

ParseContext

DocumentUri

URI of the document.

public string DocumentUri { get; set; }

Property Value

string

End

Ending position of the Range.

public ParsePosition End { get; set; }

Property Value

ParsePosition

OtherOptions

Additional options for the command execution.

public Dictionary<string, object> OtherOptions { get; set; }

Property Value

Dictionary<string, object>

RuleApplication

RuleApplication of the Action

public RuleApplication RuleApplication { get; set; }

Property Value

RuleApplication

Start

Starting position of the Range.

public ParsePosition Start { get; set; }

Property Value

ParsePosition

Methods

SendLog(string, MessageType)

Sends a log to the client

public abstract Task SendLog(string message, MessageType messageType = MessageType.Info)

Parameters

message string

the message to log

messageType MessageType

the type of the message

Returns

Task

ShowDocument(string, ParseRange?, bool, bool)

Requests a client to open a document

public abstract Task ShowDocument(string uri, ParseRange? selection = null, bool external = false, bool takeFocus = false)

Parameters

uri string

The URI of the document to show.

selection ParseRange?

The optional selection range in the document.

external bool

If true, requests to open the document externally.

takeFocus bool

If true, requests the client to take focus.

Returns

Task

ShowNotification(string, MessageType)

Shows a notification to the client

public abstract Task ShowNotification(string message, MessageType messageType = MessageType.Info)

Parameters

message string

the notification

messageType MessageType

the type of the message

Returns

Task

ShowReferences(ParsePosition)

Requests a client to show references of a symbol

public abstract Task ShowReferences(ParsePosition position)

Parameters

position ParsePosition

The position of the symbol in the document

Returns

Task

ShowRequest(string, MessageType, params string[])

Shows a message to the client

public abstract Task<string> ShowRequest(string message, MessageType messageType = MessageType.Info, params string[] buttons)

Parameters

message string

the message to show

messageType MessageType

the type of the message

buttons string[]

the available buttons for the user

Returns

Task<string>