4D v14.3

QR GET HEADER AND FOOTER

Home

 
4D v14.3
QR GET HEADER AND FOOTER

QR GET HEADER AND FOOTER 


 

QR GET HEADER AND FOOTER ( area ; selector ; leftTitle ; centerTitle ; rightTitle ; height {; picture {; pictAlignment}} ) 
Parameter Type   Description
area  Longint in Reference of the area
selector  Longint in 1 = Header, 2 = Footer
leftTitle  String in Text displayed on the left side
centerTitle  String in Text displayed in the middle
rightTitle  String in Text displayed on the right side
height  Longint in Header or footer height
picture  Picture in Picture to display
pictAlignment  Longint in Alignment attribute for the picture

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 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))

 
PROPERTIES 

Product: 4D
Theme: Quick Report
Number: 775

This command modifies the Error system variable

 
HISTORY 

Created: 4D 2003

 
SEE ALSO 

QR SET HEADER AND FOOTER

 
ARTICLE USAGE

4D Language Reference ( 4D v12.4)
4D Language Reference ( 4D v11 SQL Release 6)
4D Language Reference ( 4D v14 R3)
4D Language Reference ( 4D v14 R2)
4D Language Reference ( 4D v13.5)
4D Language Reference ( 4D v14.3)
4D Language Reference ( 4D v14 R4)