Property CustomInfo

CustomInfo

Provides access to the object's custom data area dedicated wholely to the application extensions.

Declaration

public ICustomInfoDictionary CustomInfo { get; }

Property Value

Type	Description
ICustomInfoDictionary

Remarks

This data allows plugin functions to store in the object some custom configuration variables. Since this data is stored as key-value pairs, each wizard or plugin function can isolate its own variables from other ones.

These specific character strings appear in the XML file that is generated by the "File|Export|Management data (.XML)" command; each one under a tag equal to the key with node text set to value.

You can ibtain the entire custom info data as an xml string format via the ToString() method.

Examples

The following example shows how store some custom data in an object, and how to read it.

void CustomInfoSample(Scene.Object obj)
{
    // Storing some data
    obj.CustomInfo["SomeKey"] = "SomeData";

    // Reading the data. It may happen later, in another plugin event, or even in
    // another InSitu session on another computer, but with the same scene file.
    string myPluginData = obj.CustomInfo["SomeKey"];
}