Interface ICanvasControl

Base interface for a canvas control

Namespace: PnP.Core.Model.SharePoint

Assembly: PnP.Core.dll

Syntax

public interface ICanvasControl

Properties

CanvasControlData

Value of the control's "data-sp-canvascontrol" attribute

Declaration

string CanvasControlData { get; }

Property Value

System.String

CanvasDataVersion

The internal canvas storage version used

Declaration

string CanvasDataVersion { get; }

Property Value

System.String

Column

The ICanvasColumn hosting this control

Declaration

ICanvasColumn Column { get; }

Property Value

ICanvasColumn

ControlType

Type of the control: 4 is a text part, 3 is a client side web part

Declaration

int ControlType { get; }

Property Value

System.Int32

DataVersion

The internal storage version used for this control

Declaration

string DataVersion { get; set; }

Property Value

System.String

InstanceId

Instance ID of the control

Declaration

Guid InstanceId { get; set; }

Property Value

Guid

JsonControlData

Value of the control's "data-sp-controldata" attribute

Declaration

string JsonControlData { get; }

Property Value

System.String

Order

Order of the control in the control collection

Declaration

int Order { get; set; }

Property Value

System.Int32

Section

The ICanvasSection hosting this control

Declaration

ICanvasSection Section { get; }

Property Value

ICanvasSection

Type

Type if the control (IPageText or IPageWebPart)

Declaration

Type Type { get; }

Property Value

Type

Methods

Delete()

Removes the control from the page

Declaration

void Delete()

Move(ICanvasColumn)

Moves the control to another section and column

Declaration

void Move(ICanvasColumn newColumn)

Parameters

ICanvasColumn newColumn New column that will host the control

Move(ICanvasColumn, Int32)

Moves the control to another section and column

Declaration

void Move(ICanvasColumn newColumn, int order)

Parameters

ICanvasColumn newColumn New column that will host the control

System.Int32 order New order for the control in the new column

Move(ICanvasSection)

Moves the control to another section and column

Declaration

void Move(ICanvasSection newSection)

Parameters

ICanvasSection newSection New section that will host the control

Move(ICanvasSection, Int32)

Moves the control to another section and column

Declaration

void Move(ICanvasSection newSection, int order)

Parameters

ICanvasSection newSection New section that will host the control

System.Int32 order New order for the control in the new section

MovePosition(ICanvasColumn)

Moves the control to another section and column while keeping it's current position

Declaration

void MovePosition(ICanvasColumn newColumn)

Parameters

ICanvasColumn newColumn New column that will host the control

MovePosition(ICanvasColumn, Int32)

Moves the control to another section and column in the given position

Declaration

void MovePosition(ICanvasColumn newColumn, int position)

Parameters

ICanvasColumn newColumn New column that will host the control

System.Int32 position New position for the control in the new column

MovePosition(ICanvasSection)

Moves the control to another section and column while keeping it's current position

Declaration

void MovePosition(ICanvasSection newSection)

Parameters

ICanvasSection newSection New section that will host the control

MovePosition(ICanvasSection, Int32)

Moves the control to another section and column in the given position

Declaration

void MovePosition(ICanvasSection newSection, int position)

Parameters

ICanvasSection newSection New section that will host the control

System.Int32 position New position for the control in the new section

MovePosition(Int32)

Moves the control inside the current column to a new position

Declaration

void MovePosition(int position)

Parameters

System.Int32 position New position for this control