KlipFolio

The KlipFolio object provides an API to access information about KlipFolio.

Example

The following Klip queries KlipFolio about its runtime environment.

<klip>
   <identity>
      <title>
         API: KlipFolio
      </title>
   </identity>
   <locations>
      <defaultlink>
        http://www.openlava.com/
      </defaultlink> 
      <contentsource>
         http://www.serence.com/support/samples/demo/demo-static.xml
      </contentsource>
      <icon>
         http://www.serence.com/support/samples/images/sample_icon.png
      </icon>
      <banner>
         http://www.serence.com/support/samples/images/sample_banner.png
      </banner>
   </locations>
   <setup>
     <refresh>
       120 
     </refresh> 
     <referer>
       http://www.serence.com/
     </referer>
     <codepage> 
       1252
     </codeage>
   <identity>
     <uniqueid>
       serence20041212
     </uniqueid>
   </identity>
   </setup>
   <messages>
     <loading>
       Please wait, getting data...
     </loading> 
     <nodata>
       No items to display.
     </nodata> 
   </messages>
   <klipscript>
   <![CDATA[

function onLoad() {
    trace( "     KlipFolio.version = " + KlipFolio.version + "\r\n" );
    trace( "      KlipFolio.build  = " + KlipFolio.build  + "\r\n" );
    trace( "   KlipFolio.codepage  = " + KlipFolio.codepage  + "\r\n" );
    trace( "   KlipFolio.language  = " + KlipFolio.language  + "\r\n" );
    trace( "KlipFolio.langversion  = " + KlipFolio.langversion  + "\r\n" );
}

function onRefresh()
{
    var xml = "<xml><item><link></link><description>" +
          "(See Debug Window for output)" +
          "</description></item></xml>";

    return Engines.KlipFood.process( xml );

}
   ]]>
   </klipscript>
</klip>

Upon loading, KlipFolio will display the following output in the Debug Window.

      KlipFolio.version = KlipFolio 5.0 Beta D
       KlipFolio.build  = 5899
    KlipFolio.codepage  = 1252
    KlipFolio.language  = English
 KlipFolio.langversion  = 1.3

(Your output will differ depending on your environment and KlipFolio version.)

Properties Summary
`integer`	`build` Returns the numeric build number for KlipFolio (read-only).
`integer`	`codepage` Returns numeric codepage of the local language for KlipFolio (read-only).
`String`	`language` Returns the English name of the local language for KlipFolio (read-only).
`String`	`langversion` Returns the version string of the local language currently for KlipFolio (read-only).
`String`	`version` Returns the full version text for KlipFolio (read-only).

Properties Detail

build

integer build

Returns the numeric build number for KlipFolio (read-only).

codepage

integer codepage

Returns numeric codepage of the local language for KlipFolio (read-only).

language

String language

Returns the English name of the local language for KlipFolio (read-only).

langversion

String langversion

Returns the version string of the local language currently for KlipFolio (read-only).

version

String version

Returns the full version text for KlipFolio (read-only).

Overview

Object

Tree

Index

Help

KlipFolio 5.0 API

PREV OBJECT NEXT OBJECT

FRAMES NO FRAMES

SUMMARY: PROPERTY | FUNCTION