Class BaseClientSidePage

Defines a base Client Side Page

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

Constructors

BaseClientSidePage()

Constructor for BaseClientSidePage class

Declaration
public BaseClientSidePage()

Properties

ContentTypeID

Defines the ContentTypeID for the client-side page

Declaration
public String ContentTypeID { get; set; }
Property Value
String

EnableComments

Defines whether the page will have comments enabled or not

Declaration
public Boolean EnableComments { get; set; }
Property Value
Boolean

FieldValues

Defines the page fields values, if any

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

Header

Defines the Header for the client-side page

Declaration
public ClientSidePageHeader Header { get; set; }
Property Value
ClientSidePageHeader

Layout

Defines the Layout for the client-side page

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

Overwrite

Defines whether the page can be overwritten if it exists

Declaration
public Boolean Overwrite { get; set; }
Property Value
Boolean

PromoteAsNewsArticle

Defines whether to promote the page as a news article, optional attribute

Declaration
public Boolean PromoteAsNewsArticle { get; set; }
Property Value
Boolean

PromoteAsTemplate

Defines whether to promote the page as a template, optional attribute

Declaration
public Boolean PromoteAsTemplate { get; set; }
Property Value
Boolean

Properties

Defines property bag properties for the client side page

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

Publish

Defines whether to publish the client-side page or not

Declaration
public Boolean Publish { get; set; }
Property Value
Boolean

Sections

Gets or sets the sections

Declaration
public CanvasSectionCollection Sections { get; }
Property Value
CanvasSectionCollection

Security

Defines the Security rules for the client-side Page

Declaration
public ObjectSecurity Security { get; }
Property Value
ObjectSecurity

ThumbnailUrl

Defines the URL of the thumbnail for the client side page

Declaration
public String ThumbnailUrl { get; set; }
Property Value
String

Title

Defines the Title for the client-side page

Declaration
public String Title { get; set; }
Property Value
String

Methods

Equals(BaseClientSidePage)

Compares BaseClientSidePage object based on Sections, PromoteAsNewsArticle, Overwrite, Layout, Publish, EnableComments, Title, Properties, PromoteAsTemplate, and ThumbnailUrl

Declaration
public bool Equals(BaseClientSidePage other)
Parameters
BaseClientSidePage other

BaseClientSidePage Class object
Returns
System.Boolean

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

Equals(Object)

Compares object with BaseClientSidePage class

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

Object that represents BaseClientSidePage
Returns
System.Boolean

Checks whether object is BaseClientSidePage class

EqualsInherited(BaseClientSidePage)

Compares the members of any inherited type

Declaration
protected abstract bool EqualsInherited(BaseClientSidePage other)
Parameters
BaseClientSidePage other

Returns
System.Boolean

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

GetInheritedHashCode()

Returns the HashCode of the members of any inherited type

Declaration
protected abstract int GetInheritedHashCode()
Returns
System.Int32

Extension Methods