Skip to main content
Version: 20 R7 BETA

QR GET HEADER AND FOOTER

QR GET HEADER AND FOOTER ( area ; selector ; leftTitle ; centerTitle ; rightTitle ; height {; picture {; pictAlignment}} )

ParameterTypeDescription
areaIntegerReference of the area
selectorInteger1 = Header, 2 = Footer
leftTitleTextText displayed on the left side
centerTitleTextText displayed in the middle
rightTitleTextText displayed on the right side
heightIntegerHeader or footer height
picturePicturePicture to display
pictAlignmentIntegerAlignment attribute for the picture

Description

The QR GET HEADER AND FOOTER command retrieves the contents and size of the header or footer.

selector allows you to select the header or the footer:

  • if selector equals 1, the header information will be retrieved;
  • if selector equals 2, the footer information will be retrieved.

leftTitle, centerTitle and rightTitle returns the values for, respectively, the left, center and right header/footer.

height returns the height of the header/footer, expressed in the unit selected for the report.

picture returns a picture that is displayed in the header or footer.

pictAlignment is the alignment attribute for the picture displayed in the header/footer.

  • If pictAlignment returns 1, the picture is aligned to the left.
  • If pictAlignment returns 2, the picture is centered.
  • If pictAlignment returns 3, the picture is aligned to the right.

If you pass an invalid area number, the error -9850 will be generated.
If you pass an invalid selector value, the error -9852 will be generated.

Example

The following code retrieves the values of the header titles as well as the header size and displays them in alerts:

 QR GET HEADER AND FOOTER(MyArea;1;$LeftText;$CenterText;$RightText;$height)
 Case of
    :($LeftText #"")
       ALERT("The left title is "+Char(34)+$LeftText+Char(34))
    :($CenterText #"")
       ALERT("The center title is "+Char(34)+$CenterText+Char(34))
    :($RightText #"")
       ALERT("The right title is "+Char(34)+$RightText+Char(34))
    Else
       ALERT("No header title in this report.")
 End case
 ALERT("The height of the header is "+String($height))

See also

QR SET HEADER AND FOOTER

Properties

Command number775
Thread safe
Modifies variableserror