PAGE HEADING / CABECERA DE PÁGINA

English (Español a continuación)

The following commands allow to include/exclude page headers or customize them.

1.- HEADING / SUPHEADING

These commands allow to include/exclude page and column headers.

  • They are included in the upper part of the Report Script before the definition of Pages / Columns / Rows.
  • By default, the page headers and columns are displayed.

The {HEADING} command displays at the beginning of each page the header of the page (either the default header [shows the members of the dimensions included in the header], or the header defined by the user through the STARTHEADING command) and the headers of the columns.

These headers are displayed:

  • Every time a new page is generated.
  • Every time changes a member of the pages dimensions.
  • With the commands PAGEHEADING / INMHEADING (page headers) and COLHEADING (column headers).

Syntax:

  • {HEADING}

The {SUPHEADING} command suppresses the header of pages and columns.

Syntax:

  • {SUPHEADING}

The effect of this command is reversed:

  • Using the {HEADING} command again.
  • With the commands PAGEHEADING (displays the page headers) or COLHEADING (displays the column headers).

For example, if a Report Script consists of different Reports (each of them ending with its corresponding sign !) and we have initially used the {SUPHEADING} command, in the header of subsequent Reports we can include some of these commands depending on what that we want to show.

2.- PAGEHEADING / SUPPAGEHEADING

The {PAGEHEADING} command includes the page header before displaying the next row of data.

  • For example, it can be included between members of the rows so that it places a header between them since otherwise it would not (the header is only displayed when a new page is generated or when any member of the dimensions included in the page definition changes).

Syntax:

  • {PAGEHEADING}

The {SUPPAGEHEADING} command suppresses page headers (not column headers).

  • With the command {PAGEHEADING} the headers are shown again.

Syntax:

  • {SUPPAGEHEADING}

3.- IMMHEADING

The {IMMHEADING} command includes the page header and columns (unlike PAGEHEADING which just includes the page header) before displaying the next row of data.

  • For example, it can be included between members of the rows so that it places a header between them since otherwise it would not (the header is only displayed when a new page is generated or when any member of the dimensions included in the page definition changes).

Syntax:

  • {IMMHEADING}

4.- STARTHEADING / ENDHEADING

This command allows to generate a user-defined page header instead of the default header, which is displayed at the beginning of each page.

  • All the commands between STARHEADING / ENDHEADING are part of the header definition.
    • By default, a user-defined header includes the default header for pages and columns, unless the SUPPAGEHEADING / SUPCOLHEADING commands (without { }) are included in the header definition.

Syntax:

  • {STARTHEADING
  • ENHEADING}

The header definition can be placed at the top of the Report Scripts, before entering the Pages / Columns / Rows definition.

Let’s look at an example:

  • <PAGE
  • Members
  • {STARTHEADING
    • TEXT
    • 10 “Annual sales”
    • C “EUROPEAN MARKETS”
    • TEXT
    • 2 “*PAGESTRING”
    • TEXT
    • C “*DATE”
  • ENDHEADING}
  • <ROW…

This instructions:

  • TEXT: Defines a line in the header:
    • In position 10 (starting from the left) includes the text “Annual sales”.
    • The text “MERCADOS EUROPEOS” will appear in the center of the line.
  • TEXT: Defines a new line:
    • In position 2 (starting from the left) includes the page number.
  • TEXT: Defines a new line:
    • The day on which the Report Script is prepared will appear in the center of the line.

Some keywords can be used in the header definition:

  • “*USERNAME”: Username.
  • “*PAGESTRING”: Page number.
  • “*DATE”: Report Script elaboration date.

More detail on the keywords that can be used to define a specific header is included in the lesson about the TEXT command.

TIP:

  • To display correctly the page header it is recommended that the columns definition goes before the rows definition.

Español

Los siguientes comandos permiten incluir / excluir las cabeceras de las páginas o personalizarlas.

1.- HEADING / SUPHEADING

Estos comandos permiten incluir / excluir las cabeceras de páginas y columnas.

  • Se incluyen en la parte superior del Report Script antes de la definición de Páginas / Columnas / Filas.
  • Por defecto las cabeceras de las páginas y las columnas se muestran.

El comando {HEADING} muestra al principio de cada página la cabecera de la página (bien la cabecera por defecto [muestra los miembros de las dimensiones incluidas en la cabecera], bien la cabecera definida por el usuario mediante el comando STARTHEADING) y las cabeceras de las columnas.

Estas cabeceras se muestran:

  • Cada vez que se genera una nueva página.
  • Cada vez que cambia un miembro de las dimensiones seleccionadas en páginas.
  • Con los comandos PAGEHEADING / INMHEADING (las cabeceras de las páginas) y COLHEADING (las cabeceras de las columnas).

Sintaxis:

  • {HEADING}

El comando {SUPHEADING} suprime la cabecera de la página y de las columnas.

Sintaxis:

  • {SUPHEADING}

El efecto de este comando se anula:

  • Volviendo a utilizar el comando {HEADING}
  • Con los comandos PAGEHEADING (muestra las cabeceras de páginas) o COLHEADING (muestra las cabeceras de columnas).

Por ejemplo, si un Report Script consta de diferentes Report (cada uno de ellos finalizados con su correspondiente signo !)  e inicialmente hemos utilizado el comando {SUPHEADING}, en la cabecera de los Reports posteriores podemos incluir algunos de estos comandos en función de lo que queramos mostrar.

2.- PAGEHEADING / SUPPAGEHEADING

El comando {PAGEHEADING} incluye la cabecera de la página antes de presentar la siguiente fila de datos.

  • Por ejemplo, se puede incluir entre miembros de las filas para que sitúe entre ellos una cabecera ya que de otro modo no lo haría (la cabecera tan sólo se muestra cuando se genera una nueva página o cuando cambia algún miembro de las dimensiones incluidas en la definición de Páginas).

Sintaxis:

  • {PAGEHEADING}

El comando {SUPPAGEHEADING} suprime las cabeceras de las páginas (no las de las columnas).

  • Con el comando {PAGEHEADING} se vuelven a mostrar las cabeceras.

Sintaxis:

  • {SUPPAGEHEADING}

3.- IMMHEADING

El comando {IMMHEADING} incluye la cabecera de la página y columnas (a diferencia de PAGEHEADING que tan sólo incluye la cabecera de página) antes de presentar la siguiente fila de datos.

  • Por ejemplo, se puede incluir entre miembros de las filas para que sitúe entre ellos una cabecera ya que de otro modo no lo haría (la cabecera tan sólo se muestra cuando se genera una nueva página o cuando cambia algún miembro de las dimensiones incluidas en la definición de Páginas).

Sintaxis:

  • {IMMHEADING}

4.- STARTHEADING / ENDHEADING

Este comando permite generar una cabecera de página definida por el usuario en lugar de la cabecera por defecto, y que se muestra al comienzo de cada página.

  • Todos los comandos entre STARHEADING / ENDHEADING forman parte de la definición de la cabecera.
    • Por defecto, una cabecera definida por el usuario incluye la cabecera por defecto de páginas y columnas, salvo que en la definición de la cabecera se incluyan los comandos SUPPAGEHEADING / SUPCOLHEADING (sin { }).

Sintaxis:

  • {STARTHEADING
  • ENHEADING}

La definición de la cabecera se puede situar en la parte superior del Report Scripts, antes de entrar en la definición de Páginas / Columnas / Filas.

Veamos un ejemplo:

  • <PAGE
  • Miembros
  • {STARTHEADING
    • TEXT
    • 10 “Ventas anuales”
    • C “MERCADOS EUROPEOS”
    • TEXT
    • 2 “*PAGESTRING”
    • TEXT
    • C “*DATE”
  • ENDHEADING}
  • <ROW …

Las instrucciones que hemos utilizado:

  • TEXT: Define una línea en la cabecera:
    • En la posición 10 (comenzando por la izquierda) va a figurar el texto “Ventas anuales”.
    • En el centro de la línea va a figurar el texto “MERCADOS EUROPEOS”.
  • TEXT: Define una nueva línea en la cabecera:
    • En la posición 2 (comenzando por la izquierda) va a figurar el número de página.
  • TEXT: Define una nueva línea en la cabecera:
    • En el centro de la línea va a figurar el día que se elabora el Report Script.

Algunas palabras claves que se pueden utilizar en la definición de la cabecera:

  • “*USERNAME”: Nombre de usuario
  • “*PAGESTRING”: Número de página
  • “*DATE”: fecha elaboración del Report Script
  • ,,,

En la lección que analiza el comando TEXT se incluye más detalle de las palabras claves que se pueden utilizar para definir una cabecera específica.

CONSEJO:

  • Para que el encabezamiento de la página se presente correctamente es recomendable que la definición de las columnas vaya por delante de la definición de las filas.