Home > Contents > Index >
SITEPLAN.LISTPAGES
Queries the SitePlanTree table and then creates a list of pages, starting with the page node that you specify.
Syntax
<SITEPLAN.LISTPAGESNAME="
nodeName
"PLACEDLIST="
PlacedPages
"[LEVEL="
1
"]/>Parameters
NAME (required)
- Input. The name assigned to the site plan node whose unplaced or placed pages you want to list. This node must be loaded and assigned a name before you can pass its name to this tag. (See
SITEPLAN.LOAD
.)
PLACEDLIST (required)
- Input. The name to assign to the list of placed pages.
LEVEL (optional)
- Input. The number of node levels to list, starting with the node identified by the
NAME
parameter. The default is 10000.
Description
This tag creates a hierarchical list of the pages in the site plan. You can determine which page node to start with and how many levels in the hierarchy to list.
The list contains the following column names:
PageName
- Name of the page.
ParentName
- Name of the parent in the tree.
NodeLevel
- Level in the tree relative to the parent.
PlacedValue
- Specifies if the page is placed or unplaced.
AssetType
- Type of asset.
Id
- Asset's ID.
HasChildren
- Specifies if the asset has children, possible values aretrue
orfalse
.
Nid
- Node ID of SitePlan tree entry.Error Numbers
The possible values for
errno
include:
Value Description -10001 The implementing class is invalid. -10002 There is a missing method for the implementing class. -10003 The method could not be invoked successfully. -10004 A required parameter is missing. -10005 The requested object is not in the object pool (is not loaded into memory). -10006 The object ID is not valid. -10007 The version of the object is not valid. -10008 The node ID of the object is not valid. -10009 More than one object met the specified criteria.Example
This code lists all the placed pages under the site plan node identified as "thePubNode" to one level in the tree; that is, it lists the child pages for "thePubNode" but not its grandchildren, or great-grandchildren, and so on.
<SITEPLAN.LISTPAGES NAME="thePubNode"
PLACEDLIST="placedPages" LEVEL="1"/>See Also
COPYLIST
FILELIST
FLUSH
GOTOROW
ISINLIST
LOOP
RENAMELIST
SETROW
STRINGLIST
Home > Contents > Index > ![]()
Oracle XML Tag Reference
Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved.