Class ItemType

Namespace

Dynamicweb.Content.Items.Metadata

Assembly

Dynamicweb.dll

Represents an item metadata.

public class ItemType : IComparable<ItemType>

Inheritance

object

ItemType

Implements

IComparable<ItemType>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ItemType()

Initializes a new instance of an object.

public ItemType()

ItemType(ItemType)

Initializes a new instance of an object.

public ItemType(ItemType copyFrom)

Parameters

copyFrom ItemType

Object to copy state from.

Exceptions

ArgumentNullException

copyFrom is null.

ItemType(string)

Initializes a new instance of an object.

public ItemType(string systemName)

Parameters

systemName string

System name of an item type.

ItemType(string, string)

Initializes a new instance of an object.

public ItemType(string systemName, string name)

Parameters

systemName string

System name of an item type.

name string

User-friendly name of an item type.

Properties

Base

Gets or sets the system name of item type inherits from.

public string Base { get; set; }

Property Value

string

Category

Gets or sets item type category.

public ItemTypeCategory Category { get; set; }

Property Value

ItemTypeCategory

Item type category.

Description

Gets or sets the description of the item.

public string Description { get; set; }

Property Value

string

FieldForTitle

Gets or sets the system name of field to use as title.

public string FieldForTitle { get; set; }

Property Value

string

Fields

Gets or sets the collection of item field metadata.

public FieldMetadataCollection Fields { get; set; }

Property Value

FieldMetadataCollection

Icon

Gets or sets the icon.

public KnownIcon Icon { get; set; }

Property Value

KnownIcon

IconColor

Gets or sets the icon.

public KnownColor IconColor { get; set; }

Property Value

KnownColor

Image

Gets or sets the image path

public string Image { get; set; }

Property Value

string

IncludeInUrlIndex

Gets or sets the value indicating whether generate user friendly urls for this item.

public bool IncludeInUrlIndex { get; set; }

Property Value

bool

IsEmpty

Gets value indicating whether this item is empty and doesn't contain any fields.

public bool IsEmpty { get; }

Property Value

bool

LargeIcon

Gets or sets the large icon.

[Obsolete("Use Icon property instead.")]
public string LargeIcon { get; set; }

Property Value

string

Layout

Gets or sets the item layout.

public LayoutMetadata Layout { get; set; }

Property Value

LayoutMetadata

Name

Gets or sets the user-friendly name of the item.

public string Name { get; set; }

Property Value

string

PageDefaultView

Gets or sets the value indicating whether use Item or Paragraph view for newly created page-item.

public string PageDefaultView { get; set; }

Property Value

string

Rules

Gets or sets the collection of creation rules.

public CreationRuleMetadataCollection Rules { get; set; }

Property Value

CreationRuleMetadataCollection

SourceType

Gets or sets the activation source type.

public ActivationSourceType SourceType { get; set; }

Property Value

ActivationSourceType

SystemName

Gets or sets the system name of the item.

public string SystemName { get; set; }

Property Value

string

Title

Gets or sets the title.

public string Title { get; set; }

Property Value

string

UseCache

Gets or sets the value indicating whether item should be cached.

[Obsolete("Always uses cache")]
public bool UseCache { get; set; }

Property Value

bool

Methods

CompareTo(ItemType)

Compares the current object with the given one and returns the comparison result.

public int CompareTo(ItemType other)

Parameters

other ItemType

Object to compare with.

Returns

int

Comparison result.

CopyTo(ItemType)

Copies the state of the current object into the given one.

public void CopyTo(ItemType target)

Parameters

target ItemType

Object to copy state into.

Exceptions

ArgumentNullException

target is null.

FindRuleMetadata(Type)

Gets the rule metadata that matches the type provided, or an empty metadata if no match is found.

public CreationRuleMetadata FindRuleMetadata(Type type)

Parameters

type Type

Type of CreationRuleMetadata to search for

Returns

CreationRuleMetadata

CreationRuleMetadata model

GetAllFields()

public FieldMetadataCollection GetAllFields()

Returns

FieldMetadataCollection

ParseFrom(Type)

Returns the item metadata that is parsed from the metadata of the given type.

public static ItemType ParseFrom(Type type)

Parameters

type Type

Type to examine.

Returns

ItemType

Item metadata.