Class SiteHeader

Defines the Header settings for the target site

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

Properties

BackgroundEmphasis

Defines the Background Emphasis of the Header

Declaration
public Emphasis BackgroundEmphasis { get; set; }
Property Value
Emphasis

Layout

Defines the Layout of the Header

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

MenuStyle

Defines the Menu Style

Declaration
public SiteHeaderMenuStyle MenuStyle { get; set; }
Property Value
SiteHeaderMenuStyle

ShowSiteNavigation

Defines whether the site navigation is visible or not, optional attribute

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

ShowSiteTitle

Defines whether the site title is visible or not, optional attribute

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

Methods

Equals(SiteHeader)

Compares SiteHeader object based on Layout, MenuStyle, BackgroundEmphasis, ShowSiteTitle, and ShowSiteNavigation

Declaration
public bool Equals(SiteHeader other)
Parameters
SiteHeader other

SiteHeader Class object
Returns
System.Boolean

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

Equals(Object)

Compares object with SiteHeader class

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

Object that represents SiteHeader
Returns
System.Boolean

Checks whether object is SiteHeader class

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

Extension Methods