Class Layout

Namespace

Dynamicweb.Rendering.Designer

Assembly

Dynamicweb.Core.dll

Represent a layout from a design

public class Layout

Inheritance

object

Layout

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Instances can only be accessed through Design.Layouts

Properties

Containers

Gets a collection of the content containers present in this layout template

public DynamicElementCollection Containers { get; }

Property Value

DynamicElementCollection

CssFiles

Gets the CSS file locations for this layout.

public List<string> CssFiles { get; }

Property Value

List<string>

The CSS files.

DefaultContainer

Gets the default content container present in the layout template - it is the first present in the template

public DynamicElement? DefaultContainer { get; }

Property Value

DynamicElement

DefaultParagraphTemplate

Gets the default paragraph template of this layout.

public string DefaultParagraphTemplate { get; }

Property Value

string

The default paragraph template.

Description

Gets the description of the layout - take from the meta description tag of the layout file, otherwise empty

public string Description { get; }

Property Value

string

Design

Gets the design that this instance of a layout belongs to

public Design Design { get; }

Property Value

Design

EditorCss

Gets the editor CSS used in backend for the RTE - called ~/Editor.css.

public string? EditorCss { get; }

Property Value

string

The editor CSS.

File

Gets an instance of TemplateFile object

public TemplateFile File { get; }

Property Value

TemplateFile

Name

Gets the name of layout - taken from the layout file title tag if it exists, otherwise name of the template file.

public string Name { get; }

Property Value

string

Navigations

Gets a collection of navigations present in this layout template

public DynamicElementCollection Navigations { get; }

Property Value

DynamicElementCollection

ParagraphTemplates

Gets a collection of paragraph templates for the current layout.

public TemplateFileCollection ParagraphTemplates { get; }

Property Value

TemplateFileCollection

Remarks

Looks for templates in a subfolder with the same name as the layout template file (Templates/Designs/Design1/Layout1/Paragraph). If nothing is found, it looks in the current designs folder (Templates/Designs/Design1/Paragraph), then the designs folder (Templates/Designs/Paragraph) and then falls back to the default paragraph template folder (Templates/Paragraph)

ParsedFolder

Gets the full location of the parsed layout folder, i.e. C:\Folder\Files\Templates\Design\Design1_parsed\

public string ParsedFolder { get; }

Property Value

string

ParsedFullLocation

Gets the full location of the parsed layout template, i.e. C:\Folder\Files\Templates\Design\Design1_parsed\Layout.parsed.html

public string ParsedFullLocation { get; }

Property Value

string

ParsedLocation

Gets the absolute location of the parsed layout template, i.e. /Files/Templates/Design/Design1/_parsed/Layout.parsed.html

public string ParsedLocation { get; }

Property Value

string

Reparsed

Gets a value indicating whether this Layout was reparsed.

public bool Reparsed { get; }

Property Value

bool

true if reparsed; otherwise, false.

RowContainers

public DynamicElementCollection RowContainers { get; }

Property Value

DynamicElementCollection

TemplateFileInfo

Gets a fileinfo object of the layout template

public FileInfo TemplateFileInfo { get; }

Property Value

FileInfo

Methods

GetGridSettingsPath(string)

Finds the grid file location based on the layout. Context aware, see remarks

public string GetGridSettingsPath(string gridFile)

Parameters

gridFile string

The name of the grid file without any path information, i.e MyGrid.json.

Returns

string

A full location path of the grid if found, otherwise

string.empty

Remarks

Looks for the file in these locations and return the first instance: Templates/Designs/Design1/Layout1/Grid, Templates/Designs/Design1/Grid, Templates/Designs/Grid

GetLayoutByLocation(string)

Returns a Layout object based on the relative path to a layout template

public static Layout? GetLayoutByLocation(string path)

Parameters

path string

The relative path to a template, i.e. Design1/Layout.html

Returns

Layout

GetLayoutByName(string, string)

Returns a Layout object based on the relative path to a layout template

public static Layout? GetLayoutByName(string areaLayoutPath, string layoutName)

Parameters

areaLayoutPath string

The relative path to the area template, i.e. Design1/Layout.html

layoutName string

The layout name, i.e. Produts.html

Returns

Layout

GetParagraphTemplate(string)

Returns the default paragraph template for a content placeholder

public string? GetParagraphTemplate(string containerName)

Parameters

containerName string

Name of the placeholder

Returns

string

A file reference to the paragraph template

GetParagraphTemplatePath(string)

public string? GetParagraphTemplatePath(string template)

Parameters

template string

Returns

string

GetParagraphTemplatePath(string?, string?)

public string? GetParagraphTemplatePath(string? template, string? itemType)

Parameters

template string

itemType string

Returns

string

GetParagraphTemplates(DynamicElement?)

Gets the paragraph templates for a specific container based on the 'limit' setting on the placeholder

public TemplateFileCollection GetParagraphTemplates(DynamicElement? container)

Parameters

container DynamicElement

The DynamicElement representing the container for which the templates has to be returned for.

Returns

TemplateFileCollection

The paragraph templates.

Layouts(Design)

Returns a collection of available layouts for a design

public static LayoutCollection Layouts(Design design)

Parameters

design Design

Returns

LayoutCollection

An empty LayoutCollection if no layouts are present