DataPA Enterprise Dashboard Controls API Reference

The ClientConfig type exposes the following members.

Constructors

  Name Description
Public method ClientConfig()()()()
Creates and returns a new ClientConfig object.
Public method ClientConfig(ADODBDataSource)
Creates and returns a new ClientConfig object.
Public method ClientConfig(Application)
Creates and returns a new ClientConfig object.

Methods

  Name Description
Public method CheckForUpdate
Public method Dispose
Disposes of the object
Public method EntSrv
Returns the EnterpriseServiceClient object this object uses to communicate with the server.
Public method GetPublishedContent
Gets a PublishedContentCollection object representing the published content for a particular category.
Public method GetUserNameAndPassword
Prompts the user for a username and password, updating the username and password properties.
Public method HideSplashScreen
Hides the splash screen.
Public method Initialise()()()()
Initialises the object.
Public method Initialise(String, SessionManager..::..DataFileFormatEnum, Boolean)
Initialises the object.
Public method IsServerSecurityLockValid
Returns a value that indicates if the Server Security is locked by the current user.
Public method IsSetupLockValid
Returns a value that indicates if the setup files are locked by the current user.
Public method LockServerSecurityData
Attempts to lock the Server Security for editing.
Public method LockSetupData
Attempts to lock the setup files for editing.
Public method PublishDocument
Publishes a Document (Report or Query) to DataPA Enterprise.
Public method ReloadSetup
Refreshes the setup files.
Public method RestoreSplashScreen
Shows the splash screen if it was hidden with allow restore set to true.
Public method SaveSetupData
Public method Search
Prompts user for search text
Public method SearchAndReplace
Prompts user for search and replace text
Public method ServerSecurity
Gets the server security object.
Public method ShowOpenFromServer
Public method ShowSetup
Shows the setup screen
Public method SQLClient
Returns the SQL Client object used to run SQL queries.
Public method SystemType
Public method UnLockServerSecurityData
Attempts to unlock the Server Security.
Public method UnLockSetupData
Attempts to unlock the setup files.
Public method UseNewSetUp
Public method ViewData

Fields

  Name Description
Public field Static member ClassId
Public field Static member EventsId
Public field Static member InterfaceId

Properties

  Name Description
Public property AllowQuerySelectConnection
Gets and sets a property that indicates if this client supports the selection of a connection from the query wizard.
Public property AppServerValidationFailed
Gets a value that indicate if validation on the security appserver failed.
Public property AutoUpdate
Gets and sets a value that indicates if the client should automatically check for updates.
Public property DashboardStyle
Gets and sets the default dashboard style for client applications
Public property DataFileFormat
Gets and sets a value that indicates the file format used to store the setup.
Public property DataLocation
Gets and sets the data location
Public property DataLocationType
Gets a value that indicates what type of data location is currently set.
Public property Group
Gets the unique ID of the users group.
Public property Initialised
Gets a property that indicates if this clientconfig has been successfully initialised.
Public property LicenseInfo
Gets and sets the LicenseInfo object for this object.
Public property LockServerCode
Gets the encrypted lockserver code.
Public property PAApplication
Gets and sets the RunDataPA.Application object used to provide access to data from the AppServer.
Public property Password
Gets and sets the Password the user has logged in with.
Public property PreviousLoginFailed
Gets and sets a value that indicates if the previous login attempt failed.
Public property QuietCheckForUpdate
Gets and sets a property that indicates if the check for update should show a message when there is no update.
Public property RootObject
Gets and sets the root object used to provide AppServer connectivity to download dat files etc.
Public property SchedulerClient
Gets and sets a property that indicates if the client should be checking for scheduler licenses rather than standard.
Public property Security
Gets and sets the Security object for this object.
Public property SessionFreeDataLocationAppServer
Gets and sets a value that indicates if the Data Location AppServer is a session free AppServer
Public property SetupManager
Gets and sets a setup manager object for this objects.
Public property SplashScreenText
Gets and sets the text displayed on the splash screen.
Public property SystemStructure
Gets a System Structure (DBs, Tables, Fields, Functions etc.) Object
Public property UpdateLocation
Gets and sets the location the client will check for updates.
Public property UsePreviousUsernameAndPasswordSet
Gets and sets a value that indicates if the previously used username and password should be used rather than prompting again.
Public property UserName
Gets and sets the username the user has logged in with.
Public property Version
Gets the version of DataPA currently installed.

Events

  Name Description
Public event LicenseChanged
Event raised when the license on this client changes.
Public event SelectedConnectionsChanged
Event raised when some action changes the selected connections
Public event SetupChanged
Event raised when some action changes the setup

See Also