Sign in Join
FPDoc Onlineexperiment

TXMLConfig.GetListItemXPath function

Member of TXMLConfigpublicIn unit Laz2_XMLCfg

Gets the path specifier used to access a list item at the specified position.

Declaration

pascal
class function GetListItemXPath(const AName: string; 
 const AIndex: Integer; 
 const aLegacyList: Boolean=False; 
 const aLegacyList1Based: Boolean=False)
: string

Arguments

AName

Name for the list item.

AIndex

Position for the list item.

aLegacyList

Indicates that array-style notation (with square brackets) is not used when True.

aLegacyList1Based

Indicates if positions in the list start at 1 instead of 0.

Function result

Path specifier for the list item at the specified position.

Description

GetListItemXPath is a String class function used to get the path specifier used to access a list item at the specified position in the Document. The return value contains the path specifier constructed for the list item. For example:

'item0'
'item1'
'item[0]'

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.