FormComboBoxControl.helpText Method

Definition

Namespace:

Dynamics.AX.Application

Assembly:

Overloads

helpText()	Gets or sets the Help text that is displayed at the bottom of the screen when a field or control is pointed to.
helpText(String)

helpText()

Gets or sets the Help text that is displayed at the bottom of the screen when a field or control is pointed to.

public:
 override System::String ^ helpText();

public override string helpText ();

override this.helpText : unit -> string

Public Overrides Function helpText () As String

Returns

String

The string that should be displayed at the bottom of the screen.

Remarks

Set the HelpText property for an object by using the property sheet. The Help text must not exceed 250 characters.

The following example shows how to set and return the Help text for a control.

// objCtrl previously assigned to a control 
// Retrieve existing help text. 
print objCtrl.helpText(); 
// Specify new help text. 
objCtrl.helpText("My new help text");

helpText(String)

public:
 override System::String ^ helpText(System::String ^ _value);

public override string helpText (string _value);

override this.helpText : string -> string

Public Overrides Function helpText (_value As String) As String

Parameters

_value

String

The value to assign as the Help text for the control; optional.

Returns

String