 | Settings |
The SettingsObject type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | CloneT | Clone this object using serialization. |
| CopyTo | Copy this object to target object. |
| CreateAdapter | Provide GUI counterpart for this custom settings type. It will be shown as Export Profile Field settings tab, Profile Settings page or User Settings page depending on which type param this object is from ExportBaseFIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE. |
| CreateAdapters | Provide GUI counterparts for this custom settings type. They will be shown as multiple Export Profile Field settings tabs, Profile Settings pages or User Settings pages depending on which type param this object is from ExportBaseFIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE. You can override this function and set your implementation of CreateAdapter(ICTExtension) to return null, if you wish to provide multiple GUI controls for interracting with this object. |
| Deserialize(Byte) | Internally used for deserializing this object from store. |
 | Deserialize(Stream) |
Deserialize your object from s. Do not otherwise
manipulate or modify e.g. Position.
It is highly recommended to use StreamExtensions for popping
base types from s.
Data must be deserialized in same order as is serialized at Serialize(Stream). Make sure you deserialize according to Version variable and then set it to correspond current object version. |
 | GetCurrentVersion | Returns current version in format YYss where YY is major and ss is minor, e.g. 2401 for CT 2024 SP1. |
| Init | Must be called immediately after this object is created as new or when reinitialization is needed before deserialization. OR, you can call InitWithContext(ICTExtension, ISettingsContext) instead of this. |
| InitWithContext | Called immediately after this object is created as new or when reinitialization is needed before deserialization. Calls Init(ICTExtension) internally, but also sets Context as given. |
| IsCustomized | This function is meant to be sealed -implemented by CUSTOMTOOLS core objects to define the base object type, so it can be distinquished from script extended ones. This is needed for successful deserialization. See also HasSerializedCustomData. For implementation that do not override existing extensions, this can be ignored. |
| Serialize | Internally used for serializing and storing this object. |
| Serialize(Stream) |
Serialize your object to s. Do not otherwise
manipulate or modify e.g. Position.
It is highly recommended to use StreamExtensions for pushing
base types into s.
Data must be serialized in same order as is deserialized at Deserialize(Stream). |
See Also