SQABasic EditBoxFunctions Script

SQABasic "EditBoxFunctions" Script

 MODULE DESCRIPTION:

      Routines and utilities to work on SQA Type=EDITBOX objects in
      Data-Driven Automation.

Action Commands Global Variables Routine Details

User Dependencies:

(stuff the developer's library/script $INCLUDES at compile time.)
(Note: The order of items may matter and may be different for your code.)

(none)

Internal Dependencies:

(stuff this library needs at compile time.)

'$INCLUDE: "LogUtilities_X.SBH"
'$INCLUDE: "ApplicationUtilities_X.SBH"
'$INCLUDE: "DDUtilities_X.SBH"
'$INCLUDE: "GenericMasterFunctions_X.SBH"
'$INCLUDE: "StepDriver_X.SBH"
'$INCLUDE: "StringUtilities_X.SBH"
'$INCLUDE: "DDGUIUtilities_X.SBH"
'$INCLUDE: "DDGUIUtilities.SBH"
'$INCLUDE: "GenericMasterFunctions.SBH"
'$INCLUDE: "LogUtilities.SBH"
'$INCLUDE: "StringUtilities.SBH"

DDE Action Commands

 SUPPORTED ACTION COMMANDS:

      SetTextValue            'set new text value, using InputKeys special characters
      SetUnverifiedTextValue  'set unverified new text value, using InputKeys
                               special characters
      SetTextCharacters       'set and verify new text value using literal text
      SetUnverifiedTextCharacters  'set new text value using literal text (no verify)

Globals

    (none)

Routine Details



   Sub SetTextValue ()



 DESCRIPTION:

      Routine to set the text of the editbox.  This version allows the use
      of special character combinations and substrings to identify specific
      keyboard keys.  These are the same special characters and interpretation
      used for Robot's InputKeys command and the Windows Scripting Host.

      ~^+%{( are primarily the characters that induce special processing.

      The routine verifies we can read the text property, sets the text value
      and will verify that the property has been set to that value *IF* none
      of the special characters exist in the provided text value.  If those
      special characters exist, then no post-set verification will occur.
      Also, no post-set verification occurs for any "Unverified" command.

      If you do not want to have any characters converted or interpretted as
      special characters then you need to use the SetTextCharacters command.

      The routine expects that the given object already has Context or Focus.
      It also expects that Global StepDriverTestInfo contains all the information
      it needs to perform its function.

 PARAMETERS:

      mode    0 -- verify the EditBox text value after setting it.

      mode    1 -- bypass verifying the entered text value.


 DATA TABLE PARAMETERS:

      FLD     CONTENT
      ---     ------------------------------
       5      Text to send to editbox.  Quoted text may be used to ensure proper
              expected value retrieval.
              There is also no check for a missing field because that would be
              the same as specifying no text ("")--which is valid.

 ERRORS:

      none

 Orig Author: Carl Nagle
 Orig   Date: AUG 06, 1999
 History:

      AUG 06, 1999    Original Release
      APR 27, 2000    (CANAGL) Enabled optional quoted text
      JUL 21, 2000    (CANAGL) Modifed to accomodate HTML Editboxes.
      JUN 20, 2001    (CANAGL) Removed post-set verification in special case.
                               Also correct text clearing problem in W2K.
      NOV 15, 2002    (CHSCHR) Added SetUnverifiedTextValue command.





   Sub SetTextCharacters (Optional mode)


 DESCRIPTION:

      Routine to set the text of the editbox.
      It verifies we can read the property, sets the text value and then
      verifies that the property has been set to that value.
      This routine uses only the literal text provided.  It does not attempt
      to convert or interpret the text provided as special characters.  To
      do that, see the SetTextValue command.

      The routine expects that the given object already has Context or Focus.
      It also expects that Global StepDriverTestInfo contains all the information
      it needs to perform its function.

 PARAMETERS:

      mode    0 -- verify the EditBox text value after setting it.

      mode    1 -- bypass verifying the entered text value.


 DATA TABLE PARAMETERS:

      FLD     CONTENT
      ---     ------------------------------
       5      Text to send to editbox.  Quoted text may be used to ensure proper
              expected value retrieval.
              There is also no check for a missing field because that would be
              the same as specifying no text ("")--which is valid.

 ERRORS:

      none

 Orig Author: Carl Nagle
 Orig   Date: JUN 20, 2001
 History:

      JUN 20, 2001    Original Release
      JAN 15, 2004    (CANAGL) Added "Unverified" mode to this command.





   Sub Main ()

 DESCRIPTION:

      Entry point to process a StepDriver ACTION COMMAND on a EDITBOX.
      The routine merely reads the Global StepDriverTestInfo.testcommand and
      calls the appropriate subroutine to process it.

      If the testcommand is unrecognized it will log a WARNING_MESSAGE and
      exit with a WARNING status.

 DATA TABLE PARAMETERS:

      none    -   the called subroutine has the requirements

 ERRORS:

      none

 Orig Author: Carl Nagle
 Orig   Date: AUG 06, 1999
 History:

      AUG 06, 1999    Original Release
      OCT 17, 2002    (CANAGL) Reroute fallback to GenericObjectFunctions.
      OCT 22, 2002    (CANAGL) Warn of unimplemented TF and TW record types.
      NOV 15, 2002    (CHSCHR) Added SetUnverifiedTextValue command.
      DEC 12, 2002    (CANAGL) Added support for XSLComponentActions.MAP
      JAN 15, 2004    (CANAGL) Added "SetUnverifiedTextCharacters".

Copyright (C) SAS Institute
GNU General Public License: http://www.opensource.org/licenses/gpl-license.php 
==============================================================================