FormControl.helpText Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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:
virtual System::String ^ helpText();public virtual string helpText ();abstract member helpText : unit -> string
override this.helpText : unit -> stringPublic Overridable Function helpText () As StringReturns
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");
Applies to
helpText(String)
public:
virtual System::String ^ helpText(System::String ^ _value);public virtual string helpText (string _value);abstract member helpText : string -> string
override this.helpText : string -> stringPublic Overridable Function helpText (_value As String) As StringParameters
- _value
- String
The value to assign as the Help text for the control.