  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eight — Data Functions (continued)
DataSheetSetCellTextWrap Function
Overview
The DataSheetSetCellTextWrap function sets the text wrap mode for a text cell at a specified location.
Syntax/Parameters
Syntax
int = DataSheetSetCellTextWrap ( handle hSheet, int row, int column, dword mode );
int = DataSheetSetCellTextWrap ( handle hSheet, string row, string column, dword mode );
int = DataSheetSetCellTextWrap ( handle hSheet, string address, dword mode );
Parameters
hSheet
A handle to a Data Sheet Object.
row
An int or string specifying a zero-based row or Y position for the cell.
column
An int or string specifying a zero-based column or X position for the cell.
address
A string specifying the cell position by cell address such as “A1”.
mode
An optional dword specifying the wrap mode. The default value is DS_CD_TEXT_WRAP_AUTO.
Return Value
An int as ERROR_NONE or a formatted error code on failure.
Remarks
By default text cells are set to no wrap. The mode values are as follows:
| Definition | Bitwise | Description | ||||
| DS_CD_TEXT_WRAP_MASK | 0x000C0000 | Wrap Mode Mask | ||||
| DS_CD_TEXT_WRAP_NONE | 0x00000000 | Cell Does Not Wrap | ||||
| DS_CD_TEXT_WRAP_BREAKS | 0x00040000 | Cell Data Wraps (allows hard breaks) | ||||
| DS_CD_TEXT_WRAP_AUTO | 0x00080000 | Cell Data Wraps (no breaks) | ||||
| DS_CD_TEXT_PREFORMATTED | 0x000C0000 | Content is Preformatted (no autowrap)*/ |
[The wrap option can also be set as a style, although the CSS style is limited to wrap or no wrap.]
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 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.