DataPA Enterprise Dashboard Controls API Reference
The ClientConfig type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() |
ClientConfig()()()() |
Creates and returns a new ClientConfig object.
|
![]() |
ClientConfig(ADODBDataSource) |
Creates and returns a new ClientConfig object.
|
![]() |
ClientConfig(Application) |
Creates and returns a new ClientConfig object.
|
Methods
Name | Description | |
---|---|---|
![]() |
CheckForUpdate | |
![]() |
Dispose |
Disposes of the object
|
![]() |
EntSrv |
Returns the EnterpriseServiceClient object this object uses to communicate with the server.
|
![]() |
GetPublishedContent |
Gets a PublishedContentCollection object representing the published content for a particular category.
|
![]() |
GetUserNameAndPassword |
Prompts the user for a username and password, updating the username and password properties.
|
![]() |
HideSplashScreen |
Hides the splash screen.
|
![]() |
Initialise()()()() |
Initialises the object.
|
![]() |
Initialise(String, SessionManager..::..DataFileFormatEnum, Boolean) |
Initialises the object.
|
![]() |
IsServerSecurityLockValid |
Returns a value that indicates if the Server Security is locked by the current user.
|
![]() |
IsSetupLockValid |
Returns a value that indicates if the setup files are locked by the current user.
|
![]() |
LockServerSecurityData |
Attempts to lock the Server Security for editing.
|
![]() |
LockSetupData |
Attempts to lock the setup files for editing.
|
![]() |
PublishDocument |
Publishes a Document (Report or Query) to DataPA Enterprise.
|
![]() |
ReloadSetup |
Refreshes the setup files.
|
![]() |
RestoreSplashScreen |
Shows the splash screen if it was hidden with allow restore set to true.
|
![]() |
SaveSetupData | |
![]() |
Search |
Prompts user for search text
|
![]() |
SearchAndReplace |
Prompts user for search and replace text
|
![]() |
ServerSecurity |
Gets the server security object.
|
![]() |
ShowOpenFromServer | |
![]() |
ShowSetup |
Shows the setup screen
|
![]() |
SQLClient |
Returns the SQL Client object used to run SQL queries.
|
![]() |
SystemType | |
![]() |
UnLockServerSecurityData |
Attempts to unlock the Server Security.
|
![]() |
UnLockSetupData |
Attempts to unlock the setup files.
|
![]() |
UseNewSetUp | |
![]() |
ViewData |
Fields
Name | Description | |
---|---|---|
![]() ![]() |
ClassId | |
![]() ![]() |
EventsId | |
![]() ![]() |
InterfaceId |
Properties
Name | Description | |
---|---|---|
![]() |
AllowQuerySelectConnection |
Gets and sets a property that indicates if this client supports the selection of a connection from the query wizard.
|
![]() |
AppServerValidationFailed |
Gets a value that indicate if validation on the security appserver failed.
|
![]() |
AutoUpdate |
Gets and sets a value that indicates if the client should automatically check for updates.
|
![]() |
DashboardStyle |
Gets and sets the default dashboard style for client applications
|
![]() |
DataFileFormat |
Gets and sets a value that indicates the file format used to store the setup.
|
![]() |
DataLocation |
Gets and sets the data location
|
![]() |
DataLocationType |
Gets a value that indicates what type of data location is currently set.
|
![]() |
Group |
Gets the unique ID of the users group.
|
![]() |
Initialised |
Gets a property that indicates if this clientconfig has been successfully initialised.
|
![]() |
LicenseInfo |
Gets and sets the LicenseInfo object for this object.
|
![]() |
LockServerCode |
Gets the encrypted lockserver code.
|
![]() |
PAApplication |
Gets and sets the RunDataPA.Application object used to provide access to data from the AppServer.
|
![]() |
Password |
Gets and sets the Password the user has logged in with.
|
![]() |
PreviousLoginFailed |
Gets and sets a value that indicates if the previous login attempt failed.
|
![]() |
QuietCheckForUpdate |
Gets and sets a property that indicates if the check for update should show a message when there is no update.
|
![]() |
RootObject |
Gets and sets the root object used to provide AppServer connectivity to download dat files etc.
|
![]() |
SchedulerClient |
Gets and sets a property that indicates if the client should be checking for scheduler licenses rather than standard.
|
![]() |
Security |
Gets and sets the Security object for this object.
|
![]() |
SessionFreeDataLocationAppServer |
Gets and sets a value that indicates if the Data Location AppServer is a session free AppServer
|
![]() |
SetupManager |
Gets and sets a setup manager object for this objects.
|
![]() |
SplashScreenText |
Gets and sets the text displayed on the splash screen.
|
![]() |
SystemStructure |
Gets a System Structure (DBs, Tables, Fields, Functions etc.) Object
|
![]() |
UpdateLocation |
Gets and sets the location the client will check for updates.
|
![]() |
UsePreviousUsernameAndPasswordSet |
Gets and sets a value that indicates if the previously used username and password should be used rather than prompting again.
|
![]() |
UserName |
Gets and sets the username the user has logged in with.
|
![]() |
Version |
Gets the version of DataPA currently installed.
|
Events
Name | Description | |
---|---|---|
![]() |
LicenseChanged |
Event raised when the license on this client changes.
|
![]() |
SelectedConnectionsChanged |
Event raised when some action changes the selected connections
|
![]() |
SetupChanged |
Event raised when some action changes the setup
|