Class GenericLayout
Class containing Generic Layout functionality that is exposed in the scripting Toolbox
Namespace: Scripting
Syntax
public class GenericLayoutMethods
CreateNewSiteLayoutFromEmpty(GenericLayoutSettings, TransformerSpecification, String)
Creates a totally new site layout (from empty) using the generic layout settings provided.
Declaration
public bool CreateNewSiteLayoutFromEmpty(GenericLayoutSettings genericLayoutSettings, TransformerSpecification optionalTransformerSpecificationToAdd, string newSiteLayoutName = null)Parameters
| Type | Name | Description |
|---|---|---|
| GenericLayoutSettings | genericLayoutSettings | The generic layout settings to use to construct the new site layout. |
| TransformerSpecification | optionalTransformerSpecificationToAdd | If set, it will add a transformer instances of this transformer specification. |
| System.String | newSiteLayoutName | The name of the new site layout (if null, will use a default). |
Returns
| Type | Description |
|---|---|
| System.Boolean |
|
CreateNewSiteLayoutFromExisting(SiteLayout, GenericLayoutSettings, String)
Creates a new site layout from an existing site layout.
Declaration
public bool CreateNewSiteLayoutFromExisting(SiteLayout existingSiteLayout, GenericLayoutSettings genericLayoutSettings, string newSiteLayoutName = null)Parameters
| Type | Name | Description |
|---|---|---|
| SiteLayout | existingSiteLayout | The existing site layout to use as a template. |
| GenericLayoutSettings | genericLayoutSettings | The generic layout settings to use to construct the new site layout. |
| System.String | newSiteLayoutName | The name of the new site layout (if null, will use a default). |
Returns
| Type | Description |
|---|---|
| System.Boolean |
|
UpdateSiteLayout(SiteLayout, GenericLayoutSettings)
Updates the specified site layout with the given generic layout
Declaration
public bool UpdateSiteLayout(SiteLayout siteLayoutToUpdate, GenericLayoutSettings genericLayoutSettings)Parameters
| Type | Name | Description |
|---|---|---|
| SiteLayout | siteLayoutToUpdate | The site layout to update. |
| GenericLayoutSettings | genericLayoutSettings | The generic layout settings to use. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
|