Class ClientSidePageHeader

Represents the Header of a Client Side page

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

Properties

AlternativeText

Defines the alternative text for the header image of the current client side page

Declaration
public String AlternativeText { get; set; }
Property Value
String

AuthorByLine

Defines the page author by line of the current client side page

Declaration
public String AuthorByLine { get; set; }
Property Value
String

AuthorByLineId

Defines the ID of the page author by line of the current client side page

Declaration
public Int32 AuthorByLineId { get; set; }
Property Value
Int32

Authors

Defines the page author(s) to be displayed of the current client side page

Declaration
public String Authors { get; set; }
Property Value
String

LayoutType

Defines the type of layout used inside the header of the current client side page

Declaration
public ClientSidePageHeaderLayoutType LayoutType { get; set; }
Property Value
ClientSidePageHeaderLayoutType

ServerRelativeImageUrl

Defines the server-relative URL of the image for the header of the current client side page

Declaration
public String ServerRelativeImageUrl { get; set; }
Property Value
String

ShowBackgroundGradient

Defines whether to show the page background with gradient on the current client side page.

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

ShowPublishDate

Defines whether to show the page publication date in the title region of the current client side page

Declaration
public Boolean ShowPublishDate { get; set; }
Property Value
Boolean

ShowTopicHeader

Defines whether to show the topic header in the title region of the current client side page

Declaration
public Boolean ShowTopicHeader { get; set; }
Property Value
Boolean

TextAlignment

Defines the text alignment of the text in the header of the current client side page

Declaration
public ClientSidePageHeaderTextAlignment TextAlignment { get; set; }
Property Value
ClientSidePageHeaderTextAlignment

TopicHeader

Defines the topic header text to show if ShowTopicHeader is set to true of the current client side page

Declaration
public String TopicHeader { get; set; }
Property Value
String

TranslateX

Defines the x-translate of the image for the header of the current client side page.

Declaration
public Double? TranslateX { get; set; }
Property Value
System.Nullable<Double>

TranslateY

Defines the y-translate of the image for the header of the current client side page.

Declaration
public Double? TranslateY { get; set; }
Property Value
System.Nullable<Double>

Type

Defines the type of the header for the client side page

Declaration
public ClientSidePageHeaderType Type { get; set; }
Property Value
ClientSidePageHeaderType

Methods

Equals(ClientSidePageHeader)

Compares ClientSidePageHeader object based on Type, ServerRelativeImageUrl, TranslateX, TranslateY, Layout, TextAlignment, TopicHeader, AlternativeText, Authors, AuthorByLine, and AuthorByLineId

Declaration
public bool Equals(ClientSidePageHeader other)
Parameters
ClientSidePageHeader other

ClientSidePageHeader Class object
Returns
System.Boolean

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

Equals(Object)

Compares object with ClientSidePageHeader class

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

Object that represents ClientSidePageHeader
Returns
System.Boolean

Checks whether object is ClientSidePageHeader class

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

Extension Methods