Interface ICanvasColumn

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

A column in a ICanvasSection

public interface ICanvasColumn

Properties

ColumnFactor

Column size factor. Max value is 12 (= one column), other options are 8,6,4 or 0

int ColumnFactor { get; }

Property Value

int

Controls

List of ICanvasControl instances that are hosted in this section

List<ICanvasControl> Controls { get; }

Property Value

List<ICanvasControl>

IsLayoutReflowOnTop

The position of the Vertical section for smaller screens. Applied only for Vertical section

bool? IsLayoutReflowOnTop { get; }

Property Value

bool?

IsVerticalSectionColumn

Is this a vertical section column?

bool IsVerticalSectionColumn { get; }

Property Value

bool

LayoutIndex

Returns the layout index. Defaults to 1, except for the vertical section column this is 2

int LayoutIndex { get; }

Property Value

int

Order

Column order

int Order { get; }

Property Value

int

Section

ICanvasSection this section belongs to

ICanvasSection Section { get; }

Property Value

ICanvasSection

VerticalSectionEmphasis

Color emphasis of the column (used for the vertical section column)

int? VerticalSectionEmphasis { get; }

Property Value

int?

ZoneId

The Zone Identifier

string ZoneId { get; }

Property Value

string

ZoneReflowStrategy

Gets or sets the strategy used to reflow zones within a layout.

ZoneReflowStrategy? ZoneReflowStrategy { get; set; }

Property Value

ZoneReflowStrategy?

Methods

ResetColumn(int, int)

Resets the column, used in scenarios where a section is changed from type (e.g. from 3 column to 2 column)

void ResetColumn(int order, int columnFactor)

Parameters

order int

Column order to set

columnFactor int

Column factor to set

SetIsLayoutReflowOnTop(bool)

Sets if vertical section should reflow on top

void SetIsLayoutReflowOnTop(bool isLayoutReflowOnTop)

Parameters

isLayoutReflowOnTop bool

SetZoneId(string)

Sets the zone id

void SetZoneId(string zoneId)

Parameters

zoneId string