Table of Contents

Class CreateFolderParameters

Namespace
CMS.Websites
Assembly
CMS.Websites.dll

Create folder parameters.

public sealed class CreateFolderParameters
Inheritance
object
CreateFolderParameters
Extension Methods

Constructors

CreateFolderParameters(string, string)

Initializes a new instance of CreateFolderParameters.

public CreateFolderParameters(string displayName, string languageName)

Parameters

displayName string

Name of the folder for use in UI.

languageName string

Language codename of a new folder.

Remarks

Name will be generated automatically.

Exceptions

ArgumentException

Thrown when displayName or languageName is null or empty.

See Also

CreateFolderParameters(string, string, string)

Initializes a new instance of CreateFolderParameters.

public CreateFolderParameters(string name, string displayName, string languageName)

Parameters

name string

Code name of the folder.

displayName string

Name of the folder for use in UI.

languageName string

Language codename of a new folder.

Exceptions

ArgumentException

Thrown when name, displayName or languageName is null or empty or when name is not a valid code name.

Properties

DisplayName

Folder display name.

public string DisplayName { get; }

Property Value

string

GenerateName

Indicates if content item's Name should be automatically generated.

public bool GenerateName { get; }

Property Value

bool

LanguageName

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

public string LanguageName { get; }

Property Value

string

Name

Code name of the folder.

public string Name { get; }

Property Value

string

Remarks

Code name has to consist of upper and lower case letters, numbers, dash or underscore. This value can be null if GenerateName is set to true leading to automatic generation of code name.

See Also
IsCodeName(object, bool)

ParentWebPageItemID

Identifier of parent web page or parent folder. Not specified if a folder has no parent.

public int ParentWebPageItemID { get; set; }

Property Value

int

RequiresAuthentication

Indicates if child web pages under the folder requires authentication. By default, folder will be created without the need for authentication for child web pages.

public bool RequiresAuthentication { get; set; }

Property Value

bool