Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter EighteenDataView Integration (continued)

DataViewCloneRow Function

Overview

The DataViewCloneRow function copies an existing row or set of rows in a Data View Object and creates a new set of rows directly below the current row.

Syntax/Parameters

Syntax

int = DataViewCloneRow ( handle object, int index, [int rows],
                                               [int mode], [int destination] );

Parameters

object

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

index

An int specifying the zero-based row index from which to start the clone process.

rows

An optional int value to specify the number of rows to clone. The default value is 1.

mode

An optional set of flags to direct the cloning process. The default is DC_CLONE_NO_COPY_DATA, which means all of the attributes and styles of the cells will be cloned. The following flags are possible:

 Define  Bitwise Code  Description  
 DC_CLONE_COPY_ALL   0x00000000  Copies all the cell items, no other options should be used  
 DC_CLONE_NO_UNDO   0x00000010   Do not process undo  
 DC_CLONE_NO_COPY_DATA   0x00000020   Do not copy display data (default)  
 DC_CLONE_NO_COPY_ATTRIBUTES   0x00000040   Do not copy aggregate attribute data  
 DC_CLONE_NO_STYLE   0x00000080   Do not copy style data  
 DC_CLONE_ROW_HEIGHT   0x00000100   Clone row heights  

destination

An optional int specifying the destination. If omitted, rows are inserted directly after the source position plus the rows to insert.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure.

Remarks

The DataViewCloneRow function allows both row content and styles of the data to be cloned. The clone function can clone all attributes of a row, including the name. This can result in non-unique names. 

Related Functions

Platform Support

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