How to Use Various Commands in the Report Header

There are various commands you can use in sqlReports in the Report Header area following the initial <th> command.  

Class Commands

You can see examples of some of these in various reports on this site, such as the Current Grades - No Minimum report.   The commands would look something like <th class="NOCF">.  Below is an explanation of each of them and when they would be used:

class="DCID" - used when you want to add a Make Current Selection button to your report.  Use with the heading for the column containing the dcid data from the students table.  The column is hidden when a user views the report, but appears briefly when the Make Current Selection button is clicked.

class="DCID DISPLAY" - like above, it's used with the column containing the dcid data from the students table when you want to add a Make Current Selection button, but the column of data will appear on the screen with the rest of the data in the report

class="HIDE" - hides a column from view, which is useful to hide a column needed for the SQL but you don't want to display it, or when using the show/hide columns button and you want to hide columns initially that the user can show using the button.

class="NOCF" - used when column filtering is enabled and you do not wish to have a filtering option for a column.  For example, if you have a report with final grades and comments and you don't want to have a drop-down menu for the comments column, add class="NOCF" after the th in the Report Heading for that column.

class="ROWGRP" -  used when Row Grouping is enabled (the option to enable it is in the Results Page area when editing a report), the column with the command is used for row grouping purposes. 

The DCID, DCID DISPLAY, and ROWGRP commands can only be used with one column per report.  In other words, you can only have one column heading with class="DCID" or class="ROWGRP" per report.  The HIDE and NOCF commands can be used for multiple columns in the Report Heading area for a report, meaning you could have multiple column headings with class="NOCF" if needed.


Set a Fixed Width for a Column

In addition to the commands above, you can use some html commands in the Report Heading area.  For example, column widths are dynamic by default, but there are times you may want a column to be a set width.  For example, you may have a report with the teacher name and a final grade comment.  The final grade comment column is maybe too wide and the teacher name column hard to read because it's not wide enough and therefore putting names on two lines.  In the report header, use a width= command to set the name column width like so:

<th width="300">Teacher Name</th><th>Comment</th>

 

  Back to the List of Articles