Versions Compared

Old Version 1

changes.mady.by.user user-2c621

Saved on

compared with

New Version 2

changes.mady.by.user user-2c621

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Show Contents List

...

Saves an alphanumeric or numeric value onto the VLF virtual clipboard.
Syntax
AVSAVEVALUE(vValue, sID1, sID2, sID3, iInstance, sLanguage, bPersist)
Parameters

vValue

Required. Alphanumeric or numeric value to save to the virtual clipboard. 
If this parameter is a JavaScript variable of type string, then the value is posed to the clipboard as an alphanumeric value and can therefore can only be sensibly be retrieved using the AVRESTOREAVALUE function (or equivalent). 
If it is of type number it is posted as type numeric to the clipboard and can only be sensibly retrieved using the AVRESTORENVALUE function (or equivalent). 
 

sID1

Required. String that contains the Virtual Clipboard identifier 1.

sID2

Optional. String that contains the Virtual Clipboard identifier 2.

sID3

Optional. String that contains the Virtual Clipboard identifier 3.

iInstance

Optional. Integer that contains the instance number. Defaults to 1 when not specified. Instances are typically used to create lists of clipboard values and usually accompanied by another clipboard value that indicates how many entries currently exist in the list.

sLanguage

Optional. String that contains the language code. Defaults to ALL languages when not specified.

bPersist

Optional. Boolean value that indicates whether or not a saved value should persist beyond the current execution of the RAMP application. Defaults to true. This parameter has no meaning for VLF-WEB RAMP applications because VLF virtual clipboard values never persist in WEB applications.

 |
  
Return Value
None
Remarks

...

  • Save values onto the clipboard
    Invoke #avFrameworkManager.avSaveValue WithID1(Test) WithID2(EMPNO) FromAValue(("A0090")
    Invoke #avFrameworkManager.avSaveValue WithID1(Test) WithID2(SURNAME) FromAValue("FRED")
    Invoke #avFrameworkManager.avSaveValue WithID1(Test) WithID2(GIVENAME) FromAValue("BLOGGS")
    Invoke #avFrameworkManager.avSaveValue WithID1(Test) WithID2(POSTCODE) FromNValue(2150)
    Invoke #avFrameworkManager.avSaveValue WithID1(Test) WithID2(SALARY) FromNValue(123456.78)
     
  • Restore values from the clipboard
     
    Invoke #avFrameworkManager.avRestoreValue WithID1(Test) WithID2(EMPNO) ToAValue(#EMPNO) UseAValueDefault("NA")
    Invoke #avFrameworkManager.avRestoreValue WithID1(Test) WithID2(SURNAME) ToAValue(#SURNAME) UseAValueDefault("NA")
    Invoke #avFrameworkManager.avRestoreValue WithID1(Test) WithID2(GIVENAME) ToAValue(#GIVENAME) UseAValueDefault("NA")
    Invoke #avFrameworkManager.avRestoreValue WithID1(Test) WithID2(POSTCODE) ToNValue(#PostCode) UseNValueDefault(0)
    Invoke #avFrameworkManager.avRestoreValue WithID1(Test) WithID2(SALARY) ToNValue(#Salary) UseNValueDefault(0)
     
     
    RAMP JavaScript code to perform the equivalent operations: 
    /* Save values onto the clipboard – note POSTCODE and SALARY are numeric */
    AVSAVEVALUE("A0090","TEST","EMPNO");
    AVSAVEVALUE("FRED","TEST","SURNAME");
    AVSAVEVALUE("BLOGGS","TEST","GIVENAME");
    AVSAVEVALUE(2150,"TEST","POSTCODE");
    AVSAVEVALUE(123456.78,"TEST","SALARY");
    /* Restore values from the clipboard */
    var vEMPNO   = AVRESTOREAVALUE("NA","TEST","EMPNO");
    var vSURNAME = AVRESTOREAVALUE("NA","TEST","SURNAME");
    var vGIVENAME = AVRESTOREAVALUE("NA","TEST","GIVENAME");
    var vPOSTCODE = AVRESTORENVALUE(0,"TEST","POSTCODE");
    var vSALARY  = AVRESTORENVALUE(0,"TEST","SALARY");
     
    Show Contents List