Interface IHeaderOptions

Options to configure a the site header chrome

Namespace: PnP.Core.Model.SharePoint

Assembly: PnP.Core.dll

Syntax

public interface IHeaderOptions

Properties

Emphasis

Gets or sets the value of the header emphasis.

Declaration

VariantThemeType Emphasis { get; set; }

Property Value

VariantThemeType

HideTitle

Gets or sets a value that specifies whether the title in header is hidden on the site.

Declaration

bool HideTitle { get; set; }

Property Value

System.Boolean

Layout

Gets or sets the value of the header layout.

Declaration

HeaderLayoutType Layout { get; set; }

Property Value

HeaderLayoutType

LogoAlignment

Gets or sets the logo alignment of the site.

Declaration

LogoAlignment LogoAlignment { get; set; }

Property Value

LogoAlignment

Methods

ClearHeaderBackgroundImage()

Clears the header background image

Declaration

void ClearHeaderBackgroundImage()

ClearHeaderBackgroundImageAsync()

Clears the header background image

Declaration

Task ClearHeaderBackgroundImageAsync()

Returns

Task

ResetSiteLogo()

Sets the out of the box site's logo again. For group connected sites calling this method is equal to calling ResetSiteLogoThumbnail as logo and logo thumbnail are both set the same.

Declaration

void ResetSiteLogo()

ResetSiteLogoAsync()

Sets the out of the box site's logo again. For group connected sites calling this method is equal to calling ResetSiteLogoThumbnail as logo and logo thumbnail are both set the same.

Declaration

Task ResetSiteLogoAsync()

Returns

Task

ResetSiteLogoThumbnail()

Sets the out of the box site's logo thumbnail again. For group connected sites we'll default to using siteassets/siteIcon.jpg if that still exists.

Declaration

void ResetSiteLogoThumbnail()

ResetSiteLogoThumbnailAsync()

Sets the out of the box site's logo thumbnail again. For group connected sites we'll default to using siteassets/siteIcon.jpg if that still exists.

Declaration

Task ResetSiteLogoThumbnailAsync()

Returns

Task

SetHeaderBackgroundImage(String, Stream, Double, Double, Boolean)

Sets the site's header background image. Only can be called when the header layout is set to extended.

Declaration

void SetHeaderBackgroundImage(string fileName, Stream content, double focalX = null, double focalY = null, bool overwrite = false)

Parameters

System.String fileName Name of your image file

Stream content The contents of the file

System.Double focalX X axis focal point for the header image

System.Double focalY Y axis focal point for the header image

System.Boolean overwrite Indicates whether the file should be overwritten if already existing.

SetHeaderBackgroundImageAsync(String, Stream, Double, Double, Boolean)

Sets the site's header background image. Only can be called when the header layout is set to extended.

Declaration

Task SetHeaderBackgroundImageAsync(string fileName, Stream content, double focalX = null, double focalY = null, bool overwrite = false)

Parameters

System.String fileName Name of your image file

Stream content The contents of the file

System.Double focalX X axis focal point for the header image

System.Double focalY Y axis focal point for the header image

System.Boolean overwrite Indicates whether the file should be overwritten if already existing.

Returns

Task

SetSiteLogo(String, Stream, Boolean)

Sets the site's logo to the provided image. For group connected sites calling this method is equal to calling SetSiteLogoThumbnail as logo and logo thumbnail are both set the same.

Declaration

void SetSiteLogo(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.

SetSiteLogoAsync(String, Stream, Boolean)

Sets the site's logo to the provided image. For group connected sites calling this method is equal to calling SetSiteLogoThumbnail as logo and logo thumbnail are both set the same.

Declaration

Task SetSiteLogoAsync(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

SetSiteLogoThumbnail(String, Stream, Boolean)

Sets the site's logo thumbnail to the provided image. For group connected sites setting the logo thumbnail will also automatically update the site logo.

Declaration

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

Parameters

System.String fileName Name of your image file

Stream content The contents of the file. Image should in a square aspect ratio

System.Boolean overwrite Indicates whether the file should be overwritten if already existing.

SetSiteLogoThumbnailAsync(String, Stream, Boolean)

Sets the site's logo thumbnail to the provided image.

Declaration

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

Parameters

System.String fileName Name of your image file

Stream content The contents of the file. Image should in a square aspect ratio

System.Boolean overwrite Indicates whether the file should be overwritten if already existing.

Returns

Task