Skip to content

SetHelpText.md

Latest commit

 

History

History
62 lines (51 loc) · 1.6 KB

SetHelpText.md

File metadata and controls

62 lines (51 loc) · 1.6 KB
Raw

SetHelpText

Description

Sets the help text for the given component.

PROCEDURE SetHelpText(
				dialogID    : LONGINT;
				componentID : LONGINT;
				helpText    : STRING);
def vs.SetHelpText(dialogID, componentID, helpText):
    return None

Parameters

Name Type Description
dialogID LONGINT the dialog identifier given by CreateLayout or CreateResizableLayout
componentID LONGINT The identifier of the component for which to set the help text.
helpText STRING The help text to set for the given component.

Examples

{* Set the help strings *}
SetHelpText(dialogID, 1, helpString [1]);
SetHelpText(dialogID, 2, helpString [2]);
SetHelpText(dialogID, 4, helpString [3]);
SetHelpText(dialogID, 6, helpString [4]);
SetHelpText(dialogID, 7, helpString [5]);

{* Set the help strings *}
	SetHelpText(dialogID, 1, GetPlugInString (3010));
	SetHelpText(dialogID, 2, GetPlugInString (3011));
	SetHelpText(dialogID, 4, GetPlugInString (3012));
	SetHelpText(dialogID, 5, GetPlugInString (3013));
	SetHelpText(dialogID, 6, GetPlugInString (3014));

{* Help Strings *}
	SetHelpText(dialogID, 1, GetPlugInString (3007));
	SetHelpText(dialogID, 2, GetPlugInString (3008));
	SetHelpText(dialogID, 6, GetPlugInString (3009));
	SetHelpText(dialogID, 8, GetPlugInString (3010));
import vs

# Sets the help text for the given component.
dialogID = 1
componentID = 2
helpText = 'Example text'

vs.SetHelpText(dialogID, componentID, helpText)

Version

Availability: from Vectorworks 2010

Category