Class CheckboxListEditor<T>

Namespace

Dynamicweb.Content.Items.Editors

Assembly

Dynamicweb.dll

Represents a checkbox list editor.

[Group("Lists")]
[Editor("Checkbox list")]
public class CheckboxListEditor<T> : ListEditor<IEnumerable<T>>, IListEditor, IListTemplate, IDropDownOptions

Type Parameters

T

Item value type.

Inheritance

object

ConfigurableAddIn

Editor

ListEditor<IEnumerable<T>>

CheckboxListEditor<T>

Implements

IListEditor

IListTemplate

IDropDownOptions

Inherited Members

ListEditor<IEnumerable<T>>.MaxIconColumnsPerRow

ListEditor<IEnumerable<T>>.Items

ListEditor<IEnumerable<T>>.DataType

ListEditor<IEnumerable<T>>.BeginEdit(EditorContext)

ListEditor<IEnumerable<T>>.EndEdit()

ListEditor<IEnumerable<T>>.GetViewModel(object, ItemField, bool)

ListEditor<IEnumerable<T>>.StringifyValue(object)

ListEditor<IEnumerable<T>>.RenderItemListValue(string)

ListEditor<IEnumerable<T>>.RenderValue(EditorRenderingContext)

ListEditor<IEnumerable<T>>.SourceItems

ListEditor<IEnumerable<T>>.IsItemSelected(Type, ListItem, IEnumerable<object>)

ListEditor<IEnumerable<T>>.ConvertItemValueAs(Type, ListItem)

ListEditor<IEnumerable<T>>.GetFullIconPath(string)

ListEditor<IEnumerable<T>>.GetGenericType(object)

ListEditor<IEnumerable<T>>.ConvertItemValueAsEnumerable(ListItem)

ListEditor<IEnumerable<T>>.ConvertItemValueAsString(ListItem)

ListEditor<IEnumerable<T>>.RenderItemTemplate(EditorContext, IEnumerable<T>)

ListEditor<IEnumerable<T>>.RenderIconList(TextWriter, IEnumerable<T>, ListEditorMode, OptionLabelPosition, int, int, int, bool)

Editor.Key

Editor.HttpContext

Editor.ValueConverter

Editor.Validators

Editor.Disabled

Editor.CssClass

Editor.BeginEditFrontend(EditorContext)

Editor.EndEditFrontend()

Editor.GetViewModelValue(object)

Editor.NewKey()

Editor.GetEditorType(ItemField)

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CheckboxListEditor()

Initializes a new instance of an object.

public CheckboxListEditor()

Properties

AllowOptionsSorting

Gets or sets the flag if the option might be sorted.

[AddInLabel("Allow options sorting")]
[AddInParameter("SortableOptions")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "inputClass=std editor-parameter;")]
public virtual bool AllowOptionsSorting { get; set; }

Property Value

bool

EncodeValues

Gets or sets the flag if the values should be encoded in DB.

[AddInLabel("Encode values")]
[AddInParameter("EncodeValues")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "inputClass=std editor-parameter;")]
public override bool EncodeValues { get; set; }

Property Value

bool

IconMaxHeight

Gets or sets the value of icon max height.

[AddInLabel("Options icon max height")]
[AddInParameter("IconMaxHeight")]
[AddInParameterEditor(typeof(IntegerNumberParameterEditor), "inputClass=std editor-parameter;allowNegativeValues=false")]
[AddInDescription("Icon max height")]
public virtual int IconMaxHeight { get; set; }

Property Value

int

IconMaxWidth

Gets or sets the value of icon max width.

[AddInLabel("Options icon max width")]
[AddInParameter("IconMaxWidth")]
[AddInParameterEditor(typeof(IntegerNumberParameterEditor), "inputClass=std editor-parameter;allowNegativeValues=false")]
[AddInDescription("Icon max width")]
public virtual int IconMaxWidth { get; set; }

Property Value

int

IconPosition

Gets or sets the value which defines the option icon position.

[AddInLabel("Options icon position")]
[AddInParameter("IconPosition")]
[AddInParameterEditor(typeof(DropDownParameterEditor), "SortBy=Key;inputClass=std editor-parameter")]
[AddInDescription("Icon count per row")]
public virtual int IconPosition { get; set; }

Property Value

int

ItemTemplate

Gets or sets the item template

[AddInLabel("Options template")]
[AddInParameter("ItemTemplate")]
[AddInParameterEditor(typeof(TemplateParameterEditor), "folder=Templates/Items;FullPath=false;inputClass=std editor-parameter;")]
public override string ItemTemplate { get; set; }

Property Value

string

LabelPosition

Gets or sets the value which defines the option label position.

[AddInLabel("Options label position")]
[AddInParameter("LabelPosition")]
[AddInParameterEditor(typeof(DropDownParameterEditor), "inputClass=std editor-parameter")]
[AddInDescription("Label position relatively icon")]
public virtual int LabelPosition { get; set; }

Property Value

int

Mode

Gets the list mode.

public override ListEditorMode Mode { get; }

Property Value

ListEditorMode

Methods

GetOptions(string)

Get options for editors with multiple values

public Hashtable GetOptions(string dropdownName)

Parameters

dropdownName string

Returns

Hashtable

GetViewModelValue(object, ItemField)

Gets the model to use when rendering list viewmodels with included options-

public override object GetViewModelValue(object value, ItemField field)

Parameters

value object

Value

field ItemField

Field

Returns

object

HasValue()

Tell if this editor returns a value

[Obsolete("Do not use")]
public override bool HasValue()

Returns

bool

RenderList(EditorContext, IEnumerable<T>)

Renders list.

[Obsolete("Do not use")]
protected override void RenderList(EditorContext context, IEnumerable<T> selectedItem)

Parameters

context EditorContext

Editor context.

selectedItem IEnumerable<T>

Selected item.