Click or drag to resize

IReference Interface

Represents the reference file structure. Provides functionalities to fast query pages in various ways

Namespace:  Ingeniux.Runtime.Reference
Assembly:  IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.3.169
Syntax
public interface IReference

The IReference type exposes the following members.

Properties
  NameDescription
Public propertyComponents
Get all components on the site
Public propertyPages
Get all pages on the site
Public propertyPublishingTargets
Publishing targets, only available when site location is design-time xml folder
Public propertySiteBaseUrl
Only apply in runtime. Design-time will need to get from selected publishing target
Public propertySitePath
Physical location of the site xml content directory
Top
Methods
  NameDescription
Public methodFilterPages
Filter page ids by schemas and ancestors
Public methodGetAncestors
Get ancestors of give page
Public methodGetChildren
Get child nodes of given page
Public methodGetItem
Get a page entry by page id
Public methodGetPageFilePath
Gets the page file path. For design-time, changes based on if page is checked out, who it is assigned to, which version is marked for current publishing target
Public methodGetSiblings
The siblings of given page
Public methodGetSubtree
Get the subtree of reference node in its original XElement format, which confined depth and maxNodes
Top
See Also