Class SiteFooter

Defines the Footer settings for the target site

Inheritance

System.Object

BaseModel

SiteFooter

Inherited Members

BaseModel.ParentTemplate

Namespace: PnP.Framework.Provisioning.Model

Assembly: PnP.Framework.dll

Syntax

public class SiteFooter : BaseModel, IProvisioningTemplateDescendant

Constructors

SiteFooter()

Constructor for SiteFooter

Declaration

public SiteFooter()

Properties

BackgroundEmphasis

Defines the Background Emphasis of the Header

Declaration

public Emphasis BackgroundEmphasis { get; set; }

Property Value

Emphasis

DisplayName

Defines the Display Name for the footer, optional attribute

Declaration

public string DisplayName { get; set; }

Property Value

System.String

Enabled

Defines whether the site Footer is enabled or not

Declaration

public Boolean Enabled { get; set; }

Property Value

Boolean

FooterLinks

Defines the Footer Links for the target site

Declaration

public SiteFooterLinkCollection FooterLinks { get; }

Property Value

SiteFooterLinkCollection

Layout

Defines the Layout of the Footer

Declaration

public SiteFooterLayout Layout { get; set; }

Property Value

SiteFooterLayout

Logo

Defines the Logo to render in the Footer

Declaration

public String Logo { get; set; }

Property Value

String

Name

Defines the name of the footer. Only visible if "NameVisiblity" has been set to true.

Declaration

public string Name { get; set; }

Property Value

System.String

RemoveExistingNodes

Defines whether the existing site Footer links should be removed

Declaration

public Boolean RemoveExistingNodes { get; set; }

Property Value

Boolean

Methods

Equals(SiteFooter)

Compares SiteFooter object based on Logo, Name, RemoveExistingNodes, FooterLinks, Layout, and DisplayName

Declaration

public bool Equals(SiteFooter other)

Parameters

SiteFooter other SiteFooter Class object

Returns

System.Boolean true if the SiteFooter object is equal to the current object; otherwise, false.

Equals(Object)

Compares object with SiteFooter class

Declaration

public override bool Equals(object obj)

Parameters

System.Object obj Object that represents SiteFooter

Returns

System.Boolean Checks whether object is SiteFooter class

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

System.Int32 Returns HashCode

Extension Methods

ValidationExtensions.ValidateNotNullOrEmpty<T>(T, String)

ObjectExtensions.Set<TObject, T>(TObject, Expression<Func<TObject, T>>, T, Boolean, Boolean)

ObjectExtensions.GetPublicInstancePropertyValue(Object, String)

ObjectExtensions.GetPublicInstanceProperty(Object, String)

ObjectExtensions.SetPublicInstancePropertyValue(Object, String, Object)

Extensions.ToByteArray(Object)