Footnote

The Footnote text function, used in Text Objects only, returns the requested information about footnotes within a given report object. This function will print information about any footnotes which occur in the object specified, or in all the objects in the report if the first parameter is set to "all". When a grid is referenced, all the footnotes on the grid are printed. The partial POV footnotes are printed (once each) first, followed by any full POV footnotes. The full POV footnotes are printed in order based on the location of the cell from top left to bottom right, page by page. Multiple syntax are supported.

The function syntax are:

Footnote(“ObjectName”, Attributes, Reference, Attachments)

Footnote(“ObjectName”)

Footnote(“ObjectName”, Attributes)

Footnote(“ObjectName”, Attributes, Reference)

Footnote(“ObjectName”, Attributes, Attachments)

Argument

Description

ObjectName

The name of a report object containing the footnotes. If "all" is used, the function returns all available footnotes from all objects in the report. The ObjectName parameter will update when a grid object is renamed.

Attributes (optional)

Identifies the information to be returned from the footnote. This may include the following keywords:

  • All (default value)

  • A combination of one or more of the Attribute keywords; Title & Description (Desc) & Author & Date & Category

The Attribute keywords may be arranged in the preferred order of output. Each attribute must be separated with an ampersand (&).

Reference

a keyword denoting which annotations will be returned where:

  • All (default value)—shows the initial annotation and all replies

  • Top <n> —shows the initial annotation and first replies. The initial annotation is always shown, and the number does not include that initial annotation

  • Bottom—shows the initial annotation and the last number of replies specified in Bottom <n>. The initial annotation is always shown, and the Bottom number does not include that initial annotation

  • BottomOnly <n>—shows the last replies. The initial annotation is not shown unless there are less replies than the BottomOnly <n> number. For example, BottomOnly 5 for an annotation with 5 replies do not show the initial annotation, but for an annotation with 4 replies, the initial annotation is shown.

  • First shows the initial annotation only

  • Replies shows all the replies except the initial annotation

Attachments (optional)

A boolean (true/false) value indicating whether any attachments should be printed with the footnote where:

  • True—attachments will print along with the report, at the end

  • False (default value)—attachments will not print

Examples

<<Footnote(“Grid1”, All, All, true)>>

<<Footnote(All, All, All, true)>>

<<Footnote(All, All, Bottom 2, true)>>

<<Footnote(All, All, BottomOnly 20, true)>>

<<Footnote(All, All, First, true)>>

<<Footnote(All, All, Replies, true)>>

<<Footnote(“Grid1”, Title & Description & Author & Date & Category, All, true)>>

<<Footnote(“Text1”, Title & Description & Date & Category, Top 10, false)>>

<<Footnote(“Image1”, Title & Description & Author, Bottom 4, false)>>

<<Footnote(“Text1”, Title&Description&Author, BottomOnly 12)>>

<<Footnote(“Image1”, Title&Description&Author, First)>>

<<Footnote(“Grid2”, Title&Description&Author, Replies)>>

<<Footnote(“Grid Name”)>>

<<Footnote(all, All)>>

<<Footnote(cur, Description)>>

<<Footnote(cur, title & Description, true)>>

<<Footnote(cur, title & Author & Description, false)>>

<<Footnote(“folder1\folder 2\Grid1”, title & Description&Category, Top20)>>

<<Footnote(“folder1\folder 2\Grid1”, title & Description&Category, Bottom 2)>>

<<Footnote(“folder1\folder 2\Chart2”, title & Description, Top 20, False)>>

<<Footnote(“current”, title & Description, All)>>

<<Footnote(“current”, title & Description, first)>>

<<Footnote(All, Title&Description&author, Top 40, true)>>