Class Page

Inheritance
System.Object
BaseModel
Page
Inherited Members
Namespace: PnP.Framework.Provisioning.Model
Assembly: PnP.Framework.dll
Syntax
public class Page : BaseModel, IProvisioningTemplateDescendant

Constructors

Page()

Constructor for Page class

Declaration
public Page()

Page(String, Boolean, WikiPageLayout, IEnumerable<WebPart>, ObjectSecurity, Dictionary<String, String>)

Constructor for Page class

Declaration
public Page(string url, bool overwrite, WikiPageLayout layout, IEnumerable<WebPart> webParts, ObjectSecurity security = null, Dictionary<String, String> fields = null)
Parameters
System.String url

Url of the page
System.Boolean overwrite

Overwrite flag for the page
WikiPageLayout layout

Page Layout
IEnumerable<WebPart> webParts

Webparts of the page
ObjectSecurity security

Security Rules for the page
Dictionary<String, String> fields

Fields used in the page

Page(String, Boolean, WikiPageLayout, IEnumerable<WebPart>, Boolean, ObjectSecurity)

Declaration
public Page(string url, bool overwrite, WikiPageLayout layout, IEnumerable<WebPart> webParts, bool welcomePage = false, ObjectSecurity security = null)
Parameters
System.String url

System.Boolean overwrite

WikiPageLayout layout

IEnumerable<WebPart> webParts

System.Boolean welcomePage

ObjectSecurity security

Page(String, Boolean, WikiPageLayout, IEnumerable<WebPart>, Boolean, ObjectSecurity, Dictionary<String, String>)

Declaration
public Page(string url, bool overwrite, WikiPageLayout layout, IEnumerable<WebPart> webParts, bool welcomePage = false, ObjectSecurity security = null, Dictionary<String, String> fields = null)
Parameters
System.String url

System.Boolean overwrite

WikiPageLayout layout

IEnumerable<WebPart> webParts

System.Boolean welcomePage

ObjectSecurity security

Dictionary<String, String> fields

Properties

Fields

The Fields to setup for the Page

Declaration
public Dictionary<String, String> Fields { get; }
Property Value
Dictionary<String, String>

Layout

Gets or sets the WikiPage layout

Declaration
public WikiPageLayout Layout { get; set; }
Property Value
WikiPageLayout

Overwrite

Gets or sets the overwrite flag for the page

Declaration
public bool Overwrite { get; set; }
Property Value
System.Boolean

Security

Defines the Security rules for the Page

Declaration
public ObjectSecurity Security { get; }
Property Value
ObjectSecurity

Url

Gets or sets the page Url

Declaration
public string Url { get; set; }
Property Value
System.String

WebParts

Gets or sets the webparts of the page

Declaration
public WebPartCollection WebParts { get; }
Property Value
WebPartCollection

WelcomePage

Declaration
public bool WelcomePage { get; set; }
Property Value
System.Boolean

Methods

Equals(Page)

Compares Page object based on Url, Overwrite, Layout, WelcomePage, Webparts, Security and Fields properties.

Declaration
public bool Equals(Page other)
Parameters
Page other

Page object
Returns
System.Boolean

true if the Page object is equal to the current object; otherwise, false.

Equals(Object)

Compares object with Page

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Object that represents Page
Returns
System.Boolean

true if the current object is equal to the Page

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

Extension Methods