GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Eighteen — DataView Integration (continued)

DataViewCellSetByName Function

Overview

The DataViewCellSetByName function searches for a cell by its name and sets the working/display text for a cell.

Syntax/Parameters

Syntax

int = DataViewCellSetByName ( handle object, string name, string data );

Parameters

object

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

name

A string specifying an existing cell name.

data

A string to set as the cell’s text. Note that the cell type must be able to accept the text being submitted.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure. Use the GetLastError function to retrieve error information.

Remarks

The DataViewCellSetByName function sets the current text contained in a cell after locating the cell by its name. In most cases, this is the same as the cell display text but for certain types it may return the data that supports the cell. For example, if the cell type is checkbox, the return value will be blank, 0 or 1. The maximum size of the text of a cell is 2MB.

Note that uniqueness of the name is not tested. The first match cell is set.

Related Functions

DataViewFindCellByName — Locates a cell by its name, returns a cell address.

DataViewCellGetByName — Gets the text (current display value) of a cell by using the cell name.

DataViewCellGetData — Returns all the properties/data items for a cell.

DataViewCellGetName — Gets the name of a cell.

DataViewCellGetText — Gets the text (current display value) of a cell.

DataViewCellSetText — Sets the text (working display data) of a cell.

Platform Support

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

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.