bdeSetBlockParameterTooltip

Sets a description for a parameter within block. This should contain useful information on how to use the block's parameter's valid options. Works with inline blocks. Super blocks are inlined blocks.

Syntax

bdeSetBlockParameterTooltip(block, parameter, description)

Inputs

block: The block that the parameter is in.; Type: block
parameter: The parameter to set a description for.; Type: string
description: A description of the parameter. Contains useful information on how to use the parameters within the block.; Type: string

Examples

Set a description for a parameter with information about it and it's valid options:


          diagram = bdeGetCurrentDiagram();
          block = bdeGetSelectedBlock(diagram);
          bdeSetBlockParameterTooltip(block, 'testParam', 'Used as a test parameter. Include information for the valid options for the parameter.');