HP.HPTRIM.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

HP.HPTRIM.SDK.DesktopHelper.DesktopHelper

(

)

Member Function Documentation

Database HP.HPTRIM.SDK.DesktopHelper.GetDatabase

(

Hwnd

parentHWND

)

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

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

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

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

Database HP.HPTRIM.SDK.DesktopHelper.SelectDatabase

(

Hwnd

parentHWND

)

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

Member Data Documentation

bool HP.HPTRIM.SDK.DesktopHelper.swigCMemOwn

protected

Property Documentation

bool HP.HPTRIM.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.

string HP.HPTRIM.SDK.DesktopHelper.PreferredDatabaseId

getset

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

int HP.HPTRIM.SDK.DesktopHelper.PreferredPort

getset

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

string HP.HPTRIM.SDK.DesktopHelper.PreferredWorkgroup

getset

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