Class WebPartEntity

Entity to describe a web part on a wiki or webpart page

Inheritance
System.Object
WebPartEntity
Namespace: PnP.Framework.Modernization.Entities
Assembly: PnP.Framework.dll
Syntax
public class WebPartEntity : object

Constructors

WebPartEntity()

Default constructor

Declaration
public WebPartEntity()

Properties

Column

Web part position: column

Declaration
public int Column { get; set; }
Property Value
System.Int32

Hidden

Is this a visible web part or not

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

Id

Web part id

Declaration
public Guid Id { get; set; }
Property Value
Guid

IsClosed

Is this web part closed or not

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

Order

Web part position: order

Declaration
public int Order { get; set; }
Property Value
System.Int32

Properties

Dictionary with web part properties

Declaration
public Dictionary<string, string> Properties { get; set; }
Property Value
Dictionary<System.String, System.String>

Row

Web part position: row

Declaration
public int Row { get; set; }
Property Value
System.Int32

ServerControlId

Web part server control id

Declaration
public string ServerControlId { get; set; }
Property Value
System.String

Title

Title of the web part

Declaration
public string Title { get; set; }
Property Value
System.String

Type

Web part type

Declaration
public string Type { get; set; }
Property Value
System.String

ZoneId

Web part zone id

Declaration
public string ZoneId { get; set; }
Property Value
System.String

ZoneIndex

Web part position: zone index

Declaration
public uint ZoneIndex { get; set; }
Property Value
System.UInt32

Methods

Json()

Returns this instance as Json

Declaration
public string Json()
Returns
System.String

Json serialized string of this web part instance

TypeShort()

Returns the shortened web part type name

Declaration
public string TypeShort()
Returns
System.String

Shortened web part type name

Extension Methods