NavHelper Class

Append a record count to the provided NavTarget caption provided in captionText. This method is normally called only when the AppendCount attribute is set on the NavTarget. The appended count may include HTML formatting.

Note that if an error occurs while retrieving the record count that error is suppressed and the count indicator added to the caption will be rendered to indicate that the count could not be obtained.

When adding the count to the caption, various other NavTarget settings affect how the count is presented including:

• The count is retrieved using the IMapper associated with the PageInfo that is the Target for target unless overridden with Navbar_AppendCountMOP.
• This overload ignores AddParentInfo.
• For performance, the count ceiling specified by the Navbar_RecordCountLimit property is used, defaulting to the target PageInfoRecordCountLimit property if not set.
• The CSS class to use on the DOM navigation element is returned in cssClass per the Navbar_CssClass vs. Navbar_CssClassWithItems properties depending on whether or not the count is non-zero.
• The style pairs to use on the DOM navigation element is returned in stylePairs per the Navbar_Style vs. Navbar_StyleWithItems properties depending on whether or not the count is non-zero.

Append a record count to the provided NavTarget caption provided in captionText. This method is normally called only when the AppendCount attribute is set on the NavTarget. The appended count may include HTML formatting.

Note that if an error occurs while retrieving the record count that error is suppressed and the count indicator added to the caption will be rendered to indicate that the count could not be obtained.

When adding the count to the caption, various other NavTarget settings affect how the count is presented including:

• The count is retrieved using the IMapper associated with the PageInfo that is the Target for target unless overridden with Navbar_AppendCountMOP.
• If AddParentInfo is specified and non-null, non-blank viewKeyName and viewKeyValue parameters are provided, a parent filter is constructed and added.
• For performance, the count ceiling specified by the Navbar_RecordCountLimit property is used, defaulting to the target PageInfoRecordCountLimit property if not set.
• The CSS class to use on the DOM navigation element is returned in cssClass per the Navbar_CssClass vs. Navbar_CssClassWithItems properties depending on whether or not the count is non-zero.
• The style pairs to use on the DOM navigation element is returned in stylePairs per the Navbar_Style vs. Navbar_StyleWithItems properties depending on whether or not the count is non-zero.

Retrieve the link parameters for a NavTarget appropriate for the current context and construct a link. The current context may include a current page's PageInfo and/or the parent mapper (for example, the mapper in the main pane of a console).

Construct a report link from a NavTarget whose TargetType is "report".

If the report is unavailable then a null link will be returned. If unavailable and the report is unknown, a problem description (appropriate for a developer) will be returned in problemText. Note that if the report is unavailable, but known (e.g. permissioned out) then no problemText will be returned and it is expected that the caller will not render the link.