%HI_To_Clipboard function

Function

The function copies the specified structure to the clipboard.

Declaration

%HI_To_Clipboard(
       in leftUpperItem,
       in rightLowerItem
   [, BOOL in formatByNLS]
 )

Parameters

leftUpperItem

Item bounding the copied area from left and from above.

rightLowerItem

Item bounding the copied area from right and from below.

formatByNLS

Optional parameter. Possible values:

@TRUE - values of Absolute time and Real are to be formatted according to the settings in Regional and Language Options of the current user,
@FALSE - structure items are to be formatted according to the status text or the transformation palette specified in the corresponding structure definition.

Description

The function converts the values within the defined structure area into text format and the format inserts into the clipboard. Individual structure rows are separated by a new row and individual columns are separated by the character - horizontal tabulator. The format is compatible with the program MS Excel, which inserts individual values into independent cells when executing the operation Copy to clipboard. Formatting structure items takes into consideration setting the status text or transformation palette in the corresponding structure definition.

Note

The function parameters must access items of the same local structure.

Example

RECORD (SD.MachineProduced) _rec
 
 ; filling the local structure
 REDIM _rec[3] 
 _rec^Product := "plate" 
 _rec^count := 10 
 _rec[2]^Product := "knife" 
 _rec[2]^Count := 13
 
 ; inserting into Clipboard
 %HI_To_Clipboard(_rec[1]^Product, _rec[2]^Count)

Related pages: