Table of Contents

Interface ICustomObject

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll

Base for interfaces used by the extensibility framework.

public interface ICustomObject

Properties

CustomObjectDefinition

Gets or sets the custom data definition for the custom object.

ICustomObjectSettings CustomObjectDefinition { get; set; }

Property Value

ICustomObjectSettings

Remarks

The data definition is stored by adTempus in serialized form. When you request it using by reading the CustomObjectDefinition property, adTempus loads the add-in defined for the object, deserializes the data, and returns the add-in object. If the add-in cannot be loaded, an ExtensionTypeNotFoundException is thrown. To avoid the exception in this case, use TryGetCustomObjectDefinition(out ICustomObjectSettings) instead.

Exceptions

ExtensionTypeNotFoundException

Thrown if the extension class needed to read the definition is not installed on this computer. See Remarks.

See Also

CustomObjectDescription

Gets a description of the custom object.

string CustomObjectDescription { get; }

Property Value

string

CustomObjectTypeID

Gets the unique identification string for this class.

string CustomObjectTypeID { get; }

Property Value

string

CustomObjectVersion

Gets the version of the object.

int CustomObjectVersion { get; }

Property Value

int

Remarks

The version is stored by adTempus and passed in to the object when deserializing.

Methods

TryGetCustomObjectDefinition(out ICustomObjectSettings)

Attempts to get the custom data definition for the custom object.

bool TryGetCustomObjectDefinition(out ICustomObjectSettings objectDefinition)

Parameters

NameTypeDescription
objectDefinition ICustomObjectSettings

On success, contains the object definition

Returns

bool

True if the definition was successfully returned, False otherwise.

Remarks

The data definition is stored by adTempus in serialized form. When you request it using by reading the CustomObjectDefinition property, adTempus loads the add-in defined for the object, deserializes the data, and returns the add-in object. If the add-in cannot be loaded, or the data cannot be deserialized, this method returns False.

See Also