NavHelperAppendCount Method (IAppContext, NavTarget, String, String, String, String, String) |
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:
Namespace:
NetQuarry
Assembly:
EAP.WebMappers (in EAP.WebMappers.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax public static int AppendCount(
IAppContext cxt,
NavTarget target,
string viewKeyName,
string viewKeyValue,
ref string captionText,
out string cssClass,
out string stylePairs
)
Public Shared Function AppendCount (
cxt As IAppContext,
target As NavTarget,
viewKeyName As String,
viewKeyValue As String,
ByRef captionText As String,
<OutAttribute> ByRef cssClass As String,
<OutAttribute> ByRef stylePairs As String
) As Integer
Parameters
- cxt
- Type: NetQuarryIAppContext
The application context. - target
- Type: NetQuarryNavTarget
The NavTarget in question. - viewKeyName
- Type: SystemString
Parent filter key field, if AddParentInfo is specified. - viewKeyValue
- Type: SystemString
Parent filter key value, if AddParentInfo is specified. - captionText
- Type: SystemString
The caption to which to add. - cssClass
- Type: SystemString
The appropriate CSS class to use (may depend on whether or not the count is zero. - stylePairs
- Type: SystemString
The appropriate style pair values to use (may depend on whether or not the count is zero.
Return Value
Type:
Int32The record count, possibly limited per RecordCountLimit.
See Also