Class FieldOptionMetadataSource

Namespace

Dynamicweb.Content.Items.Metadata

Assembly

Dynamicweb.dll

Represents a source of field options.

[DataContract]
public abstract class FieldOptionMetadataSource : IComparable<FieldOptionMetadataSource>

Inheritance

object

FieldOptionMetadataSource

Implements

IComparable<FieldOptionMetadataSource>

FieldOptionMetadataFolderSource

FieldOptionMetadataItemSource

FieldOptionMetadataSqlSource

FieldOptionMetadataStaticSource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

SourceType

Type of source.

[DataMember]
public abstract FieldOptionSourceType SourceType { get; }

Property Value

FieldOptionSourceType

Type

Type of source.

[DataMember]
[Obsolete("Use SourceType instead")]
public virtual FieldOptionSourceType Type { get; }

Property Value

FieldOptionSourceType

Values

Collection of field options.

public virtual FieldOptionMetadataCollection Values { get; set; }

Property Value

FieldOptionMetadataCollection

Methods

CompareTo(FieldOptionMetadataSource)

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

public virtual int CompareTo(FieldOptionMetadataSource other)

Parameters

other FieldOptionMetadataSource

Object to compare with.

Returns

int

Comparison result.

CopyTo(FieldOptionMetadataSource)

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

public abstract void CopyTo(FieldOptionMetadataSource target)

Parameters

target FieldOptionMetadataSource

Object to copy state into.

Exceptions

ArgumentNullException

target is null.

CreateDecodedOption(string, object)

Creates field option with url decoded fields.

public static FieldOptionMetadata CreateDecodedOption(string name, object value)

Parameters

name string

Value for name field.

value object

Value for value field.

Returns

FieldOptionMetadata

FieldOptionMetadata.

CreateDecodedOption(string, object, string)

Creates field option with url decoded fields.

public static FieldOptionMetadata CreateDecodedOption(string name, object value, string icon)

Parameters

name string

Value for name field.

value object

Value for value field.

icon string

Value for icon field.

Returns

FieldOptionMetadata

FieldOptionMetadata.

CreateEncodedOption(string, object)

Creates field option with url encoded fields.

public static FieldOptionMetadata CreateEncodedOption(string name, object value)

Parameters

name string

Value for name field.

value object

Value for value field.

Returns

FieldOptionMetadata

FieldOptionMetadata.

CreateEncodedOption(string, object, string)

Creates field option with url encoded fields.

public static FieldOptionMetadata CreateEncodedOption(string name, object value, string icon)

Parameters

name string

Value for name field.

value object

Value for value field.

icon string

Value for icon field.

Returns

FieldOptionMetadata

FieldOptionMetadata.

DeserializeFrom(XmlReader)

Deserializes a current instance of a class from specific source.

public abstract void DeserializeFrom(XmlReader reader)

Parameters

reader XmlReader

Xml Reader

SafeCopyString(string)

[Obsolete("Use SafeStringCopy instead.")]
protected string SafeCopyString(string str)

Parameters

str string

Returns

string

SafeStringCopy(string)

protected string SafeStringCopy(string value)

Parameters

value string

Returns

string

SerializeTo(XmlWriter)

Serializes a current instance of class to specific source.

public abstract void SerializeTo(XmlWriter writer)

Parameters

writer XmlWriter

Xml Writer

Update()

Updates source collection

public abstract void Update()

ValidateCopying(FieldOptionMetadataSource)

protected void ValidateCopying(FieldOptionMetadataSource target)

Parameters

target FieldOptionMetadataSource