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.6.308

Syntax

public interface IReference : ISingleton

Public Interface IReference
	Inherits ISingleton

public interface class IReference : ISingleton

type IReference =  
    interface
        interface ISingleton
    end

The IReference type exposes the following members.

Properties

	Name	Description
	Components	Get component references for all components on the site.
	Pages	Get the page references for all pages on the site.
	PublishingTargets	Gets the publishing target factory, only available when the site location is the design-time XML folder.
	SiteBaseUrl	Gets the base URL of the runtime site to which a publishing target publishes. This should always be an absolute URL.
	SitePath	Gets the physical location of the site xml content directory.

Methods

	Name	Description
	FilterPages	Filters a list of page IDs by their schema types and ancestor pages.
	GetAncestors	Get the page references for all the ancestors of a given page.
	GetChildren	Gets reference entries for the given page's children.
	GetItem	Get a page reference given a page ID.
	GetPageFilePath	Gets the specified page's file path. For design-time, this changes based on if the page is checked out, who it is assigned to, and which version is marked for the current publishing target.
	GetSiblings	The a list of references for the siblings of a given page.
	GetSubtree	Get the subtree of the specified page in XElement format, confined to the specified depth.
	Report	Reporting function declaration to be implemented with extending classes (Inherited from ISingleton.)