TRIM.SDK.DesktopHelper Class Reference

The DesktopHelper class is designed to manage the process of selecting an initial startup database for the user. It also has a number of properties that provided some defaults for a TRIM Desktop user. More...

Public Member Functions
	DesktopHelper ()
Database	GetDatabase (Hwnd parentHWND)
Database	GetDatabase (Hwnd parentHWND, bool allowOfflineState, bool openInOfflineState)
Database	GetDatabase (Hwnd parentHWND, bool allowOfflineState, bool openInOfflineState, string onlyThisDatabaseId, string onThisWorkgroupServer)
Database	SelectDatabase (Hwnd parentHWND)
Database	SelectDatabase (Hwnd parentHWND, bool allowOfflineState, bool openInOfflineState)
void	LaunchDesktop (Database startupDB, DesktopStartStates startupWith)
	Launches the TRIM Desktop executable, starting up with the specified startup window More...

Protected Attributes
bool	swigCMemOwn

Properties
string	PreferredDatabaseId [get, set]
	Gets or sets a string indicating a preference for a particular database. More...
string	PreferredWorkgroup [get, set]
	Gets or sets a string indicating a preference for a particular workgroup. More...
int	PreferredPort [get, set]
	Gets or sets a number indicating the preferred port number to use when connecting to a particular workgroup. More...
static bool	AutoStartWorkgroup [get, set]
	Sets a boolean variable to indicate whether an attempt should be made to automatically start a local workgroup if it in not currently running on the local machine. More...

Detailed Description

The DesktopHelper class is designed to manage the process of selecting an initial startup database for the user. It also has a number of properties that provided some defaults for a TRIM Desktop user.

Constructor & Destructor Documentation

DesktopHelper()

TRIM.SDK.DesktopHelper.DesktopHelper

(

)

Member Function Documentation

GetDatabase() [1/3]

Database TRIM.SDK.DesktopHelper.GetDatabase

(

Hwnd

parentHWND

)

GetDatabase() [2/3]

Database TRIM.SDK.DesktopHelper.GetDatabase	(	Hwnd	parentHWND,
		bool	allowOfflineState,
		bool	openInOfflineState
	)

GetDatabase() [3/3]

Database TRIM.SDK.DesktopHelper.GetDatabase	(	Hwnd	parentHWND,
		bool	allowOfflineState,
		bool	openInOfflineState,
		string	onlyThisDatabaseId,
		string	onThisWorkgroupServer
	)

LaunchDesktop()

void TRIM.SDK.DesktopHelper.LaunchDesktop	(	Database	startupDB,
		DesktopStartStates	startupWith
	)

Launches the TRIM Desktop executable, starting up with the specified startup window

SelectDatabase() [1/2]

Database TRIM.SDK.DesktopHelper.SelectDatabase

(

Hwnd

parentHWND

)

SelectDatabase() [2/2]

Database TRIM.SDK.DesktopHelper.SelectDatabase	(	Hwnd	parentHWND,
		bool	allowOfflineState,
		bool	openInOfflineState
	)

Member Data Documentation

swigCMemOwn

bool TRIM.SDK.DesktopHelper.swigCMemOwn

protected

Property Documentation

AutoStartWorkgroup

bool TRIM.SDK.DesktopHelper.AutoStartWorkgroup

staticgetset

Sets a boolean variable to indicate whether an attempt should be made to automatically start a local workgroup if it in not currently running on the local machine.

PreferredDatabaseId

string TRIM.SDK.DesktopHelper.PreferredDatabaseId

getset

Gets or sets a string indicating a preference for a particular database.

PreferredPort

int TRIM.SDK.DesktopHelper.PreferredPort

getset

Gets or sets a number indicating the preferred port number to use when connecting to a particular workgroup.

PreferredWorkgroup

string TRIM.SDK.DesktopHelper.PreferredWorkgroup

getset

Gets or sets a string indicating a preference for a particular workgroup.