Table of contents
TOC
Collapse the table of content
Expand the table of content

ClientSideWebPart Class

SharePoint Dev Documents|Last Updated: 10/6/2017
|
1 Contributor

This class is used to instantiate controls of type 3 (= client side web parts). Using this class you can instantiate a control and add it on a OfficeDevPnP.Core.Pages.ClientSidePage

Namespace:OfficeDevPnP.Core.Pages
Assembly: OfficeDevPnP.Core.dll

Inheritance Hierarchy

System.Object
OfficeDevPnP.Core.Pages.CanvasControl

Syntax

public class ClientSideWebPart: CanvasControl

Constructors

NameDescription
ClientSideWebPart()Instantiates client side web part from scratch.
ClientSideWebPart(ClientSideComponent)This class is used to instantiate controls of type 3 (= client side web parts). Using this class you can instantiate a control and add it on a OfficeDevPnP.Core.Pages.ClientSidePage

Properties

NameDescription
DescriptionDescription of the web part
HtmlPropertiesValue of the "data-sp-htmlproperties" attribute
HtmlPropertiesDataValue of the "data-sp-htmlproperties" element
JsonWebPartDataValue of the "data-sp-webpartdata" attribute
PropertiesWeb properties as configurable Newtonsoft.Json.Linq.JObject
PropertiesJsonJson serialized web part properties
SpControlDataValue of the "data-sp-controldata" attribute
TitleTitle of the web part
TypeReturn OfficeDevPnP.Core.Pages.ClientSideWebPart.Type of the client side web part
WebPartDataValue of the "data-sp-webpart" attribute
WebPartIdID of the client side web part

Methods

NameDescription
Import(ClientSideComponent, Func<String, String>)Imports a OfficeDevPnP.Core.Pages.ClientSideComponent to use it as base for configuring the client side web part instance
ToHtml(Single)Returns a HTML representation of the client side web part

See also

© 2018 Microsoft