Class CanvasControl

Defines a CanvasControl

Inheritance
System.Object
BaseModel
CanvasControl
Inherited Members
Namespace: PnP.Framework.Provisioning.Model
Assembly: PnP.Framework.dll
Syntax
public class CanvasControl : BaseModel, IProvisioningTemplateDescendant

Properties

Column

Defines the column of the section in which the Canvas Control will be inserted. Optional, default 0.

Declaration
public Int32 Column { get; set; }
Property Value
Int32

ControlId

Defines the Instance Id for Canvas Control of a Client-side Page.

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

ControlProperties

Defines the custom properties for the client-side web part control.

Declaration
public Dictionary<String, String> ControlProperties { get; set; }
Property Value
Dictionary<String, String>

CustomWebPartName

Defines the Name of the client-side web part if the WebPartType attribute has a value of "Custom".

Declaration
public String CustomWebPartName { get; set; }
Property Value
String

JsonControlData

Defines the JSON Control Data for Canvas Control of a Client-side Page.

Declaration
public String JsonControlData { get; set; }
Property Value
String

Order

Defines the order of the Canvas Control for a Client-side Page.

Declaration
public Int32 Order { get; set; }
Property Value
Int32

Type

Defines the Type of Client-side Web Part.

Declaration
public WebPartType Type { get; set; }
Property Value
WebPartType

Methods

Equals(CanvasControl)

Compares CanvasControl object based on Controls, Order, and Type

Declaration
public bool Equals(CanvasControl other)
Parameters
CanvasControl other

CanvasControl Class object
Returns
System.Boolean

true if the CanvasControl object is equal to the current object; otherwise, false.

Equals(Object)

Compares object with CanvasControl class

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Object that represents CanvasControl
Returns
System.Boolean

Checks whether object is CanvasControl class

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

Extension Methods