Interface IFooterOptions

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Options to configure a the site footer chrome.

public interface IFooterOptions

Properties

DisplayName

The footer display name

string DisplayName { get; set; }

Property Value

string

Emphasis

Gets or sets the value of the footer emphasis.

FooterVariantThemeType Emphasis { get; set; }

Property Value

FooterVariantThemeType

Enabled

Gets or sets a value that specifies whether the footer is enabled on the site.

bool Enabled { get; set; }

Property Value

bool

Layout

Gets or sets the value of the footer layout.

FooterLayoutType Layout { get; set; }

Property Value

FooterLayoutType

Methods

ClearLogo()

Clears the footer logo

void ClearLogo()

ClearLogoAsync()

Clears the footer logo

Task ClearLogoAsync()

Returns

Task

SetLogo(string, Stream, bool)

Sets the footer's logo to the provided image.

void SetLogo(string fileName, Stream content, bool overwrite = false)

Parameters

fileName string

Name of your image file

content Stream

The contents of the file

overwrite bool

Indicates whether the file should be overwritten if already existing.

SetLogoAsync(string, Stream, bool)

Sets the footer's logo to the provided image.

Task SetLogoAsync(string fileName, Stream content, bool overwrite = false)

Parameters

fileName string

Name of your image file

content Stream

The contents of the file

overwrite bool

Indicates whether the file should be overwritten if already existing.

Returns

Task