  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Nine — Dialog Functions (continued)
DataControlSetEditStatusString Function
Overview
The DataControlSetEditStatusString function sets the cell’s display type.
Syntax/Parameters
Syntax
int = DataControlSetEditStatusString ( int id, string message );
Parameters
id
An int containing the control ID of the data control.
message
An ANSI encoded string specifying the template for the status message.
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure. Common error codes are as follows: ERROR_RANGE if id is an invalid control ID for the open dialog or ERROR_INVALID_HANDLE if no dialog is open. Use the GetLastError function to retrieve error information.
Remarks
The edit status string is only used during on sheet editing and is displayed in the designated status window.
The string must contain two “%d” formatted decimal values indicating the number of characters in the control and the maximum number of characters.
The value can be repeatedly set for various controls to add descriptive information.
A limit must be set using the DataControlSetActionReturnCode in response to a DCN_GET_EDIT_CONTROL_SIZE action.
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.