Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter EighteenDataView Integration (continued)

DataViewGetRowProps Function

Overview

The DataViewGetRowProps function returns all the properties associated with a specified row entry within a Data View object.

Syntax/Parameters

Syntax

string[] = DataViewGetRowProps ( handle object, int index );

Parameters

object

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

index

An int specifying the zero-based row index.

Return Value

Returns an array of strings containing named entries for each discrete property of a row or an empty array on failure. Use the GetLastError function to retrieve error information.

Remarks

This function is a higher level version of the DataSheetGetRowProps function. All row information is returned in an array. The named fields are as follows:

  RowIndex Provided as a courtesy to indicate the row referenced.  
  RowName Name of the row. This can be blank. When a row legend is displayed while viewing a data object, the row index+1 or the row name is displayed in the legend.  
  pxHeight The height of the row as it would be displayed in pixels.  
  pvHeight The height as specified as a pvalue type (see Section 11.1 Introduction to SGML Support). If zero, the row height is being automatically calculated.  
  pxPosition The absolute visual position of the row from the top of the sheet (0 position).  
  ControlFlags Internal control flags (see below).  
CallerData A 32-bit caller data word. This is the same value accessed via the DataViewGetRowDataWord function.  

See DataSheetGetRowProps for ControlFlags definition.

Related Functions

Platform Support

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