DictType.Help Method

Definition

Overloads

Help()

Provides the Help text that is displayed for an extended data type or a specified array element, or for the extended data type that an extended data type extends.

Help(Int32)
Help(Int32, Boolean)

Help()

Provides the Help text that is displayed for an extended data type or a specified array element, or for the extended data type that an extended data type extends.

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

A string value for the Help text that is displayed for the extended data type, or for an array element if the arrayEntry value is provided. The Help text corresponds to the Help Text property for an extended data type or array element in the Finance and Operations Application Object Tree (AOT). When an extended data type does not have Help text, the method returns the Help text that is defined for the extended data type that the extended data type extends.

Applies to

Help(Int32)

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

Parameters

arrayIndex
Int32

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

Returns

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
useInterfaceLanguage
Boolean

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

Returns

Applies to