Search Results for

    Show / Hide Table of Contents

    Interface ICanvasColumn

    A column in a ICanvasSection

    Namespace: PnP.Core.Model.SharePoint
    Assembly: PnP.Core.dll
    Syntax
    public interface ICanvasColumn

    Properties

    ColumnFactor

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

    Declaration
    int ColumnFactor { get; }
    Property Value
    System.Int32

    Controls

    List of ICanvasControl instances that are hosted in this section

    Declaration
    List<ICanvasControl> Controls { get; }
    Property Value
    PnP.Core.Model.SharePoint.List<ICanvasControl>

    IsLayoutReflowOnTop

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

    Declaration
    bool? IsLayoutReflowOnTop { get; }
    Property Value
    System.Nullable<System.Boolean>

    IsVerticalSectionColumn

    Is this a vertical section column?

    Declaration
    bool IsVerticalSectionColumn { get; }
    Property Value
    System.Boolean

    LayoutIndex

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

    Declaration
    int LayoutIndex { get; }
    Property Value
    System.Int32

    Order

    Column order

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

    Section

    ICanvasSection this section belongs to

    Declaration
    ICanvasSection Section { get; }
    Property Value
    ICanvasSection

    VerticalSectionEmphasis

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

    Declaration
    int? VerticalSectionEmphasis { get; }
    Property Value
    System.Nullable<System.Int32>

    ZoneId

    The Zone Identifier

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

    ZoneReflowStrategy

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

    Declaration
    ZoneReflowStrategy? ZoneReflowStrategy { get; set; }
    Property Value
    System.Nullable<ZoneReflowStrategy>

    Methods

    ResetColumn(Int32, Int32)

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

    Declaration
    void ResetColumn(int order, int columnFactor)
    Parameters
    System.Int32 order

    Column order to set

    System.Int32 columnFactor

    Column factor to set

    SetIsLayoutReflowOnTop(Boolean)

    Sets if vertical section should reflow on top

    Declaration
    void SetIsLayoutReflowOnTop(bool isLayoutReflowOnTop)
    Parameters
    System.Boolean isLayoutReflowOnTop

    SetZoneId(String)

    Sets the zone id

    Declaration
    void SetZoneId(string zoneId)
    Parameters
    System.String zoneId

    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer