C# Class SuperPutty.SuperPuTTY

Represents the SuperPuTTY application itself
Exibir arquivo Open project: sepich/superputty Class Usage Examples

Private Properties

Property Type Description
ApplyIconForWindow void

Public Methods

Method Description
AddLayout ( String file ) : void
AddSession ( SessionData session ) : bool

Add a new session to the in-application session database

ApplyDockRestrictions ( DockContent panel ) : void

Apply docking restrictions to a panel, such as restricting a panel from floating

ApplyDockRestrictions ( DockPanel panel ) : void

Apply docking restrictions to a ToolWindowDocument window such as preventing a window opening from outside the tabbed interface

FindLayout ( String name ) : SuperPutty.Data.LayoutData
GetAllSessions ( ) : List

Get a list of all sessions from the in-application database

GetIconForSession ( SessionData session ) : Icon

Get the Icon defined for the specified session

GetSessionById ( string sessionId ) : SessionData

Get a Session by its SessionData.SessionID

ImportSessions ( List sessions, string folder ) : void

Import sessions from a from a List object into the specified folder

ImportSessionsFromFile ( string fileName ) : void

Import sessions from the specified file into the in-application database

ImportSessionsFromPuTTY ( ) : void

Import sessions from Windows Registry which were set by PuTTY or KiTTY and load them into the in-application sessions database

ImportSessionsFromPuttyCM ( string fileExport ) : void

Import sessions from Windows Registry which were set by PuttYCM and load them into the in-application sessions database

ImportSessionsFromSuperPutty1030 ( ) : void

Import sessions from older version of SuperPuTTY from the Windows Registry

Initialize ( string args ) : void
LoadImageList ( string theme ) : ImageList

Load Images from themes folder

LoadLayout ( SuperPutty.Data.LayoutData layout ) : void
LoadLayout ( SuperPutty.Data.LayoutData layout, bool isNewLayoutAlreadyActive ) : void
LoadLayoutInNewInstance ( SuperPutty.Data.LayoutData layout ) : void
LoadLayouts ( ) : void
LoadSessionInNewInstance ( string sessionId ) : void
LoadSessions ( ) : void

Load sessions database from file into the application

MakeUniqueSessionId ( string sessionId ) : string

Generate a unique session ID to prevent collisions in the in-application data store, used when importing and merging sessions from another application or an older versin of SuperPuTTY

OpenPuttySession ( SessionData session ) : void

Open a new putty window with its settings being passed in a SessionData object

OpenPuttySession ( string sessionId ) : void

Retrieve a SessionData object and open a new putty window

OpenScpSession ( SessionData session ) : void

Open a new putty scp window with its settings being passed in a SessionData object

OpenScpSession ( string sessionId ) : void

Retrieve a SessionData object and open a new putty scp window

OpenSession ( SuperPutty.Data.SessionDataStartInfo ssi ) : void
RemoveLayout ( String name, bool deleteFile ) : void
RemoveSession ( string sessionId ) : bool

Remove a session from the in-application sessions database.

RenameLayout ( SuperPutty.Data.LayoutData layout, string newName ) : void
ReportStatus ( String status ) : void

Send status message to toolstrip

SaveSessions ( ) : void

Save in-application Session Database to XML File

SetLayoutAsDefault ( string layoutName ) : void
Shutdown ( ) : void

Called when application is shutting down, sends message to log.

Private Methods

Method Description
ApplyIconForWindow ( SuperPutty.ToolWindow win, SessionData session ) : void

Method Details

AddLayout() public static method

public static AddLayout ( String file ) : void
file String
return void

AddSession() public static method

Add a new session to the in-application session database
public static AddSession ( SessionData session ) : bool
session SessionData A object containing the configuration of a session
return bool

ApplyDockRestrictions() public static method

Apply docking restrictions to a panel, such as restricting a panel from floating
public static ApplyDockRestrictions ( DockContent panel ) : void
panel WeifenLuo.WinFormsUI.Docking.DockContent The panel to apply the restrictions to
return void

ApplyDockRestrictions() public static method

Apply docking restrictions to a ToolWindowDocument window such as preventing a window opening from outside the tabbed interface
public static ApplyDockRestrictions ( DockPanel panel ) : void
panel WeifenLuo.WinFormsUI.Docking.DockPanel The to apply the restrictions to
return void

FindLayout() public static method

public static FindLayout ( String name ) : SuperPutty.Data.LayoutData
name String
return SuperPutty.Data.LayoutData

GetAllSessions() public static method

Get a list of all sessions from the in-application database
public static GetAllSessions ( ) : List
return List

GetIconForSession() public static method

Get the Icon defined for the specified session
public static GetIconForSession ( SessionData session ) : Icon
session SessionData The session configuration data
return System.Drawing.Icon

GetSessionById() public static method

Get a Session by its SessionData.SessionID
public static GetSessionById ( string sessionId ) : SessionData
sessionId string A string which represents a session
return SessionData

ImportSessions() public static method

Import sessions from a from a List object into the specified folder
public static ImportSessions ( List sessions, string folder ) : void
sessions List A of objects
folder string The destination folder name
return void

ImportSessionsFromFile() public static method

Import sessions from the specified file into the in-application database
public static ImportSessionsFromFile ( string fileName ) : void
fileName string A string containing the path of the filename that holds session configuration
return void

ImportSessionsFromPuTTY() public static method

Import sessions from Windows Registry which were set by PuTTY or KiTTY and load them into the in-application sessions database
public static ImportSessionsFromPuTTY ( ) : void
return void

ImportSessionsFromPuttyCM() public static method

Import sessions from Windows Registry which were set by PuttYCM and load them into the in-application sessions database
public static ImportSessionsFromPuttyCM ( string fileExport ) : void
fileExport string
return void

ImportSessionsFromSuperPutty1030() public static method

Import sessions from older version of SuperPuTTY from the Windows Registry
public static ImportSessionsFromSuperPutty1030 ( ) : void
return void

Initialize() public static method

public static Initialize ( string args ) : void
args string
return void

LoadImageList() public static method

Load Images from themes folder
public static LoadImageList ( string theme ) : ImageList
theme string the name of the theme folder
return System.Windows.Forms.ImageList

LoadLayout() public static method

public static LoadLayout ( SuperPutty.Data.LayoutData layout ) : void
layout SuperPutty.Data.LayoutData
return void

LoadLayout() public static method

public static LoadLayout ( SuperPutty.Data.LayoutData layout, bool isNewLayoutAlreadyActive ) : void
layout SuperPutty.Data.LayoutData
isNewLayoutAlreadyActive bool
return void

LoadLayoutInNewInstance() public static method

public static LoadLayoutInNewInstance ( SuperPutty.Data.LayoutData layout ) : void
layout SuperPutty.Data.LayoutData
return void

LoadLayouts() public static method

public static LoadLayouts ( ) : void
return void

LoadSessionInNewInstance() public static method

public static LoadSessionInNewInstance ( string sessionId ) : void
sessionId string
return void

LoadSessions() public static method

Load sessions database from file into the application
public static LoadSessions ( ) : void
return void

MakeUniqueSessionId() public static method

Generate a unique session ID to prevent collisions in the in-application data store, used when importing and merging sessions from another application or an older versin of SuperPuTTY
public static MakeUniqueSessionId ( string sessionId ) : string
sessionId string A string containing the sessionID of the session being imported
return string

OpenPuttySession() public static method

Open a new putty window with its settings being passed in a SessionData object
public static OpenPuttySession ( SessionData session ) : void
session SessionData The object containing the settings
return void

OpenPuttySession() public static method

Retrieve a SessionData object and open a new putty window
public static OpenPuttySession ( string sessionId ) : void
sessionId string A string containing the of the session
return void

OpenScpSession() public static method

Open a new putty scp window with its settings being passed in a SessionData object
public static OpenScpSession ( SessionData session ) : void
session SessionData The object containing the settings
return void

OpenScpSession() public static method

Retrieve a SessionData object and open a new putty scp window
public static OpenScpSession ( string sessionId ) : void
sessionId string A string containing the of the session
return void

OpenSession() public static method

public static OpenSession ( SuperPutty.Data.SessionDataStartInfo ssi ) : void
ssi SuperPutty.Data.SessionDataStartInfo
return void

RemoveLayout() public static method

public static RemoveLayout ( String name, bool deleteFile ) : void
name String
deleteFile bool
return void

RemoveSession() public static method

Remove a session from the in-application sessions database.
public static RemoveSession ( string sessionId ) : bool
sessionId string The of the session to remove
return bool

RenameLayout() public static method

public static RenameLayout ( SuperPutty.Data.LayoutData layout, string newName ) : void
layout SuperPutty.Data.LayoutData
newName string
return void

ReportStatus() public static method

Send status message to toolstrip
public static ReportStatus ( String status ) : void
status String A string containing the message
return void

SaveSessions() public static method

Save in-application Session Database to XML File
public static SaveSessions ( ) : void
return void

SetLayoutAsDefault() public static method

public static SetLayoutAsDefault ( string layoutName ) : void
layoutName string
return void

Shutdown() public static method

Called when application is shutting down, sends message to log.
public static Shutdown ( ) : void
return void