combit List & Label 29 - .NET Help
combit.Reporting Namespace / VariableHelpTextHandler Delegate


In This Topic
    VariableHelpTextHandler Delegate
    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
    'Declaration
     
    
    Public Delegate Sub VariableHelpTextHandler( _
       ByVal sender As Object, _
       ByVal e As VariableHelpTextEventArgs _
    ) 
    public delegate void VariableHelpTextHandler( 
       object sender,
       VariableHelpTextEventArgs e
    )
    public delegate void VariableHelpTextHandler( 
       Object^ sender,
       VariableHelpTextEventArgs^ e
    )

    Parameters

    sender
    e
    Example
    private void LL_VariableHelpText(object sender, VariableHelpTextEventArgs e)
    {
         switch(e.Name)
         {
              case "Customer.Company":
              break;
    
              case "Customer.Name":
               e.HelpText = "The customer's name.";
              break;
         }
    } 
    
    Requirements

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

    See Also