Interface IPageWebPart

This class is used to instantiate modern web parts. Using this class you can instantiate a control and add it on a IPage.

Inherited Members

ICanvasControl.Section

ICanvasControl.Column

ICanvasControl.DataVersion

ICanvasControl.CanvasDataVersion

ICanvasControl.CanvasControlData

ICanvasControl.ControlType

ICanvasControl.JsonControlData

ICanvasControl.InstanceId

ICanvasControl.Order

ICanvasControl.Delete()

ICanvasControl.Move(ICanvasSection)

ICanvasControl.Move(ICanvasSection, Int32)

ICanvasControl.Move(ICanvasColumn)

ICanvasControl.Move(ICanvasColumn, Int32)

ICanvasControl.MovePosition(ICanvasSection)

ICanvasControl.MovePosition(ICanvasSection, Int32)

ICanvasControl.MovePosition(ICanvasColumn)

ICanvasControl.MovePosition(ICanvasColumn, Int32)

ICanvasControl.MovePosition(Int32)

Namespace: PnP.Core.Model.SharePoint

Assembly: PnP.Core.dll

Syntax

public interface IPageWebPart : ICanvasControl

Properties

Description

Description of the web part

Declaration

string Description { get; set; }

Property Value

System.String

DynamicDataPaths

DynamicDataPaths json node

Declaration

JsonElement DynamicDataPaths { get; }

Property Value

JsonElement

DynamicDataValues

DynamicDataValues json node

Declaration

JsonElement DynamicDataValues { get; }

Property Value

JsonElement

FlexibleLayoutPosition

Flexible layout position of the control

Declaration

ControlFlexLayoutPosition FlexibleLayoutPosition { get; set; }

Property Value

ControlFlexLayoutPosition

HtmlProperties

Value of the "data-sp-htmlproperties" attribute

Declaration

string HtmlProperties { get; }

Property Value

System.String

HtmlPropertiesData

Value of the "data-sp-htmlproperties" element

Declaration

string HtmlPropertiesData { get; }

Property Value

System.String

IsHeaderControl

This control lives in the page header (not removable control)

Declaration

bool IsHeaderControl { get; set; }

Property Value

System.Boolean

JsonWebPartData

Value of the "data-sp-webpartdata" attribute

Declaration

string JsonWebPartData { get; }

Property Value

System.String

Properties

Web properties as configurable

Declaration

JsonElement Properties { get; }

Property Value

JsonElement

PropertiesJson

Json serialized web part information. For 1st party web parts this ideally is the full JSON string fetch via workbench or via copying it from an existing page. It's important that the serverProcessedContent element is included here!

Declaration

string PropertiesJson { get; set; }

Property Value

System.String

RichTextEditorInstanceId

If this webpart is used inline in a text editor then this property points to the editor using it

Declaration

string RichTextEditorInstanceId { get; set; }

Property Value

System.String

ServerProcessedContent

ServerProcessedContent json node

Declaration

JsonElement ServerProcessedContent { get; }

Property Value

JsonElement

SupportsFullBleed

Supports full bleed display experience

Declaration

bool SupportsFullBleed { get; }

Property Value

System.Boolean

Title

Title of the web part

Declaration

string Title { get; set; }

Property Value

System.String

Type

Return Type of the client side web part

Declaration

Type Type { get; }

Property Value

Type

WebPartData

Value of the "data-sp-webpart" attribute

Declaration

string WebPartData { get; }

Property Value

System.String

WebPartId

ID of the client side web part

Declaration

string WebPartId { get; }

Property Value

System.String

WebPartPreviewImage

Preview image that can serve as page preview image when the page holding this web part is promoted to a news page

Declaration

string WebPartPreviewImage { get; }

Property Value

System.String

Methods

BuildControlData(Single)

Builds Control attributes based on current settings, also used by pnpframework

Declaration

void BuildControlData(float controlIndex)

Parameters

System.Single controlIndex