Class Area

Namespace

Dynamicweb.Content

Assembly

Dynamicweb.dll

The class Area represents a website or a language version of a given website

public class Area : Entity<int>, IChangeTracking, IPermissionObject, IDisplayName, IPermissionLookup, IPermissionControlled

Inheritance

object

Entity<int>

Area

Implements

IChangeTracking

IPermissionObject

IDisplayName

IPermissionLookup

IPermissionControlled

Inherited Members

Entity<int>.ID

Entity<int>.Audit

Entity<int>.State

Entity<int>.IsNew

Entity<int>.IsModified

Entity<int>.IsDeleted

Entity<int>.IsChanged

Entity<int>.Delete()

Entity<int>.SetProperty<T>(string, ref T, T)

Entity<int>.SetProperty<T>(string, ref T?, T?)

Entity<int>.SetEnum<TEnum>(string, ref TEnum, TEnum)

Entity<int>.BeginRestoring()

Entity<int>.EndRestoring()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Area()

Initializes a new instance of the Area class

public Area()

Properties

Active

Gets or sets a value indicating whether this Area is active.

public bool Active { get; set; }

Property Value

bool

true if active; otherwise, false.

ApprovalType

Gets or sets the type of the approval.

public int ApprovalType { get; set; }

Property Value

int

The type of the approval.

CdnHost

public string CdnHost { get; set; }

Property Value

string

CdnImageHost

public string CdnImageHost { get; set; }

Property Value

string

Codepage

Gets or sets the codepage.

[Obsolete("Do not use")]
public int Codepage { get; set; }

Property Value

int

The codepage.

CookieCustomNotifications

Gets or sets the whether the custom Cookie Notifications used.

public bool CookieCustomNotifications { get; set; }

Property Value

bool

CookieWarningTemplate

Gets or sets the Cookie Warning Template.

public string CookieWarningTemplate { get; set; }

Property Value

string

CopyOf

Gets or sets the id of the area for which this is a copy of

public int CopyOf { get; set; }

Property Value

int

a value indicating the area for which this is a copy of

Culture

Gets or sets the culture.

public string Culture { get; set; }

Property Value

string

The culture.

CultureInfo

Gets the culture info.

public CultureInfo CultureInfo { get; }

Property Value

CultureInfo

The culture info.

Dateformat

Gets or sets the dateformat.

[Obsolete("Use CultureInfo.DateTimeFormat instead.")]
public string Dateformat { get; set; }

Property Value

string

The dateformat.

Description

Gets or sets the description.

[Obsolete("The Description property is no longer used.")]
public string Description { get; set; }

Property Value

string

The description.

DisplayName

Gets the display name based on setting in management center.

public string DisplayName { get; }

Property Value

string

The display name

Domain

Gets or sets the domain.

public string Domain { get; set; }

Property Value

string

The domain.

DomainLock

Gets or sets the domain lock.

public string DomainLock { get; set; }

Property Value

string

The domain lock.

EcomCountryCode

Gets or sets the ecom country code.

public string EcomCountryCode { get; set; }

Property Value

string

The ecom currency code.

EcomCurrencyId

Gets or sets the ecom currency ID.

public string EcomCurrencyId { get; set; }

Property Value

string

The ecom currency ID.

EcomLanguageId

Gets or sets the ecom language ID.

public string EcomLanguageId { get; set; }

Property Value

string

The ecom language ID.

EcomPricesWithVat

Gets or sets a string ("True" or "False") indicating whether this website displays prices with VAT or not. If string is null or empty, default settings are used.

public string EcomPricesWithVat { get; set; }

Property Value

string

The value indicating whether prices are displayed with VAT or not.

EcomShopId

Gets or sets the ecom shop ID.

public string EcomShopId { get; set; }

Property Value

string

The ecom shop ID.

Encoding

Gets or sets the encoding.

[Obsolete("Do not use")]
public string Encoding { get; set; }

Property Value

string

The encoding.

Flag16X16

Gets the flag16x16.

[Obsolete("Do not use")]
public string Flag16X16 { get; }

Property Value

string

The flag16x16.

Flag32X32

Gets the flag32x32.

[Obsolete("Do not use")]
public string Flag32X32 { get; }

Property Value

string

The flag32x32.

Frontpage

Gets or sets the frontpage.

[Obsolete("Do not use")]
public string Frontpage { get; set; }

Property Value

string

The frontpage.

HtmlType

Gets or sets the type of the HTML.

public string HtmlType { get; set; }

Property Value

string

The type of the HTML.

IncludeProductsInSitemap

Gets or sets a value indicating whether [products included in sitemap].

public bool IncludeProductsInSitemap { get; set; }

Property Value

bool

true if [products include sitemap]; otherwise, false.

IsCdnActive

public bool? IsCdnActive { get; set; }

Property Value

bool?

IsLanguage

Gets a value indicating whether this instance is language.

public bool IsLanguage { get; }

Property Value

bool

true if this instance is language; otherwise, false.

IsMaster

Gets a value indicating whether this instance is master.

public bool IsMaster { get; }

Property Value

bool

true if this instance is master; otherwise, false.

Item

Gets the associated item.

public Item Item { get; }

Property Value

Item

ItemId

Gets or sets the Id of the associated content item.

public string ItemId { get; set; }

Property Value

string

ItemType

Gets or sets the type of the associated item.

public string ItemType { get; set; }

Property Value

string

ItemTypeLayouts

Gets the item layouts for area.

public XmlWebsiteItemTypeLayouts ItemTypeLayouts { get; }

Property Value

XmlWebsiteItemTypeLayouts

An instance of XmlWebsiteItemTypeLayouts with information about layouts selected for page and paragraph items.

ItemTypePageProperty

Gets or sets the type of the associated item for page property.

public string ItemTypePageProperty { get; set; }

Property Value

string

Keywords

Gets or sets the keywords.

[Obsolete("The Keywords property is no longer used.")]
public string Keywords { get; set; }

Property Value

string

The keywords.

LanguageDepth

Gets the language depth.

public int LanguageDepth { get; }

Property Value

int

The language depth.

Languages

public IList<Area> Languages { get; }

Property Value

IList<Area>

Layout

Gets the layout.

public Layout Layout { get; }

Property Value

Layout

The layout.

LayoutPhoneTemplate

Gets or sets the layout phone template.

public string LayoutPhoneTemplate { get; set; }

Property Value

string

The layout template.

LayoutTabletTemplate

Gets or sets the layout tablet template.

public string LayoutTabletTemplate { get; set; }

Property Value

string

The layout template.

LayoutTemplate

Gets or sets the layout template.

public string LayoutTemplate { get; set; }

Property Value

string

The layout template.

LockPagesToDomain

Gets or sets value indicating whether to lock pages of this area to the given domains.

public bool LockPagesToDomain { get; set; }

Property Value

bool

MasterArea

public Area MasterArea { get; }

Property Value

Area

MasterAreaId

Gets or sets the master area ID.

public int MasterAreaId { get; set; }

Property Value

int

The master area ID.

MasterTemplate

Gets or sets the master template.

[Obsolete("Do not use")]
public string MasterTemplate { get; set; }

Property Value

string

The master template.

Name

Gets or sets the name of the website

public string Name { get; set; }

Property Value

string

The name.

Nofollow

public bool Nofollow { get; set; }

Property Value

bool

Noindex

public bool Noindex { get; set; }

Property Value

bool

NotFound

Gets or sets the not found.

public string NotFound { get; set; }

Property Value

string

The not found.

PageCount

Gets or sets the number of pages that makes up this website

public int PageCount { get; set; }

Property Value

int

The page count.

Permission

Gets or sets the permission.

public string Permission { get; set; }

Property Value

string

The permission.

PermissionTemplate

Gets or sets the permission template.

public string PermissionTemplate { get; set; }

Property Value

string

The permission template.

Published

Gets or sets a value indicating whether this Area is published.

public bool Published { get; set; }

Property Value

bool

true if published; otherwise, false.

RedirectFirstPage

Gets or sets a value indicating whether the first page should be redirected to '/'.

public bool RedirectFirstPage { get; set; }

Property Value

bool

true if redirect first page; otherwise, false.

ReverseChargeForVat

public bool ReverseChargeForVat { get; set; }

Property Value

bool

RobotsTxt

Gets or sets the robots TXT.

public string RobotsTxt { get; set; }

Property Value

string

The robots TXT.

RobotsTxtIncludeSitemap

Gets or sets a value indicating whether [robots TXT included in sitemap].

public bool RobotsTxtIncludeSitemap { get; set; }

Property Value

bool

true if [robots TXT include sitemap]; otherwise, false.

Sort

Gets or sets the sort.

public int Sort { get; set; }

Property Value

int

The sort.

SslMode

Gets or sets a value indicating SSLMode

public int SslMode { get; set; }

Property Value

int

1 Standard, 2 Force SSL, 3 Un-force SSL

StockLocationID

public long StockLocationID { get; set; }

Property Value

long

StyleId

Gets or sets the style ID.

[Obsolete("Do not use")]
public int StyleId { get; set; }

Property Value

int

The style ID.

Title

Gets or sets the title.

[Obsolete("The Title property is no longer used.")]
public string Title { get; set; }

Property Value

string

The title.

UniqueId

public Guid UniqueId { get; set; }

Property Value

Guid

UrlIgnoreForChildren

Gets or sets a value indicating whether the name or ISO code in URL should be ignored for children (Pages).

public bool UrlIgnoreForChildren { get; set; }

Property Value

bool

true if name should be ignored; otherwise, false.

Remarks

Only have an impact if URLs is of type path, and the name or ISO code is included in the URLs.

UrlName

Gets or sets the name in the URL.

public string UrlName { get; set; }

Property Value

string

The name in the URL.

UserManagementPermissions

Gets or sets the user management permissions.

public PagePermissions UserManagementPermissions { get; set; }

Property Value

PagePermissions

The user management permissions.

UserPermissions

Gets the user permissions.

[Obsolete("Please use ContentPermissionService instead")]
public string UserPermissions { get; }

Property Value

string

The user permissions.

Methods

Copy()

Creates a copy of this area and returns it as a transient instance (Not persisted)

public Area Copy()

Returns

Area

A new Area instance with state copied from this Area instance

DeletePagePropertyItems()

Deletes all property items on all pages having a association with a property item on this area

public void DeletePagePropertyItems()

GetByKey(string)

Can be used to look up a concrete object based upon the key.

public IPermissionControlled GetByKey(string key)

Parameters

key string

Identifier

Returns

IPermissionControlled

permissionControlled

GetDisplayName()

Yields a human-readable name for rendering.

public string GetDisplayName()

Returns

string

name

GetParent()

Gets the parent of this object, for the purposes of inherited permissions.

public IPermissionControlled GetParent()

Returns

IPermissionControlled

parent

Remarks

Return null, if no parent permissions exist

GetPermissionIdentifier()

Combination of values that form a unique identifier.

public UnifiedPermissionIdentifier GetPermissionIdentifier()

Returns

UnifiedPermissionIdentifier

Unique identifier.

GetPermissions()

Gets the permissions.

public string[] GetPermissions()

Returns

string[]

The permissions.

MarkAsModified()

Marks the Area instance as modified

public void MarkAsModified()

SetSort(int)

Sets the sort value for the area and its language versions.

public int SetSort(int sortValue)

Parameters

sortValue int

The new sort value.

Returns

int

SynchronizeLanguageNames()

Renames the languages to the same name as the master area and adds the language culture to the name.

public void SynchronizeLanguageNames()