PageDefinitionOptions Plugin Supplementary Type

Ben Tiedt — Fri, 08 Mar 2024 17:14:03 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:14:03

Provides additional options when defining a a page-based url.

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

Definition

class PageDefinitionOptions
{
	string DefaultPageXml { get; set;  }
	string Description { get; set;  }
	Func<string> DescriptionFunction { get; set;  }
	bool ForceLowercaseUrl { get; set;  }
	bool HasApplicationContext { get; set;  }
	Action<[[PageContext Plugin Supplementary Type|PageContext]]> ParseContext { get; set;  }
	Func<Guid,string> SampleUrlFunction { get; set;  }
	Action<[[PageContext Plugin Supplementary Type|PageContext]],[[IPageOutputController Plugin Supplementary Type|IPageOutputController]]> SetCustomPageOutput { get; set;  }
	string Title { get; set;  }
	Func<string> TitleFunction { get; set;  }
	Action<[[PageContext Plugin Supplementary Type|PageContext]],[[IUrlAccessController Plugin Supplementary Type|IUrlAccessController]]> Validate { get; set;  }
	Func<[[PageContext Plugin Supplementary Type|PageContext]],[[IUrlAccessController Plugin Supplementary Type|IUrlAccessController]],Task> ValidateAsync { get; set;  }
}

Properties

Name	Type	Description
DefaultPageXml	`string`	An xml string that defines default regions and widgets for a page.
Description	`string`	A description that describes the purpose and function of the page.
DescriptionFunction	`Func<string>`	A function that returns a description that describes the purpose and function of the page. Overrides Description.
ForceLowercaseUrl	`bool`	forces the url to be lowercase when rendered. The default is true.
HasApplicationContext	`bool`	Set to true for application landing pages that are not for a specific application, such as an application listing page.
ParseContext	`Action<[[PageContext Plugin Supplementary Type\|PageContext]]>`	Allows for the parsing of url token information that can be added to the page context.
SampleUrlFunction	`Func<Guid,string>`	A function that takes the theme-specific application ID and provides a URL to view the page.
SetCustomPageOutput	`Action<[[PageContext Plugin Supplementary Type\|PageContext]],[[IPageOutputController Plugin Supplementary Type\|IPageOutputController]]>`	Provides the ability to define Meta tags, raw headers and footers, and set custom httpHeaders.
Title	`string`	Default title for the page.
TitleFunction	`Func<string>`	A function that returns the default title for the page. Overrides Title.
Validate	`Action<[[PageContext Plugin Supplementary Type\|PageContext]],[[IUrlAccessController Plugin Supplementary Type\|IUrlAccessController]]>`	Called after a context is parsed. Allows for redirects and access checking before a page is served.
ValidateAsync	`Func<[[PageContext Plugin Supplementary Type\|PageContext]],[[IUrlAccessController Plugin Supplementary Type\|IUrlAccessController]],Task>`	Called after a context is parsed. Allows for redirects and access checking before a page is served.