[This is preliminary documentation and is subject to change.]
The ContentPluginBase type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| ContentGetDefaultSortOrder | Called when the user clicks on the sorting header above the columns. | |
| ContentGetSupportedField | Called to enumerate all supported fields. FieldIndex is increased by 1 starting from 0 until the plugin returns NoMoreFields. | |
| ContentGetSupportedFieldFlags | 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. | |
| ContentGetValue | Called to retrieve the value of a specific field for a given file, e.g. the date field of a file. | |
| ContentPluginUnloading | Called just before the plugin is unloaded, e.g. to close buffers, abort operations etc. | |
| ContentSetValue | Called to set the value of a specific field for a given file, e.g. to change the date field of a file. | |
| ContentStopGetValue | Called to tell a plugin that a directory change has occurred, and the plugin should stop loading a value. | |
| GetDefaultSortOrder | When overriden in derived class, called when the user clicks on the sorting header above the columns. | |
| GetSupportedFieldFlags | 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. | |
| GetValue | ||
| OnContentPluginUnloading | Called just before the plugin is unloaded, e.g. to close buffers, abort operations etc. | |
| SetValue | 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. | |
| StopGetValue | 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
| Name | Description | |
|---|---|---|
| ContentSetValueSuccess | This value is returned by ContentSetValue(SByte*, Int32, Int32, Int32, Void*, Int32) on success. |
Properties
| Name | Description | |
|---|---|---|
| FieldNameMaxLen | Gets maximal length of string that can be passed to FieldName. | |
| Name | Gets name of plugin (Inherited from PluginBase.) | |
| SupportedFields | When overriden in derived class gets all supported custom fields. |