Defining Named Ranges in Reference Files

The reference file is an Excel file that can be located in a folder on a local drive or network drive, outside of the report package.

The doclet author creates Excel report content and then defines named ranges around that content. In general, range names can be created using the New Name dialog box, accessed either from the Name Manager or the Define Name items on the Formula ribbon of Excel. Find out more about range names in the Microsoft documentation.

This Excel file is a potential reference file.

Define named ranges in your reference file before you begin working with them in a doclet.

To define named ranges for reference files:

  1. In Excel, create the report content.
  2. Add range names to selected report content.
    You can add range names to any or all report content in the reference file. You decide which content you want to make available.

    A named range is valid when the named range:

    • Exists within an Excel workbook.

    • Is not a hidden name.

    • Refers to a range of cells in a worksheet which is not hidden.

    • Is not referring to a formula or constant.

    • Does not have a dynamically calculated reference, for example the reference must point to an absolute range of cells, rather than relying on a reference formula or another named range to dynamically determine the range.

    • Does not contain any errors, for example a "#REF!" error.

    Remember, named ranges from your reference file become candidates for embedded content to you as the doclet author.

  3. Optional: To enable the "Repeat as header row" option within embedded Microsoft Word tables, edit the Excel Named Range to add the following syntax within the comment field:

    NR_Headings=#

    For example, if there are three rows within the named range which represent the table header rows, then specify:

    NR_Headings=3

    If the named range should span multiple pages when embedded in a Word doclet, then the indicated number of rows will be repeated as column headers on each page that the table spans in the doclet.

  4. Save the Excel file.