Page Configuration

Defines site pages with web parts, content, and layout configuration.

Referenced by: SiteCfg.PageSet, SiteCfg.PageSets, SharepointCfg.PageCfgs, Office365GroupCfg.

Overview

PageCfg defines a SharePoint page (modern or classic) with its web parts, content, and display settings. Pages can be set as the home page or additional pages within a site.

Nested configurations:

• PageWebPartCfg (list) — individual web parts on the page

Applied when

Pages are created when:

• The parent SiteCfg is provisioned and references this configuration via PageSet or PageSets
• OR the parent Office365GroupCfg is provisioned and references this configuration
• Applied during site provisioning; pages are created after the site is created
• All web parts configured in PageWebPartCfg (list) are added to the page when it is created
• If IsHomePage is true, this page is set as the site's home page; only one page can be the home page
• Retroactive changes to page content (web parts, layout) may require manual SharePoint administration or page re-creation

Core settings

Name

Type: string | Required: Yes

Unique name for this page configuration. Referenced from SiteCfg.PageSet or SiteCfg.PageSets.

Example: "HomePage", "DashboardPage"

PageName

Type: string | Required: No | Default: "Home.aspx"

File name of the page (including .aspx extension). Must be unique within the site.

Example: "Home.aspx", "Dashboard.aspx"

PageTemplateUrl

Type: string | Required: No

Template URL to base the page on. When specified, the page is created using this template as a starting point.

Example: "/sites/templates/standardpage.aspx"

Title

Type: string | Required: No

Page title displayed in SharePoint UI and browser tab.

Example: "Home", "Dashboard"

Home page settings

PromoteAsHomePage

Type: bool | Required: No

Set this page as the site home page (internal use). When enabled, this page is displayed when users navigate to the site root. Only one page can be the home page.

Content and layout (Modern SharePoint)

Note: Properties in this section apply only to SharePoint Online and SharePoint 2019+ modern pages. They are ignored on SharePoint 2013/2016 and classic page layouts.

CommentsEnabled

Type: bool | Required: No | Applies When: Modern SharePoint (2019+, Online)

Enable comments on the page. When enabled, users can add comments to page content.

PageLayoutType

Type: enum | Required: No | Applies When: Modern SharePoint Online only

Layout type for modern pages. Valid values:

• Article — Article layout for content pages
• Home — Home page layout for site homepage
• ReNews — News article layout

PageSpaceContent

Type: enum | Required: No | Applies When: SharePoint Online only

Space content configuration for modern pages. Controls how content is organized and displayed in the page layout.

HeaderLayoutType

Type: enum | Required: No | Applies When: Modern SharePoint Online only

Header layout style. Valid values:

• Default — Standard header with site title and navigation
• Minimal — Compact header with less visual weight
• None — No header (content starts at top)

Web parts

WebParts

Type: PageWebPartCfg (list) | Required: No

Array of web parts to add to the page. Each web part is configured with its own settings.

Web part definition (within WebParts (list))

Name

Type: string | Required: Yes

Web part name. Used internally to identify the web part instance.

Example: "MainContentWebPart", "NewsRoll"

Title

Type: string | Required: No

Web part title displayed on the page to users.

Example: "Latest News", "Recent Documents"

TypeOfWebPart

Type: enum | Required: Yes | Applies When: SharePoint 2019+, SharePoint Online, modern deployments (not 2013/2016)

Built-in web part type. Valid values: ContentSearch, DocumentCard, DocumentLibrary, Events, Feeds, FileViewer, Form, Hero, Highlighted, HtmlViewer, Image, ImageGallery, Links, News, Office365Video, PageTitle, PeoplePicker, QuickChart, Rss, SearchBox, SearchResults, Sites, Teams, Text, UsageAnalytics, Video, YammerFeed

Note: This property is not available on SharePoint 2013/2016.

TypeOfWebPartGuid

Type: Guid | Required: No

Custom web part GUID (for third-party web parts). Allows embedding custom or vendor web parts on the page.

Example: "12345678-1234-1234-1234-123456789012"

HtmlBody

Type: string | Required: No

HTML content for HTML viewer web parts. Can contain formatted content, images, and styled text.

Note: Only applies when TypeOfWebPart = HtmlViewer.

HtmlCulture

Type: string | Required: No

Culture/language for HTML content. Specifies the locale for text rendering and localization.

Example: "en-US", "fr-FR"

ChartColumnNames

Type: string (list) | Required: No

Chart column names for chart web parts. Specifies which columns from a data source are displayed in a chart.

Example: ["Month", "Sales", "Expenses"]

Note: Only applies when TypeOfWebPart = QuickChart or similar chart types.

Related

• Site Configuration — pages in sites
• Office 365 Group Configuration — pages in teams
• Team Channel Configuration — team channel pages