Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter EighteenDataView Integration (continued)

DataViewGetCaretCol Function

Overview

The DataViewGetCaretCol function returns the current caret column position within a Data View Object.

Syntax/Parameters

Syntax

int = DataViewGetCaretCol ( handle object );

Parameters

object

A handle to either a Data View Object or to a window that employs Data View.

Return Value

Returns an int containing the zero-based column position or -1 on failure. Use the GetLastError function to retrieve error information. The GetLastErrorMessage function may return additional information.

Remarks

This is the equivalent of retrieving the X caret position for an Edit Object.

Related Functions

Platform Support

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