Search Results for

    Show / Hide Table of Contents

    Class CanvasSection

    Defines a CanvasSection

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

    Constructors

    CanvasSection()

    Constructor for CanvasSection class

    Declaration
    public CanvasSection()

    Properties

    BackgroundEmphasis

    The emphasis color of the Canvas Section for a Client-side Page

    Declaration
    public Emphasis BackgroundEmphasis { get; set; }
    Property Value
    Emphasis

    Collapsible

    Defines wheter the Canvas Section for a Client-side Page is collapsible or not.

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

    Controls

    Gets or sets the controls

    Declaration
    public CanvasControlCollection Controls { get; }
    Property Value
    CanvasControlCollection

    DisplayName

    Defines DisplayName of the collapsible Canvas Section for a Client-side Page.

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

    IconAlignment

    Defines the IconAlignment of collapsible Canvas Section for a Client-side Page.

    Declaration
    public IconAlignment IconAlignment { get; set; }
    Property Value
    IconAlignment

    IsExpanded

    Defines wheter a collapsible Canvas Section for a Client-side Page is expanded by default or not.

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

    Order

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

    Declaration
    public float Order { get; set; }
    Property Value
    System.Single

    ShowDividerLine

    Defines wheter to show a divider line for a collapsible Canvas Section of a Client-side Page.

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

    Type

    Defines the type of the Canvas section for a Client-side Page.

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

    VerticalSectionEmphasis

    The emphasis color of the Canvas Section for a Client-side Page

    Declaration
    public Emphasis VerticalSectionEmphasis { get; set; }
    Property Value
    Emphasis

    Methods

    Equals(CanvasSection)

    Compares CanvasSection object based on Controls, Order, Type, BackgroundEmphasis, and VerticalSectionEmphasis

    Declaration
    public bool Equals(CanvasSection other)
    Parameters
    CanvasSection other

    CanvasSection Class object

    Returns
    System.Boolean

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

    Equals(Object)

    Compares object with CanvasSection class

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

    Object that represents CanvasSection

    Returns
    System.Boolean

    Checks whether object is CanvasSection class

    GetHashCode()

    Gets the hash code

    Declaration
    public override int GetHashCode()
    Returns
    System.Int32

    Returns HashCode

    Extension Methods

    ValidationExtensions.ValidateNotNullOrEmpty<T>(T, String)
    ObjectExtensions.Set<TObject, T>(TObject, Expression<Func<TObject, T>>, T, Boolean, Boolean)
    ObjectExtensions.GetPublicInstancePropertyValue(Object, String)
    ObjectExtensions.GetPublicInstanceProperty(Object, String)
    ObjectExtensions.SetPublicInstancePropertyValue(Object, String, Object)
    Extensions.ToByteArray(Object)
    Back to top PnP Framework
    Generated by DocFX with Material UI
    spacer