  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Twenty-three — XBRL Functions (continued)
XBRLViewGetPresentationContexts Function
Overview
The XBRLViewGetPresentationContexts function returns an array of all the column context IDs used on a presentation. The array matches the index position of column items for the presentation.
Syntax/Parameters
Syntax
string [] = XBRLViewGetPresentationContexts ( handle hXBRL, int position );
Parameters
hXBRL
A handle containing the reference to an XBRL object.
position
An int specifying the zero-based presentation index within the XBRL data set. Note that this value is the position in the XBRL Object which can include pseudo presentations.
Return Value
A string array containing the context IDs in column position or an empty array on error. Use the GetLastError function to retrieve a formatted error code.
Remarks
This function only applies to an XBRL View objects. The first entry will always be empty.
On presentations with dimensional data, the context IDs will point to a context that matches the member or axis elements, however, the date or date range is not relevant since it is declared by the members on the line items.
The index position in the array can be used to access display facts on the presentation by column position.
Note that XBRL presentations do not store the contexts as they may appear on a presentation. The contexts on a presentation are for display, editing and rendering purposes only.
Related Functions
Platform Support
GoFiler Complete, GoFiler Corporate, GoXBRL
| 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.