[This is preliminary documentation and is subject to change.]

When overriden in derived class gets all supported custom fields.

Namespace: Tools.TotalCommanderT
Assembly: Tools.TotalCommander (in Tools.TotalCommander.dll) Version: 1.5.3.38916 (1.5.3.38916)

Syntax

C#
public virtual ContentFieldSpecification[] SupportedFields { get; }
Visual Basic
Public Overridable ReadOnly Property SupportedFields As ContentFieldSpecification()
	Get
Visual C++
public:
virtual property array<ContentFieldSpecification^>^ SupportedFields {
	array<ContentFieldSpecification^>^ get ();
}
F#
abstract SupportedFields : ContentFieldSpecification[]
override SupportedFields : ContentFieldSpecification[]
JScript
function get SupportedFields () : ContentFieldSpecification[]

Return Value

Array columns specifications supported by this plugin. Null or an empty array where there are no plugin-specified columns.
Note
When array returned contains columns of type FullText there shall be no non-FullText columns at higher index than column of type FullText. This is required for Total Commander by way it handles fulltext columns.

Remarks

Custom fields are custom columns provided by plugin for details view.

When most derived implementation of property getter is marked with MethodNotSupportedAttribute, it means that the most derived plugin implementation does not support operation provided by the property.

Note
Do not throw any other exceptions. Such exception will be passed to Total Commander which cannot handle it.
Note
Items of array retuned by this property must fullfill several constraints:
  • FieldName shall not contain dot (.), pipe (|), colon (:) or nullchar.
  • FieldName shall not be onger than FieldNameMaxLen.
  • Units shall not contain item containing dot (.), pipe (|), colon (:) or nullchar.
  • Sum of lenghts of items of Units plus number of them minus one shall not be greater than FieldNameMaxLen.

    This is because how Total Commander handles units: Unit names are concatenated to single string separated by pipes (|). And length of the string shall not be greater than FieldNameMaxLen.

  • All fields that are not of type FullText must be at indexes lower than index of any item of type FullText.
  • Value of the FieldIndex property shall be the same as index at which it is retuned.
Violation of any of these rules may leed to uncatchable exceptin being thrown or to unpredictable behavior of Total Commander.

Exceptions

ExceptionCondition
System..::..NotSupportedExceptionThe actual implementation of property getter is marked with MethodNotSupportedAttribute.

See Also

Collapse/expand Version History

1.5.3

  • This property is new in version 1.5.3