Dashboards

Labels and TextBoxes

Labels and TextBoxes are the simplest dashboard components. Labels display text and data — from static strings to adapter-bound values with number formatting. TextBoxes capture user input and write it to a parameter for other components or Business Rules to consume.

Label Component

Labels display text on the dashboard. A Label can show:
  • Static text — Revenue Summary
  • Parameter values — Report for |!EntityParam!|
  • Adapter-bound data — Revenue: {1} | Profit: {2} (values from a DataTable)

DataTable Cell Binding

When a Label is bound to a data adapter, you use {1}, {2}, etc. in the Text property to reference column values from the adapter's DataTable. The binding is configured through the DataTableCellsFromAdapter properties:
PropertyDescription
NumberOfDataTableCellsHow many {N} placeholders the Label uses (e.g., 2 for {1} and {2})
DataRowSelectionTypeHow to select the row: FirstRow, RowIndex, or KeyColumnNameAndValue
KeyColumnNameColumn name for key-based row selection (used with KeyColumnNameAndValue)
KeyColumnValueOrRowIndexThe key value or row index to match
ResultColumnNameWhich column to read the value from
NumberFormat.NET format string for numeric values (e.g., #,##0, 0.00%, $#,##0.00)

Font and Color Properties

PropertyDescription
LabelFontFamilyFont family name (e.g., Segoe UI, Arial)
LabelFontSizeFont size in points
LabelBoldBold text (True/False)
LabelItalicItalic text (True/False)
LabelTextColorText color for positive or non-numeric values
LabelNegativeTextColorText color for negative numeric values
LabelZeroOffsetForFormattingThreshold below which values are treated as zero for formatting purposes

Label Example

Display revenue and profit from a SQL adapter in a single Label.
SQL Adapter — RevenueProfitAdapter:
plaintext
1SELECT
2  FORMAT(SUM(CASE WHEN Account = 'Revenue' THEN Amount ELSE 0 END), 'N0') AS Revenue,
3  FORMAT(SUM(CASE WHEN Account = 'Profit' THEN Amount ELSE 0 END), 'N0') AS Profit
4FROM dbo.FinancialData
5WHERE Entity = '|!EntityParam!|'
6AND Scenario = '|!ScenarioParam!|'
Label configuration:
plaintext
1Text:                    Results: Revenue = {1}, Profit = {2}
2NumberOfDataTableCells:   2
3DataRowSelectionType:     FirstRow
4Adapter:                 RevenueProfitAdapter
diagramLabel Data Binding Flow

Loading diagram...

TextBox Component

TextBoxes capture free-form user input. The value the user types is written to the parameter specified by the BoundParameter property, making it available to other components and Business Rules.

TextBox Properties

PropertyDescription
BoundParameterThe parameter name that receives the user's input
TextDefault text displayed before user interaction
MaxLengthMaximum number of characters the user can enter
IsEnabledWhether the TextBox accepts input (True/False)
ToolTipHover text displayed when the user mouses over the component

TextBox Example

Capture a user note that a Business Rule can read when processing data.
TextBox configuration:
plaintext
1BoundParameter:   UserNotes
2Text:             Enter notes here...
3MaxLength:        500
4IsEnabled:        True
5ToolTip:          Enter any notes to include with this submission
When the user types into the TextBox, the value is stored in the UserNotes parameter. A Dashboard Extender BR triggered by a button click can then read it:
1Dim userNotes As String = BRApi.Dashboards.Parameters.GetLiteralParameterValue(si, False, "UserNotes")
2' Use the notes in processing logic...

Common Properties

Both Labels and TextBoxes share these common component properties:
PropertyDescription
IsVisibleControls visibility (True/False, supports |!Param!| for conditional display)
IsEnabledControls interactivity
ToolTipHover text
DisplayFormatFormatting template for the displayed value
SelectionChangedServerTaskServer task to execute when the value changes
SelectionChangedServerTaskArgumentsCurly brace syntax arguments for the server task

Related Content