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.
Assembly: PnP.Core.dll
Syntax
public interface IPageWebPart : ICanvasControl
Properties
Description of the web part
Declaration
string Description { get; set; }
Property Value
DynamicDataPaths json node
Declaration
JsonElement DynamicDataPaths { get; }
Property Value
DynamicDataValues json node
Declaration
JsonElement DynamicDataValues { get; }
Property Value
Value of the "data-sp-htmlproperties" attribute
Declaration
string HtmlProperties { get; }
Property Value
Value of the "data-sp-htmlproperties" element
Declaration
string HtmlPropertiesData { get; }
Property Value
Value of the "data-sp-webpartdata" attribute
Declaration
string JsonWebPartData { get; }
Property Value
Web properties as configurable
Declaration
JsonElement Properties { get; }
Property Value
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
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
ServerProcessedContent json node
Declaration
JsonElement ServerProcessedContent { get; }
Property Value
Supports full bleed display experience
Declaration
bool SupportsFullBleed { get; }
Property Value
Declaration
string Title { get; set; }
Property Value
Return Type of the client side web part
Declaration
Property Value
Value of the "data-sp-webpart" attribute
Declaration
string WebPartData { get; }
Property Value
ID of the client side web part
Declaration
string WebPartId { get; }
Property Value
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