Table of Contents

Class CreateLanguageVariantParameters

Namespace
CMS.Websites
Assembly
CMS.Websites.dll

Create language variant parameters.

public sealed class CreateLanguageVariantParameters
Inheritance
object
CreateLanguageVariantParameters
Extension Methods

Constructors

CreateLanguageVariantParameters(int, string, string, ContentItemData)

Initializes a new instance of CreateLanguageVariantParameters.

public CreateLanguageVariantParameters(int webPageItemId, string languageName, string displayName, ContentItemData contentItemData = null)

Parameters

webPageItemId int

Identifier of a web page for which to create a new language variant.

languageName string

The language code of the new language for which to create a new language variant.

displayName string

The display name to be used of the new variant to be used in the user interface.

contentItemData ContentItemData

Type specific content item data which will be used to create a new language variant. May be null in case of folder.

Exceptions

ArgumentException

Thrown when displayName or languageName is null or empty.

ArgumentNullException

Thrown when contentItemData is null.

Properties

ContentItemData

Type specific content item data. See ContentItemData.

public ContentItemData ContentItemData { get; }

Property Value

ContentItemData

DisplayName

Web page display name.

public string DisplayName { get; }

Property Value

string

LanguageName

Language codename of the language variant in which the web page will be created.

public string LanguageName { get; }

Property Value

string

ScheduledPublishWhen

Date and time when the web page should be published.

public DateTime? ScheduledPublishWhen { get; set; }

Property Value

DateTime?

Remarks

Setting System.DateTime.MinValue is treated as null.

ScheduledUnpublishWhen

Date and time when the web page should be unpublished.

public DateTime? ScheduledUnpublishWhen { get; set; }

Property Value

DateTime?

Remarks

Setting System.DateTime.MinValue is treated as null.

UrlSlug

Web page URL slug.

public string UrlSlug { get; set; }

Property Value

string

VersionStatus

Version status in which the new language variant will be created. Default status is InitialDraft. Not used when creating a new variant for folders.

public VersionStatus VersionStatus { get; set; }

Property Value

VersionStatus

Remarks

You cannot create web page in Draft version. First create a Published version, then create a Draft using TryCreateDraft(int, string, CancellationToken).

Exceptions

ArgumentException

Thrown when you attempt to set the VersionStatus to Draft.

WebPageItemID

Web page item identifier.

public int WebPageItemID { get; }

Property Value

int