Struct ContentFolderId

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Represents a unique identifier of a content folder.

public readonly struct ContentFolderId

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

ContentFolderId(int?, FolderType)

Initializes a new instance of the ContentFolderId struct.

public ContentFolderId(int? id, FolderType folderType)

Parameters

id int?

folderType FolderType

Properties

AllContentItems

The all content items folder.

public static ContentFolderId AllContentItems { get; }

Property Value

ContentFolderId

FolderType

The type of the folder.

public FolderType FolderType { get; }

Property Value

FolderType

Id

The raw ID of the folder.

public int? Id { get; }

Property Value

int?

Invalid

The invalid folder.

public static ContentFolderId Invalid { get; }

Property Value

ContentFolderId

Methods

Equals(ContentFolderId)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(ContentFolderId other)

Parameters

other ContentFolderId

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

Parse(string)

Parses the string ID into a ContentFolderId instance.

public static ContentFolderId Parse(string id)

Parameters

id string

The string representation of the folder identifier.

Returns

ContentFolderId

The parsed folder identifier.

Remarks

Returns Invalid if the identifier is not valid.

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.

Operators

operator ==(ContentFolderId, ContentFolderId)

Tests the two entries for equality.

public static bool operator ==(ContentFolderId left, ContentFolderId right)

Parameters

left ContentFolderId

right ContentFolderId

Returns

bool

operator !=(ContentFolderId, ContentFolderId)

Tests the two entries for inequality.

public static bool operator !=(ContentFolderId left, ContentFolderId right)

Parameters

left ContentFolderId

right ContentFolderId

Returns

bool