VPMApp Class Properties

The following table lists the class properties. The properties listed include the standard Visual FoxPro class properties that the VPM Enterprise class uses and the VPM Enterprise custom properties. Where appropriate, the Comments column of the table describes a property and provides suggestions for its use.

Property & Initial Value

Comments

Standard Properties Used:

 

Name = “vpmapp”

 

Custom Properties:

 

aActiveForms[1,16]

This array contains information about each active form and the tables used by the form. When a form is run, a row is added to this array. For a definition of the columns in this array, see the Form_ Class Properties and Methods section of the Form Classes chapter.

aDrvSwap[1,2]

The Drive Swapping array.

aMoverFormDestination[1,0]

The array whose contents are used to populate the Destination listbox on the Mover form. When the OK button on the Mover form is clicked, the contents of the Destination listbox are placed back in the array so that the Destination listbox selections are available to the code that brought up the Mover form.

aMoverFormSource[1,0]

The array whose contents are used to populate the Source listbox on the Mover form.

aSaveEnv[1,0]

Contains environment settings that are restored when the application is exited.

aToolbars[1,2]

An array that keeps track of the VFP toolbars that are hidden automatically when the application is run. When the application is closed, these VFP toolbars are redisplayed.

aTools[1,3]

The Admin Tools array which contains the current on/off status of all Admin Tools.

cAboutForm = “about”

Contains the name of the About form or form class.

cAboutForm_ClassLibrary = “progen”

Contains the name of the class library that contains the About form class if cAboutForm contains the name of a form class.

cActivityForm = “activity”

Contains the name of the Activity form or form class.

cActivityForm_ClassLibrary = “progen”

Contains the name of the class library that contains the Activity form class if cActivityForm contains the name of a form class.

cAdminToolsForm = “admintools”

Contains the name of the AdminTools form or form class.

cAdminToolsForm_ClassLibrary = “progen”

Contains the name of the class library that contains the AdminTools form class if cAdminToolsForm contains the name of a form class.

cAppPre = “”

Contains the three-character application/project prefix.

cAppTitle = “”

Contains the application title. See lIncludeVersionInTitle below.

cAppToolbar = “toolbar_app”

The name of the class from which the application toolbar is instantiated.

cAppToolbar_ClassLibrary = “proapp”

Contains the name of the class library that contains the application toolbar class specified in cAppToolbar.

cAuditTrailForm = “audit_trail”

Contains the name of the AuditTrail form or form class.

cAuditTrailForm_ClassLibrary = “progen”

Contains the name of the class library that contains the AuditTrail form class if cAuditTrailForm contains the name of a form class.

cClassLibrary_Addition1 = “”

Can be used to specify an additional class library to be opened by the SetClassLib method.

cClassLibrary_Addition2 = “”

Can be used to specify an additional class library to be opened by the SetClassLib method.

cClassLibrary_Addition3 = “”

Can be used to specify an additional class library to be opened by the SetClassLib method.

cClassLibrary_Addition4 = “”

Can be used to specify an additional class library to be opened by the SetClassLib method.

cClassLibrary_Addition5 = “”

Can be used to specify an additional class library to be opened by the SetClassLib method.

cClassLibrary_Application = “proapp”

Contains the name of the class library that contains the classes from which the application object and application toolbar are instantiated. This class library is opened by the SetClassLib method.

cClassLibrary_Controls = “proctrls”

Contains the name of the class library that contains the classes from which controls are instantiated. This class library is opened by the SetClassLib method.

cClassLibrary_Forms = “proforms”

Contains the name of the class library that contains the classes from which forms are instantiated. This class library is opened by the SetClassLib method.

cClassLibrary_General = “progen”

Contains the name of the class library that contains the classes from which system/administrative forms are instantiated. This class library is opened by the SetClassLib method.

cClassLibrary_International = “proint”

Contains the name of the class library that contains the classes from which the international/multilingual object and multilingual forms are instantiated. This class library is opened by the SetClassLib method.

cClassLibrary_Security = “prosec”

Contains the name of the class library that contains the classes from which the security object and security forms are instantiated. This class library is opened by the SetClassLib method.

cCurPre = “”

Contains the three-character application/project prefix.

cCurrentToolbar = “”

Contains the name of the navigation toolbar currently on the desktop.

Note: If the currently active form does not use a toolbar, this property will still contain the name of the toolbar used by the most recently activated form on the desktop that uses a toolbar.

cCurrentToolbar_ClassLibrary = “”

Contains the name of the class library that contains the toolbar class specified in cCurrentToolbar.

cDataHandlerClass = “prodatahandler”

The name of the class from which the data handler object is instantiated.

cDataHandlerClass_ClassLibrary = “prodatahandler”

Contains the name of the class library that contains the class specified in cDataHandlerClass.

cDataManagerForm = “datamanager”

Contains the name of the Data Manager form or form class.

cDataManagerForm_ClassLibrary = “rod”

Contains the name of the class library that contains the Data Manager form class if cDataManagerForm contains the name of a form class.

cDirectoriesForm = “directories”

Contains the name of the Directories form or form class.

cDirectoriesForm_ClassLibrary = “progen”

Contains the name of the class library that contains the Directories form class if cDirectoriesForm contains the name of a form class.

cEditRptLbl = “”

Used by the Report Manager and Report Editor forms. Contains the name of the report or label to be edited.

cEnvironmentForm = “environment”

Contains the name of the Environment form or form class.

cEnvironmentForm_ClassLibrary = “progen”

Contains the name of the class library that contains the Environment form class if cEnvironmentForm contains the name of a form class.

cErrorsForm = “errors”

Contains the name of the Errors form or form class.

cErrorsForm_ClassLibrary = “progen”

Contains the name of the class library that contains the Errors form class if cErrorsForm contains the name of a form class.

cExitAction = “”

If used, contains the command to be executed upon exiting the application.

cFindForm_SQL_LastDDTVName = “”

Used by the SQL Find form and the Related Forms engine. See the comments in the RelatedForms_Activate method of the Form_Toolbar class for more details.

cFormIcon = “”

Contains the name of the application’s form icon.

cHelpFile = “”

Contains the name of the application’s Help file.

cHomeDir = “”

Contains the application’s home directory path.

cIniFile = “”

Contains the name and path of the application’s INI file, which holds the latest positions of forms and toolbars.

cInitialLanguageID = “”

Contains the initial language ID. Is set by the SetEnvironment method.

cInternationalClass = “proint”

Contains the name of the class from which the international object is instantiated.

cMainMenu = “”

Used to identify an alternate main menu to run.

cMessageForm = “message”

Contains the name of the Message form or form class.

cMessageForm_ClassLibrary = “progen”

Contains the name of the class library that contains the Message form class if cMessageForm contains the name of a form class.

cMessageManagerForm = “message_manager”

Contains the name of the Message Manager form or form class.

cMessageForm_ClassLibrary = “progen”

Contains the name of the class library that contains the Message Manager form class if cMessageManagerForm contains the name of a form class.

cMessagingClass = “messaging”

Contains the name of the class from which the messaging object is instantiated.

cOnAltF3 = “”

Used by the ResetF2F3 and DisableF2F3 methods to enable and disable the F2, F3, and Alt+F3 keys.

cOnF2 = “”

Used by the ResetF2F3 and DisableF2F3 methods to enable and disable the F2, F3, and Alt+F3 keys.

cOnF3 = “”

Used by the ResetF2F3 and DisableF2F3 methods to enable and disable the F2, F3, and Alt+F3 keys.

cPath = “”

Contains the current VFP search path string.

cPjDBF = “”

Contains the application’s data directory path.

cPjHome = “”

Contains the application’s home directory path.

cPjRpt = “”

Contains the application’s reports directory path.

cReindexPackTablesForm = “reindex_pack”

Contains the name of the Reindex/Pack Tables form or form class.

cReindexPackTablesForm_ClassLibrary = “progen”

Contains the name of the class library that contains the Reindex/Pack Tables form class if cReindexPackTablesForm contains the name of a form class.

cReportManagerForm_EditAndRun = “report_manager”

Contains the name of the Report Manager (Edit & Run) form or form class.

cReportManagerForm_EditAndRun_ClassLibrary = “prorpt”

Contains the name of the class library that contains the Report Manager (Edit & Run) form class if cReportManagerForm_EditAndRun contains the name of a form class.

cReportManagerForm_RunOnly = “report_manager_run”

Contains the name of the Report Manager (Run Only) form or form class.

cReportManagerForm_RunOnly_ClassLibrary = “prorpt”

Contains the name of the class library that contains the Report Manager (Run Only) form class if cReportManagerForm_RunOnly contains the name of a form class.

cReportSetupForm = “reportsetup”

Contains the name of the Report Setup form or form class.

cReportSetupForm_ClassLibrary = “prorpt”

Contains the name of the class library that contains the Report Setup form class if cReportSetupForm contains the name of a form class.

cSecurityClass = “prosec”

Contains the name of the class from which the security object is instantiated.

cSetEscape = “”

Contains the initial SET ESCAPE setting for use in the Cleanup method.

cStartupAction = “”

If used, contains the command to be executed upon application startup.

cStartupToolbar = “toolbar_startup”

The name of the class from which the startup toolbar is instantiated.

cStartupToolbar_ClassLibrary = “proapp”

Contains the name of the class library that contains the startup toolbar class specified in cStartupToolbar.

cTempPath = “”

Contains the Windows Temporary File Directory path.

cThermometerForm = “thermometer”

Contains the name of the Thermometer form or form class..

cThermometerForm_ClassLibrary = “progen”

Contains the name of the class library that contains the Thermometer form class if cThermometerForm contains the name of a form class.

lActivityRecordCreated = .F.

If .T., signifies to the Cleanup_ExitApplication method that an Activity record was created upon entry into the application and therefore a record should be created when exiting.

lAppRunFromVPM = .F.

If .T., signifies that the application was run from VPM. More specifically, from the Run Application menu option or Object Builder form button.

lBypassErrorHandling = .F.

Used by the BypassErrorHandling_Start and BypassErrorHandling_Stop methods to cause the normal error handling to be bypassed. See the BypassErrorHandling_Start method.

lBypassErrorHandling_ErrorOccurred = .F.

If .T., means that an error occurred when the normal error handling is bypassed. See the BypassErrorHandling_Start method.

lBypassErrorHandling_LogError = .F.

If .T., means that an error that occurred when the normal error handling is bypassed will be recorded in the Errors table. See the BypassErrorHandling_Start method.

lCopyrightNotice = .T.

If .T., causes the product name, copyright notice, and company name to be displayed upon application startup when the logo is displayed

lDisableF2F3 = .F.

Used by the ResetF2F3 and DisableF2F3 methods to enable and disable the F2, F3, and Alt+F3 keys.

lDS1EnvironmentSet = .F.

If .T., signifies that the environment has been set for the default data session.

lExitApplication = .F.

Set to .T. in the Cleanup method so that the application will be exited if the user closes the application before the entry into the application is complete.

lFullScreen = .T.

If .T., casues the application to come up full screen upon application startup.

lIncludeVersionInTitle = .T.

If .T., the application’s name (title) plus version is stored in the property cAppTitle. Otherwise, just the application’s name is stored in cAppTitle. The contents of cAppTitle is displayed in the caption of the application window and error message forms, as well as in the copyright notice that is displayed on the application window. The application’s version is displayed on the About form regardless of the lIncludeVersionInTitle setting.

lInstantiateInternationalObject = .T.

If .T. (the default), the International/Multilingual object will be instantiated upon application startup, enabling multilingual functionality in the application.

When a new project is created this property will be set to .F. in the ProApp class if at least one language is not selected on the New Project form.

lLogErrors = .T.

If .T., causes errors to be recorded in the Errors table.

lLogo = .T.

If .T., means the application’s logo is displayed.

lLogoutDisable = .F.

Used to enable/disable the Login and Logout options on the File submenu.

lMoverForm_OKSelected = .F.

When the Mover form is closed, this property is set to .T. if the form closed because the OK button was clicked.

lNullDisplay_ChangeToBlank = .T.

If .T., causes null values to be displayed as “ “ instead of “.NULL.” by issuing the following command in the SetInitialEnvironment method: SET NULLDISPLAY TO “”

lPerformExitActionOnError = .T.

If .T., causes the PerformExitAction method to be run from the Cleanup method when an error occurs that does not cause the application to be exited.

lPerformStartupActionOnError = .T.

If .T., causes the PerformStartupAction method to be run from the Cleanup method when an error occurs that does not cause the application to be exited.

lQuitConf = .T.

If .T., causes a confirmation form to be displayed when exiting the application.

lReleaseLogo = .F.

If .T., causes the logo, company name, and copyright notice to be removed from the desktop after the Introductory form is closed.

lRetry = .F.

Used by the error handling routine to make the RETRY command be executed in the method (RunAdminTool) that is called by the ON ERROR command. If the RETRY is performed in the error handling code, the RETRY is ignored.

lRunIntroductoryForm = .T.

If .T., the Introductory form will be run upon application startup.

lRunTipForm = .T.

If .T., the Tip of the Day form will be run upon application startup.

lTestForm = .F.

Code in form classes expect this application object property to exist in both VPM Enterprise and in applications. In applications this property should always contain .F..

lUseErrorHandler = .F.

If .T., the ON ERROR command should be issued.

lValidPassed = .T.

Set to .T. in the validation routine if the validation check was successful. Otherwise, it is set to .F.. This property can be used by programs and methods that cause the Valid method of a control to be fired and the results of the validation need to be known in the program or method. Example: In the WriteBuffer method of the Form_Toolbar class, moving the focus off the grid causes the Valid method of the grid’s active cell (control) to be run. If the validation check fails, the focus is set back to the grid.

nActiveForms = 0

Holds the number of rows in the Active Forms array aActiveForms.

nErrorHandler = 0

Identifies which error handling routine is in use, 0 (none), 1 (initial – used while entering application), 2 (permanent – used after application has been entered).

nLogoSeconds = 4

Used when the user has turned off the display of the logo on the Environment form. It determines the number of seconds the logo, product name, copyright notice, and company name are displayed. If not greater than zero the logo is not displayed at all.

nOpenStatus = 0

Status of the activity of opening a table or view by the OpenTable or OpenView methods (0 – Not currently opening, 1 – Currently opening, 2 – Error occurred while opening).

nReportManagerType = 1

Identifies the type of Report Manager that the current user should use (Run Only or Edit & Run).

oActiveForm = .F.

After running the GetActiveForm method, will contain the object reference of the currently active form.

oAPDRecord = .F.

Contains the object reference of the SVPMApplicationDefinition.APD record object created by the GetAPDRecord method.

oAppToolbar = .F.

Contains the object reference of the active Application Toolbar.

oDDDRecord = .F.

Contains the object reference of the SDATADDD record object created by the GetDDD method.

oDDFRecord = .F.

Contains the object reference of the SDATADDF record object created by the GetDDF method.

oDDITRecord = .F.

Contains the object reference of the SDATADDIT record object created by the GetDDIT method.

oDDTVRecord = .F.

Contains the object reference of the SDATADDTV record object created by the GetDDTV method.

oInt = .F.

Contains the object reference of the International/Multilingual object.

oMessage = .F.

Contains the object reference of the Messaging object.

oMessageRecord = .F.

Contains the object reference of the SVPMMessages record object created by the GetMessageRecord method.

oSec = .F.

Contains the object reference of the Security object.

oSecRecord = .F.

Contains the object reference of the SVPMSecurityData record object created by the GetSecRecord method.

oSession = .F.

Contains the object reference of the Session object created in the InstantiateSessionObject method.

oStartupToolbar = .F.

Contains the object reference of the startup toolbar.

oToolbar = .F.

Contains the object reference of the active Form Toolbar.

oVPMDataHandler = .F.

Contains the object reference of the data handler object that is used by methods of the application object that deal with data.

SingleInstance_cApplicationWindowCaption = “”

Holds the caption of the application window of the current application. It is this caption that is used to determine if there is another instance of this application already running.

SingleInstance_cMessageText = “You already have an instance of this application running. Please check your task bar.”

When the user attempts to run a second instance of an application, a message is displayed with the message text taken from this property.

SingleInstance_cMessageWindow Caption = “Only One Instance Allowed”

When the user attempts to run a second instance of an application, a message is displayed with the message window caption taken from this property.

SingleInstance_hMutex = 0

Holds the handle of the Mutex object that is created.

SingleInstance_lOnlyOneInstance Allowed = .T.

When .T. (the default), only one instance of an application can be running at any given point on a particular PC. When set to .F., any number of instances of the application can be running at the same time.

 

More:

VPMApp Class Methods