VariableHelpText Event

In This Topic

You can support your users by displaying help texts for each variable and field. The event is triggered for the corresponding element as soon as the user selects it in the formula assistant and the help text is to be displayed.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Event VariableHelpText As VariableHelpTextHandler

public event VariableHelpTextHandler VariableHelpText

public:
event VariableHelpTextHandler^ VariableHelpText

Event Data

The event handler receives an argument of type VariableHelpTextEventArgs containing data related to this event. The following VariableHelpTextEventArgs properties provide information specific to this event.

Property	Description
HelpText	Help text to be displayed.
Name	Name of the variable or field.

Example

C#
VB.NET

private void LL_VariableHelpText(object sender, VariableHelpTextEventArgs e)
{
    switch (e.Name)
    {
        case "Kunde.Firma":
            {
            }
            break;

        case "Kunde.Name":
            {
                e.HelpText = "Der Name des Kunden";
            }
            break;

        default:
            {
            }
            break;
    }
}

                        
Private Sub LL_VariableHelpText(ByVal sender As Object, ByVal e As VariableHelpTextEventArgs)

    Select Case e.Name

        Case "Kunde.Firma"

        Case "Kunde.Name"
            e.HelpText = "Der Name des Kunden"

        Case Else

    End Select

End Sub

Requirements

Platforms: Windows 10 (Version 21H2 - 23H2), Windows 11 (21H2 - 22H2), Windows Server 2016 - 2022
.NET: .NET Framework 4.8, .NET 6, .NET 8, .NET 9

Reference

ListLabel Class
ListLabel Members

Send Feedback