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

The ContentPluginBase type exposes the following members.

Methods

  NameDescription
Public methodContentGetDefaultSortOrder
Called when the user clicks on the sorting header above the columns.
Public methodContentGetSupportedField
Called to enumerate all supported fields. FieldIndex is increased by 1 starting from 0 until the plugin returns NoMoreFields.
Public methodContentGetSupportedFieldFlags
Called to get various information about a plugin variable. It's first called with FieldIndex=-1 to find out whether the plugin supports any special flags at all, and then for each field separately.
Public methodContentGetValue
Called to retrieve the value of a specific field for a given file, e.g. the date field of a file.
Public methodContentPluginUnloading
Called just before the plugin is unloaded, e.g. to close buffers, abort operations etc.
Public methodContentSetValue
Called to set the value of a specific field for a given file, e.g. to change the date field of a file.
Public methodContentStopGetValue
Called to tell a plugin that a directory change has occurred, and the plugin should stop loading a value.
Public methodGetDefaultSortOrder
When overriden in derived class, called when the user clicks on the sorting header above the columns.
Public methodGetSupportedFieldFlags
Called to get various information about a plugin variable. It's first called with FieldIndex=-1 to find out whether the plugin supports any special flags at all, and then for each field separately.
Public methodGetValue
Protected methodOnContentPluginUnloading
Called just before the plugin is unloaded, e.g. to close buffers, abort operations etc.
Public methodSetValue
When overriden in derived class called to set the value of a specific field for a given file, e.g. to change the date field of a file.
Public methodStopGetValue
When overriden in derived class, called to tell a plugin that a directory change has occurred, and the plugin should stop loading a value.

Fields

  NameDescription
Public fieldStatic memberContentSetValueSuccess

Properties

  NameDescription
Protected propertyFieldNameMaxLen
Gets maximal length of string that can be passed to FieldName.
Public propertyName
Gets name of plugin
(Inherited from PluginBase.)
Public propertySupportedFields
When overriden in derived class gets all supported custom fields.

See Also