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

Public Interface IReference

public interface class IReference

type IReference =  interface end

The IReference type exposes the following members.

Properties

	Name	Description
	Components	Get all components on the site
	Pages	Get all pages on the site
	PublishingTargets	Publishing targets, only available when site location is design-time xml folder
	SiteBaseUrl	Only apply in runtime. Design-time will need to get from selected publishing target
	SitePath	Physical location of the site xml content directory

Methods

	Name	Description
	FilterPages	Filter page ids by schemas and ancestors
	GetAncestors	Get ancestors of give page
	GetChildren	Get child nodes of given page
	GetItem	Get a page entry by page id
	GetPageFilePath	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
	GetSiblings	The siblings of given page
	GetSubtree	Get the subtree of reference node in its original XElement format, which confined depth and maxNodes