Share via

DictField.help Method

  • Reference

Definition

Namespace:
Dynamics.AX.Application
Assembly:
Microsoft.Dynamics.AX.Xpp.Support.dll

Overloads

help(Int32)
help(Int32, Boolean)
help()

Returns the Help text that is displayed for the field.

help(Int32) 

public:
 virtual System::String ^ help(int num1);
public virtual string help (int num1);
abstract member help : int -> string
override this.help : int -> string
Public Overridable Function help (num1 As Integer) As String

Parameters

num1
Int32

Returns

String

Applies to

help(Int32, Boolean) 

public:
 virtual System::String ^ help(int _arrayIndex, bool _useInterfaceLanguage);
public virtual string help (int _arrayIndex, bool _useInterfaceLanguage);
abstract member help : int * bool -> string
override this.help : int * bool -> string
Public Overridable Function help (_arrayIndex As Integer, _useInterfaceLanguage As Boolean) As String

Parameters

_arrayIndex
Int32

A Boolean value that indicates whether to use the user interface language for the Help text; optional.

_useInterfaceLanguage
Boolean

A Boolean value that indicates whether to use the user interface language for the Help text; optional.

Returns

String

Applies to

help()

Returns the Help text that is displayed for the field.

public:
 virtual System::String ^ help();
public virtual string help ();
abstract member help : unit -> string
override this.help : unit -> string
Public Overridable Function help () As String

Returns

String

The Help text or inherited Help text for the field.

Remarks

If no Help text is defined for the field, this method returns the Help text for the extended data type that is used for the field, if applicable. If an array entry is specified, this method returns the Help text for the array element.

The following example shows retrieval of the Help text for the field.

DictField df; 
df = new DictField(tablenum(CustTable), fieldnum(CustTable, AccountNum)); 
if (df) 
{ 
    print df.help(); 
}

Applies to