Chronos Plugins 5.9.0
This documentation covers the plugin interfaces definitions and an example implementation.
Loading...
Searching...
No Matches
AxelSemrau.Chronos.Plugin.Columns.IColumnTypeDefinition Interface Reference

Implement this interface on a class that defines a custom column that can be used just like a builtin Chronos column type in the method editor and from the sample list. More...

+ Inheritance diagram for AxelSemrau.Chronos.Plugin.Columns.IColumnTypeDefinition:

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< IColumnMenuColumnHeaderMenu [get]
 If this is not null, it declares column header menu entries that can be used for "Autofill" like features.
 

Detailed Description

Implement this interface on a class that defines a custom column that can be used just like a builtin Chronos column type in the method editor and from the sample list.

This can be useful if you want to access some information of your device or acquisition service from the sample list without replicating all this information in the column definition in the method editor. Chronos does not care what type of object you are using for your StandardItems. Just make sure that there is a System.ComponentModel.TypeConverter for string->yourType conversions and vice versa.

Definition at line 17 of file ColumnType.cs.

Property Documentation

◆ ColumnHeaderMenu

IEnumerable<IColumnMenu> AxelSemrau.Chronos.Plugin.Columns.IColumnTypeDefinition.ColumnHeaderMenu
get

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

Implemented in MockPlugin.SampleListColumns.CoffeeTypeColumn, MockPlugin.SampleListColumns.CreamTypeColumn, and MockPlugin.SampleListColumns.DateColumn.

Definition at line 43 of file ColumnType.cs.

43{ get; }

◆ ComboboxItems

IEnumerable<object> AxelSemrau.Chronos.Plugin.Columns.IColumnTypeDefinition.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.

Implemented in MockPlugin.SampleListColumns.CoffeeTypeColumn, MockPlugin.SampleListColumns.CreamTypeColumn, and MockPlugin.SampleListColumns.DateColumn.

Definition at line 35 of file ColumnType.cs.

35{ get; }

◆ InternalName

string AxelSemrau.Chronos.Plugin.Columns.IColumnTypeDefinition.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.

Implemented in MockPlugin.SampleListColumns.CoffeeTypeColumn, MockPlugin.SampleListColumns.CreamTypeColumn, and MockPlugin.SampleListColumns.DateColumn.

Definition at line 23 of file ColumnType.cs.

23{ get; }

◆ ValueType

Type AxelSemrau.Chronos.Plugin.Columns.IColumnTypeDefinition.ValueType
get

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

Implemented in MockPlugin.SampleListColumns.CoffeeTypeColumn, MockPlugin.SampleListColumns.CreamTypeColumn, and MockPlugin.SampleListColumns.DateColumn.

Definition at line 39 of file ColumnType.cs.

39{ get; }

◆ VisibleName

string AxelSemrau.Chronos.Plugin.Columns.IColumnTypeDefinition.VisibleName
get

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

Implemented in MockPlugin.SampleListColumns.CoffeeTypeColumn, MockPlugin.SampleListColumns.CreamTypeColumn, and MockPlugin.SampleListColumns.DateColumn.

Definition at line 27 of file ColumnType.cs.

27{ get; }

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