Class PageImageOptions

Defines the options to configure an image

Inheritance

object

PageImageOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: PnP.Core.Model.SharePoint

Assembly: PnP.Core.dll

Syntax

public class PageImageOptions

Properties

Alignment

Defines the alignment of the image

Declaration

public PageImageAlignment Alignment { get; set; }

Property Value

PageImageAlignment

AlternativeText

Alternative text of the image

Declaration

public string AlternativeText { get; set; }

Property Value

string

Caption

Image caption to show underneath the embedded image

Declaration

public string Caption { get; set; }

Property Value

string

Height

Defines the actual height of the image

Declaration

public int? Height { get; set; }

Property Value

int?

Link

Link the image should point to on click

Declaration

public string Link { get; set; }

Property Value

string

Width

Defines the actual width of the image

Declaration

public int? Width { get; set; }

Property Value

int?

WidthPercentage

Defines the width of the image relative to editor control it's placed in. The Width, Height and this property need to be all set to end up to get a functional inline image. When using PnP.Core.Model.SharePoint.Page.EditorType equal to CK4 then the WidthPercentage property is not used.

Declaration

public int? WidthPercentage { get; set; }

Property Value

int?