Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter Twenty-threeXBRL Functions (continued)

XBRLViewGetPresentationType Function

Overview

The XBRLViewGetPresentationType function analyzes a presentation name and returns a classification code. The major classifications are based on the UGT presentation naming conventions.

Syntax/Parameters

Syntax

int = XBRLViewGetPresentationType ( string name | [handle hXBRL, int position ] );

Parameters

name

A string containing a conventional presentation name such as “Statement - Balance Sheet”. This string cannot be larger than 1024 characters.

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

An int containing the presentation code or a formatted error code. The GetLastError function will return the same formatted error code.

Remarks

The values are UGT centric and are defined as follows:

  Definition   Ordinal
Value
  Description
  General        
    XT_PT_UNKNOWN   0   Unknown/Not Set
    XT_PT_COVER_ENTITY   101   Entity
  US-GAAP        
    XT_PT_STATEMENT_UNKNOWN   110   Statement - Unknown/Non-Standard
    XT_PT_STATEMENT_BALANCE_SHEET   111   Statement - Balance Sheet
    XT_PT_STATEMENT_CASH_FLOWS   112   Statement - Cash Flows
    XT_PT_STATEMENT_OPERATIONS   113   Statement - Operations
    XT_PT_STATEMENT_EQUITY   114   Statement - Changes in Equity
    XT_PT_STATEMENT_BALANCE_SHEET_P   121   Parenthetical - Balance Sheet
    XT_PT_STATEMENT_CASH_FLOWS_P   122   Parenthetical - Cash Flows
    XT_PT_STATEMENT_OPERATIONS_P   123   Parenthetical - Operations
    XT_PT_STATEMENT_EQUITY_P   124   Parenthetical - Changes in Equity
    XT_PT_DISCLOSURE_TEXT   131   Disclosure Text
    XT_PT_DISCLOSURE_POLICY   132   Disclosure Accounting Policy
    XT_PT_DISCLOSURE_TABLE   133   Disclosure Table
    XT_PT_DISCLOSURE_DETAIL   134   Disclosure Detail
    XT_PT_DISCLOSURE_NARRATIVE   135   Disclosure Narrative
  Pseudo Presentations (not exported)        
    XT_PT_PSEUDO_SCHEMA   501   Schema Information
    XT_PT_PSEUDO_CONTEXTS   502   Context Information
    XT_PT_PSEUDO_XBRL_FIELDS   503   XBRL Financial Fields (Raw Facts)
    XT_PT_PSEUDO_CUSTOM_FIELDS   504   Custom Fields (Taxonomy Extensions)
    XT_PT_PSEUDO_FOOTNOTES   505   Footnotes
    XT_PT_PSEUDO_PROSPECTUS   506   Prospectus Organization
    XT_PT_PSEUDO_SERIES   507   Series and Classes
    XT_PT_PSEUDO_PERFORMANCE   508   Performance

 

Related Functions

Platform Support

GoFiler Complete, GoFiler Corporate, GoXBRL