Interface IFooterOptions

Options to configure a the site footer chrome.

Namespace: PnP.Core.Model.SharePoint
Assembly: PnP.Core.dll
Syntax
public interface IFooterOptions

Properties

DisplayName

The footer display name

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

Emphasis

Gets or sets the value of the footer emphasis.

Declaration
FooterVariantThemeType Emphasis { get; set; }
Property Value
FooterVariantThemeType

Enabled

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

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

Layout

Gets or sets the value of the footer layout.

Declaration
FooterLayoutType Layout { get; set; }
Property Value
FooterLayoutType

Methods

ClearLogoAsync()

Clears the footer logo

Declaration
Task ClearLogoAsync()
Returns
Task

SetLogo(String, Stream, Boolean)

Sets the footer's logo to the provided image.

Declaration
void SetLogo(string fileName, Stream content, bool overwrite = false)
Parameters
System.String fileName

Name of your image file
Stream content

The contents of the file
System.Boolean overwrite

Indicates whether the file should be overwritten if already existing.

SetLogoAsync(String, Stream, Boolean)

Sets the footer's logo to the provided image.

Declaration
Task SetLogoAsync(string fileName, Stream content, bool overwrite = false)
Parameters
System.String fileName

Name of your image file
Stream content

The contents of the file
System.Boolean overwrite

Indicates whether the file should be overwritten if already existing.
Returns
Task