Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter NineDialog Functions (continued)

HypertextControlGetState Function

Overview

The HypertextControlGetState retrieves the properties associated an activated hypertext link within a Hypertext Control.

Syntax/Parameters

Syntax

string [] = HypertextControlGetState ( int id );

Parameters

id

An int containing the control ID of a ‘syslink’ class control.

Return Value

Returns a string array containing named properties or an empty array on failure. Use the GetLastError function to retrieve error information. In validation mode, the last error code will contain the control ID which can be returned directly to the dialog validate procedure to set focus on the offending control.

Remarks 

The HypertextControlGetState can only be used in response to a NM_CLICK or NM_RETURN notification within a dialog notify procedure. It returns the following named array positions: 

  Name   Description  
  Index   A decimal string containing the zero-based index of the link being clicked.  
  State   A hexadecimal string containing state flags.  
  ID   A copy of the supplied ID for the link.  
  HREF   A copy of the supplied HREF for the link.  

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic