OpenViewIDByAlias Method

The OpenViewIDByAlias method returns the ID of the view with the specified alias.

Syntax

object.OpenViewIDByAlias

(

i_Alias As String,

i_NameFallback As Boolean = False

) As Number

Parameters

Parameter Description

i_Alias

Alias of the view to find.

i_NameFallback

TRUE to use the view name if not found by alias; FALSE otherwise.

Return Value

The return value is the ID of the view.

Remarks

If the i_NameFallback parameter has a TRUE value and the specified alias cannot be found, the method attempts to find a view with a display name equal to the i_Alias parameter value.

If you are developing scripts or macros that use the OpenViewIDByAlias method, you should define the specified name as an alias for the view. Although you can use the display name of the form, the method will not work if the display name is changed. If a Forms tool is being modified to work with different locales, the display name may be changed, but the alias should be unchanged.

See Also

Reference

IGrooveFormsToolUIDelegate Interface
OpenFormIDByAlias Method