Watch our RX24 Keynotes!

Model Map

Model Map

Key
A required field.
A property on the database.
Not mapped to the database. These fields are computed and are only available in the object.
These fields are available where Lava is supported.
These methods or fields are obsolete and should not be used.

Model Details

Show: Methods

Page

Represents an individual webpage in Rock. A page is a container on a Site that has a Layout which consists of one or more content area zones. Each content area zone on the page can contain zero or more Blocks.. Pages are hierarchical, and are used to create the structure of the site. Each page can have one parent Page and zero or more children pages, and the page hierarchy is used to create the SiteMap.
Properties
AdditionalLavaFields
AdditionalSettings [Obsoleted in v16] Use AdditionalSettingsJson instead. Gets or sets the additional settings.
AdditionalSettingsJson
AllowIndexing Gets or sets a value indicating whether [allow indexing].
Attributes
AttributeValueDefaults
AttributeValues
AvailableKeys
Blocks Gets or sets the collection of Blocks that are used on the page.
BodyCssClass Gets or sets the body CSS class.
BotGuardianLevel Gets or sets the Bot Guardian Level for the Page. This is a hard coded list of values defined in the code as an enumeration.
Show Values
BreadCrumbDisplayIcon Gets or sets a value indicating whether icon is displayed in breadcrumb.
BreadCrumbDisplayName Gets or sets a value indicating whether the Page Name is displayed in the breadcrumb.
BrowserTitle Gets or sets the browser title to use for the page.
CacheControlHeader Gets the cache control header. This shouldn't be used to set the properties directly but the json version should be used to set the CacheControlHeaderSettings property.
CacheControlHeaderSettings Gets or sets the cache control header settings.
ContextKey
CreatedByPersonAlias
CreatedByPersonAliasId
CreatedByPersonId
CreatedByPersonName
CreatedDateTime
CustomSortValue
Description Gets or sets a user defined description of the page. This will be added as a meta tag for the page
DisplayInNavWhen Gets or sets a value indicating when the Page should be displayed in the navigation. This is a hard coded list of values defined in the code as an enumeration.
Show Values
EnableViewState Gets or sets a flag indicating if view state should be enabled on the page.
EncryptedKey
EntityStringValue
ForeignGuid
ForeignId
ForeignKey
Guid
HeaderContent Gets or sets HTML content to add to the page header area of the page when rendered.
IconBinaryFile Gets or sets the icon BinaryFile.
IconBinaryFileId Gets or sets the icon binary file identifier.
IconCssClass Gets or sets the icon CSS class name for a font vector based icon.
Id
IdKey
IncludeAdminFooter Gets or sets a flag indicating if the admin footer should be displayed when a Site Administrator is logged in.
InternalName Gets or sets the internal name to use when administering this page
IsRateLimited Gets a value indicating whether this instance is rate limited.
IsSystem Gets or sets a flag indicating if the Page is part of the Rock core system/framework.
IsValid
Item
KeyWords Gets or sets the key words.
Layout Gets or sets the Layout that the pages uses.
LayoutId Gets or sets the Id of the Layout that this Page uses.
MedianPageLoadTimeDurationSeconds Gets or sets the median page load time in seconds. Typically calculated from a set of Interaction.InteractionTimeToServe values.
MenuDisplayChildPages Gets or sets a flag indicating if the Page's children Pages should be displayed in the menu.
MenuDisplayDescription Gets or sets a flag indicating if the Page description should be displayed in the menu.
MenuDisplayIcon Gets or sets a flag indicating if the Page icon should be displayed in the menu.
ModifiedAuditValuesAlreadyUpdated
ModifiedByPersonAlias
ModifiedByPersonAliasId
ModifiedByPersonId
ModifiedByPersonName
ModifiedDateTime
Order Gets or sets a number indicating the order of the page in the menu and in the site map. This will also affect the page order in the menu. This property is required.
OutputCacheDuration [Obsoleted in v12] You should use the new cache control header property. Gets or sets a value indicating the length of time (in seconds) in that rendered output is cached. This property is required.
PageContexts Gets or sets a collection of PageContext entities that are used on this page.
PageDisplayBreadCrumb Gets or sets a flag indicating whether breadcrumbs are displayed on Page
PageDisplayDescription Gets or sets a value indicating whether the Page description should be displayed on the page.
PageDisplayIcon Gets or sets a value indicating whether the Page icon should be displayed on the Page.
PageDisplayTitle Gets or sets a value indicating whether the Page Title should be displayed on the page (if the Layout supports it).
PageRoutes Gets or sets the PageRoutes that reference this page.
Pages Gets or sets the collection of the current page's child pages.
PageTitle Gets or sets the title of the of the Page to use as the page caption, in menu's, breadcrumb display etc.
ParentAuthority Gets the parent authority for the page. Page security is automatically inherited from the parent page, unless explicitly overridden. If there is no parent page, it is inherited from the site (through the layout)
ParentAuthorityPre
ParentPage Gets or sets the Page entity for the parent page.
ParentPageId Gets or sets the Id of the parent Page.
RateLimitPeriod [Obsoleted in v16.7] Use RateLimitPeriodDurationSeconds instead. Gets or sets the rate limit period (in seconds).
RateLimitPeriodDurationSeconds Gets or sets the rate limit period (in seconds).
RateLimitRequestPerPeriod Gets or sets the rate limit request per period.
RequiresEncryption Gets or sets a flag that indicates if the Page requires SSL encryption.
SiteId Gets the site identifier of the Page's Layout. NOTE: This is needed so that Page Attributes qualified by SiteId work.
SupportedActions Provides a Dictionary`2 of actions that this model supports, and the description of each.
TypeId
TypeName
UrlEncodedKey
ValidationResults