ICustomDataSetInfoProvider Interface
An interface that may be implemented by a custom dataset to customize its DataSetInfo.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECustomObjects assembly)
Syntax
public interface ICustomDataSetInfoProviderRemarks
A custom dataset may implement this interface to customize the DataSetInfo returned by DataSet.GetDataSetInfo. This can be used to return more specific information about the dataset object and its data, compared with the default DataSetInfo that is otherwise generated for custom datasets. When DataSet.GetDataSetInfo is called on a CustomDataSetProxy that holds a custom dataset implementing this interface, the request is forwarded to the GetInfo method.
A custom dataset that implements this interface may also be registered as a DataSetInfo provider for data files with a certain file extension. Doing so allows the custom-dataset class to handle invocations to DataSetInfo.FromFile and DataSetInfo.FromDirectory. For information on this, see CustomDataSetProxy.RegisterInfoProvider.
If you do not intend to register your custom dataset implementation as a DataSetInfo provider, you only have to fully implement the overload of GetInfo that does not take a path parameter. Instantiate and the GetInfo overload that takes a path as a parameter must also be implemented, but it is sufficient to make them return null.
Platforms
Windows, Linux, Android
ICustomDataSetInfoProvider Members
The ICustomDataSetInfoProvider type has the following members.
Methods
| Name | Description |
|---|---|
| GetInfo | Overloaded. Creates and populates a DataSetInfo, with contents customized for this custom dataset implementation. |
| Instantiate | Instantiate a new instance of this custom dataset class that reads the data at the given file path. |