| ClientConfig Class |
|
Class provides core configuration behaviour for the DataPA client applications.
Inheritance Hierarchy
Namespace: DataPAClientConfig
Assembly: DataPAClientConfig (in DataPAClientConfig.dll) Version: 1.0.1.0 (1.0.1.0)
Syntax[SerializableAttribute] public class ClientConfig : _ClientConfig
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.
|
| GetAuthToken | |
| GetPublishedContent |
Gets a PublishedContentCollection object representing the published content for a particular category.
|
| GetServerSecurityManifest |
Gets a ServerSecurity Manifest object.
|
| GetUserNameAndPassword |
Prompts the user for a username and password, updating the username and password properties.
|
| HandleAuthorisationFault |
Handle an auhtorisation fault from the Enterprise Service by showing the login prompt and getting a new Auth Token
|
| HideSplashScreen |
Hides the splash screen.
|
| ImportPAXFile |
Shows the Import Export wizard for a given import file
|
| Initialise |
Initialises the object.
|
| Initialise(String, SessionManagerDataFileFormatEnum, Boolean, 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.
|
| PubEntSrv |
Returns the EnterpriseServiceClient object this object uses to communicate with the server for the purposes of publishing.
|
| 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.
|
| RunQuery | |
| SaveServerSecurity |
Saves any changes to the server security object back to the server
|
| SaveSetupData | |
| Search |
Prompts user for search text
|
| SearchAndReplace |
Prompts user for search and replace text
|
| ServerSecurity |
Gets the server security object.
|
| SetCustomLoadingImageFromFile |
Loads a custom loading image for this client session from a file on disk
|
| ShowAbout | |
| ShowChangePassword | |
| ShowLicenseWindow | |
| ShowManagePublished | |
| ShowManageServer |
Shows the manage server screen
|
| ShowManageServer(String) |
Shoes the manage server screen
|
| ShowOpenFromServer | |
| ShowProperties |
Shows the properties screen
|
| ShowQueryString |
Shows a dialog with the query string that will be executed on the server for a given query
|
| ShowQueryWizard | |
| ShowRunQueryWizardToCollectParametersOnly |
Shows the run query wizard to collect parameter values
|
| ShowSecurity |
Shows the security screen
|
| ShowSelectConnection | |
| ShowSelectConnection(String) | |
| ShowSetup |
Shows the setup screen
|
| ShowSplashScreen |
Shows the splash screen.
|
| ShowSubjectExplorer | |
| SQLClient |
Returns the SQL Client object used to run SQL queries.
|
| SystemType | |
| TmpDir | |
| 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.
|
| Application |
Gets and sets the Application object used to allow access to queries and setup.
|
| AppServerValidationFailed |
Gets a value that indicate if validation on the security appserver failed.
|
| AuthToken |
Details of the token used to authenticate with the Enterprise Service
|
| AutoUpdate |
Gets and sets a value that indicates if the client should automatically check for updates.
|
| ConfigSettings |
Gets the configuration settings object
|
| CustomLoadingImage |
Gets and sets the custom loading image
|
| CustomLoadingImageBase64 |
Gets and sets the custom loading image as a base64 encoded string
|
| CustomLoadingImageType |
Gets and sets the loading image type for this client instance
|
| 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.
|
| EnterpriseServiceEndpoint |
Gets the Enterprise Service End Point for this client instance
|
| EnterpriseServiceHubPort |
Gets a value that indicates the port being used to commincate with the Enteprise Service SignalR Hub.
|
| 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.
|
| LoadingImage |
Gets the loading image for this client session
|
| LockServerCode |
Gets the encrypted lockserver code.
|
| MaxJSONLength |
Gets a value that indicates the maximum JSON document size permitted.
|
| PaletteFile |
Gets the palette file for this client instamce
|
| 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
|
| SetupGUID |
Gets a value that indicate the setup GUID used to tell when the setup on the server has changed.
|
| SetupManager |
Gets and sets a setup manager object for this objects.
|
| Silent |
Gets and sets a property that indicates if the application is set to silent so will hide messages.
|
| SplashScreenText |
Gets and sets the text displayed on the splash screen.
|
| SuppressLoginDialog |
Gets and sets a property that indicates if the login dialog should always be suppressed
|
| 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 | |
|---|---|---|
 | InitialisationWindowsHidden |
Event raised when a window is hidden during the initialisation process
|
| InitialisationWindowsShown |
Event raised when a window is shown during the initialisation process
|
| 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
|
RemarksSee Also