  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The OutlineGetItemText function retrieves the content of an output entry as plain text or PCDATA.
Syntax/Parameters
Syntax
string = OutlineGetItemText ( handle hOutline, int position, [boolean pcdata] );
Parameters
hOutline
A handle to an HTML Outline Object.
position
An int specifying the zero-based position for a mapped outline entry.
pcdata
An optional boolean flag indicating that PCDATA is desired. The default is to convert all character entity data to ANSI (as possible). Setting this parameter to TRUE (1) causes character entities to be passed through as code text.
Return Value
A string containing the ANSI for the outlines item. On error, the string will be empty. Use the GetLastError function to retrieve a formatted error code.
Remarks
As HTML is translated to text, breaks, new paragraphs, divisions and rows will add respective line returns into the returning text. Table cells will add a tab character.
The returned data will be the text, less all tags as either plain ANSI or as PCDATA.
The maximum size of data that can be retrieved is 2MB. Preformatted text cannot be retrieved without losing formatting.
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.