MockPlugin.SampleListColumns.CreamTypeColumn Class Reference

Simple case: Enum based column. Possible values are given in the StandardItems, custom editor is not used. More...

Inheritance diagram for MockPlugin.SampleListColumns.CreamTypeColumn:

Collaboration diagram for MockPlugin.SampleListColumns.CreamTypeColumn:

Properties
string	InternalName [get]
	Nametag that will be used internally for storing a column of this type in the method. Do not change this once released, or the methods using this column type will no longer be usable.
string	VisibleName [get]
	Column type name that will be presented to the user in the method editor in the "Cell Type" column. Should be localizable.
IEnumerable< object >	ComboboxItems [get]
	List of possible values that can be presented to the user in a drop-down list.
Type	ValueType [get]
	Used for getting information which UITypeEditor, TypeConverter etc to use for your column.
IEnumerable< IColumnMenu >	ColumnHeaderMenu [get]
	If this is not null, it declares column header menu entries that can be used for "Autofill" like features.
Properties inherited from AxelSemrau.Chronos.Plugin.Columns.IColumnTypeDefinition
string	InternalName [get]
	Nametag that will be used internally for storing a column of this type in the method. Do not change this once released, or the methods using this column type will no longer be usable.
string	VisibleName [get]
	Column type name that will be presented to the user in the method editor in the "Cell Type" column. Should be localizable.
IEnumerable< object >	ComboboxItems [get]
	List of possible values that can be presented to the user in a drop-down list.
Type	ValueType [get]
	Used for getting information which UITypeEditor, TypeConverter etc to use for your column.
IEnumerable< IColumnMenu >	ColumnHeaderMenu [get]
	If this is not null, it declares column header menu entries that can be used for "Autofill" like features.

Private Member Functions
void	CycleThrough (IReadOnlyList< ICellAccessor > cells)
void	FillDown (IReadOnlyList< ICellAccessor > cells)
	Fill all given cells with the value of the top row.

Detailed Description

Simple case: Enum based column. Possible values are given in the StandardItems, custom editor is not used.

Definition at line 17 of file CreamTypeColumn.cs.

Member Function Documentation

CycleThrough()

void MockPlugin.SampleListColumns.CreamTypeColumn.CycleThrough ( IReadOnlyList< ICellAccessor >  cells )

private

Definition at line 35 of file CreamTypeColumn.cs.

        {
            if (cells.Count >= 2)
            {
                var allValues = Enum.GetValues(typeof(BrewFrappuccino.CreamType)).Cast<BrewFrappuccino.CreamType>().ToArray();
                var currVal = (BrewFrappuccino.CreamType) cells[0].Value;
                foreach (var someCell in cells.Skip(1))
                {
                    var validItems = someCell.Column.StandardItems;
                    var roundtrips = 0;
                    do
                    {
                        if (currVal == allValues.Last())
                        {
                            currVal = allValues.First();
                            roundtrips += 1;
                        }
                        else
                        {
                            currVal += 1;
                        }
                    } while (roundtrips < 2 &&  (validItems?.Count ?? 0) > 0 && !validItems.Contains(currVal.ToString()));
                    someCell.Value = currVal;
                }
            }
        }

FillDown()

void MockPlugin.SampleListColumns.CreamTypeColumn.FillDown ( IReadOnlyList< ICellAccessor >  cells )

private

Fill all given cells with the value of the top row.

Parameters

cells

Definition at line 66 of file CreamTypeColumn.cs.

        {
            if (cells.Count >= 2)
            {
                var topVal = cells[0].Value;
                foreach (var someCell in cells.Skip(1))
                {
                    someCell.Value = topVal;
                }
            }
        }

Property Documentation

ColumnHeaderMenu

IEnumerable<IColumnMenu> MockPlugin.SampleListColumns.CreamTypeColumn.ColumnHeaderMenu

get

If this is not null, it declares column header menu entries that can be used for "Autofill" like features.

Implements AxelSemrau.Chronos.Plugin.Columns.IColumnTypeDefinition.

Definition at line 26 of file CreamTypeColumn.cs.

        {
            get
            {
                yield return new ColumnHeaderMenu(() => LocalizeMockPlugin.CreamTypeColumn_ColumnHeaderMenu_Fill_down, FillDown);
                yield return new ColumnHeaderMenu(() => LocalizeMockPlugin.CreamTypeColumn_ColumnHeaderMenu_Cycle_through, CycleThrough);
            }
        }

ComboboxItems

IEnumerable<object> MockPlugin.SampleListColumns.CreamTypeColumn.ComboboxItems

get

List of possible values that can be presented to the user in a drop-down list.

As stated in the class documentation: Make sure ToString() returns values that can be converted back to your object type. If you don't want to restrict the user to a given value list, use the [Editable(true)] attribute.

Implements AxelSemrau.Chronos.Plugin.Columns.IColumnTypeDefinition.

Definition at line 22 of file CreamTypeColumn.cs.

InternalName

string MockPlugin.SampleListColumns.CreamTypeColumn.InternalName

get

Nametag that will be used internally for storing a column of this type in the method. Do not change this once released, or the methods using this column type will no longer be usable.

Implements AxelSemrau.Chronos.Plugin.Columns.IColumnTypeDefinition.

Definition at line 19 of file CreamTypeColumn.cs.

ValueType

Type MockPlugin.SampleListColumns.CreamTypeColumn.ValueType

get

Used for getting information which UITypeEditor, TypeConverter etc to use for your column.

Implements AxelSemrau.Chronos.Plugin.Columns.IColumnTypeDefinition.

Definition at line 24 of file CreamTypeColumn.cs.

VisibleName

string MockPlugin.SampleListColumns.CreamTypeColumn.VisibleName

get

Column type name that will be presented to the user in the method editor in the "Cell Type" column. Should be localizable.

Implements AxelSemrau.Chronos.Plugin.Columns.IColumnTypeDefinition.

Definition at line 20 of file CreamTypeColumn.cs.

---

The documentation for this class was generated from the following file:

• CreamTypeColumn.cs