Rebex
Products Downloads Buy Support Contact
Show / Hide Table of Contents

VirtualTerminal Class

Namespace: Rebex.TerminalEmulation
Assembly: Rebex.Terminal.dll (version 7.0.9119)

Represents a virtual off-screen terminal.

Syntax
public class VirtualTerminal : ITerminal, IDisposable
Inheritance
Object
VirtualTerminal
Implements
ITerminal
IDisposable
Inherited Members
Object.Equals(Object)
Object.Equals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Object.ReferenceEquals(Object, Object)
Object.ToString()

Constructors

Name Description
VirtualTerminal(Int32, Int32)

Creates a new instance of the virtual terminal.

VirtualTerminal(Int32, Int32, Int32)

Creates a new instance of the virtual terminal.

Properties

Name Description
HistoryLength

Gets the current history buffer length.

IsDisposed

Gets a value indicating whether the terminal is disposed.

Options

Gets or sets terminal options.

Palette

Gets or sets the terminal palette.

Recorder

Gets or sets incoming data recorder.

Screen

Gets the terminal screen object.

Scripting

Gets the object which allows enhanced scripting.

Transfers

Gets the object which allows file transferring.

Methods

Name Description
Bind(IShellChannelFactory)

Binds the terminal to the specified shell channel factory - usually an instance of Rebex.Net.Ssh or Rebex.Net.Telnet class.

BindAsync(IShellChannelFactory, Object)

Begins asynchronous Bind operation. Binds the terminal to the specified shell channel factory - usually an instance of Rebex.Net.Ssh or Rebex.Net.Telnet class.

Dispose()

Disposes the VirtualTerminal object and closes the channel associated with it.

Save(Stream, TerminalCaptureFormat)

Saves the content of the terminal screen to the specified stream in the specified format.

Save(Stream, TerminalCaptureFormat, TerminalCaptureOptions)

Saves the content of the terminal screen to the specified stream in the specified format with the specified options.

Save(String, TerminalCaptureFormat)

Saves the content of the terminal screen to the specified file in the specified format.

Save(String, TerminalCaptureFormat, TerminalCaptureOptions)

Saves the content of the terminal screen to the specified file in the specified format with the specified options.

SetScreenSize(Int32, Int32)

Sets a new screen size.

Unbind()

Unbinds the terminal from the current channel and closes the channel.

Events

Name Description
ActionRequested

Occurs when a specific client action is requested by the server.

DataReceived

Occurs when the data are received from the server.

Disconnected

Occurs when disconnected from the server.

RemoteResize

Occurs when the screen resize is requested by the server.

Extension Methods

TerminalExtensions.SetCustomScreen(ITerminal, IScreen)
VirtualTerminalExtensions.Save(VirtualTerminal, Stream, TerminalImageFormat, TerminalCaptureOptions, TerminalFont)
VirtualTerminalExtensions.Save(VirtualTerminal, Stream, TerminalImageFormat, TerminalFont)
VirtualTerminalExtensions.Save(VirtualTerminal, String, TerminalImageFormat, TerminalCaptureOptions, TerminalFont)
VirtualTerminalExtensions.Save(VirtualTerminal, String, TerminalImageFormat, TerminalFont)
In This Article
© REBEX ČR s.r.o. Back to top
Privacy policy
Manage cookies