PageContext Plugin Supplementary Type

Ben Tiedt — Tue, 19 Nov 2019 19:39:23 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 19:39:23

Contains all the contextual information derived from a defined url.

PageContext is defined in the Telligent.Evolution.Extensibility.Urls.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

class PageContext
{
	Guid? ApplicationTypeId { get; set;  }
	Guid? ContainerTypeId { get; set;  }
	IContextCollection ContextItems { get; set;  }
	bool? PageIsCustom { get; set;  }
	string PageName { get; set;  }
	Guid? ThemeApplicationId { get; set;  }
	Guid? ThemeTypeId { get; set;  }
	string UrlName { get; set;  }
	int UserId { get; set;  }
	Object GetTokenValue(string token);
}

Properties

Name	Type	Description
ApplicationTypeId	`Guid?`	Identifies the application type of a url if applicable.
ContainerTypeId	`Guid?`	Identifies the container type of a url if applicable.
ContextItems	`IContextCollection`	A collection of items in the current context of the url, usually placed there when ParseContext is called on a url.
PageIsCustom	`bool?`	Identifies if the page is custom.
PageName	`string`	The name of the page.
ThemeApplicationId	`Guid?`	Identifies the thememable application's identifier if applicable.
ThemeTypeId	`Guid?`	Identifies the theme type of a url if applicable.
UrlName	`string`	The name of the url as identified in the url collection.
UserId	`int`	The Id of the accessing user.

Methods

Object GetTokenValue(string token);

Obtains the value passed in the place of a defined url token without the { } braces.

Parameters

Name	Type	Description	Required	Default	Options
token	`string`	Token	Required

Return Type

Object