PageContext Plugin Supplementary Type

Contains all the contextual information derived from a defined url.

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

Definition

class PageContext : IPageContext
{
	PageContext();
	PageContext(IDictionary<string,Object> tokenValues, string urlName);
	PageContext(IDictionary<string,Object> tokenValues, string urlName, string pageName, Guid? containerTypeId, Guid? applicationTypeId);
	Guid? ApplicationTypeId { get; set;  }
	Guid? ContainerTypeId { get; set;  }
	IContextCollection ContextItems { get; set;  }
	IDictionary<string,Object> Data { get;  }
	bool? PageIsCustom { get; set;  }
	string PageName { get; set;  }
	Object State { get; set;  }
	Guid? ThemeApplicationId { get; set;  }
	Guid? ThemeTypeId { get; set;  }
	string UrlName { get; set;  }
	int UserId { get; set;  }
	Object GetTokenValue(string token);
}

Constructors

PageContext();

PageContext(IDictionary<string,Object> tokenValues, string urlName);

Parameters

Name	Type	Description	Required	Default	Options
tokenValues	`IDictionary<string,Object>`	Token Values	Required
urlName	`string`	Url Name	Required

PageContext(IDictionary<string,Object> tokenValues, string urlName, string pageName, Guid? containerTypeId, Guid? applicationTypeId);

Parameters

Name	Type	Description	Required
tokenValues	`IDictionary<string,Object>`	Token Values	Required
urlName	`string`	Url Name	Required
pageName	`string`	Page Name	Required
containerTypeId	`Guid?`	Container Type Id	Required
applicationTypeId	`Guid?`	Application Type Id	Required

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.
Data	`IDictionary<string,Object>`
PageIsCustom	`bool?`	Identifies if the page is custom.
PageName	`string`	The name of the page.
State	`Object`	A user defined object that can be used to store data that is persisted across url parsing and validation.
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

Recommended