Table of Contents

Class CreateLanguageVariantParameters

Namespace
CMS.ContentEngine
Assembly
CMS.ContentEngine.dll

Parameters for creating a new language variant of a content item.

public sealed class CreateLanguageVariantParameters
Inheritance
object
CreateLanguageVariantParameters
Extension Methods

Constructors

CreateLanguageVariantParameters(int, string, string)

Initializes a new instance of CreateLanguageVariantParameters

public CreateLanguageVariantParameters(int contentItemId, string displayName, string languageName)

Parameters

contentItemId int

The id of the content item for which to create a new variant.

displayName string

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

languageName string

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

Exceptions

ArgumentException

Thrown when displayName or languageName are null or empty.

Properties

ContentItemId

The Id of the content item for which to create a new language variant.

public int ContentItemId { get; }

Property Value

int

DisplayName

The display name of the new variant, used to identify the item in user interface.

public string DisplayName { get; }

Property Value

string

LanguageName

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

public string LanguageName { get; }

Property Value

string

ScheduledPublishWhen

Date and time when the content item 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 content item should be unpublished.

public DateTime? ScheduledUnpublishWhen { get; set; }

Property Value

DateTime?

Remarks

Setting System.DateTime.MinValue is treated as null.

VersionStatus

Version status in which the new language variant will be created. Default status is InitialDraft.

public VersionStatus VersionStatus { get; set; }

Property Value

VersionStatus

Remarks

You cannot create content item 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.