Table of Contents

Class ScriptLibrary

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
public sealed class ScriptLibrary : ADTIndependentObject
Inheritance
object
ScriptLibrary

Properties

CID

The Class ID for the object

[IgnoreDataMember]
public override ClassID CID { get; }

Property Value

ClassID

Remarks

Obsolete. Use ClassID instead.

ClassKeyName

The key name for the class.

public override string ClassKeyName { get; }

Property Value

string

Remarks

This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.

Description

public string Description { get; set; }

Property Value

string

ExtendedDescription

public override string ExtendedDescription { get; }

Property Value

string

IncludeLibraries

public ScriptLibraryCollection IncludeLibraries { get; }

Property Value

ScriptLibraryCollection

IsDefaultFunctionLibrary

public bool IsDefaultFunctionLibrary { get; }

Property Value

bool

IsDependent

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

Name

public string Name { get; set; }

Property Value

string

References

public string References { get; set; }

Property Value

string

ScriptBody

public string ScriptBody { get; set; }

Property Value

string

ScriptLanguage

public string ScriptLanguage { get; set; }

Property Value

string

Methods

DependsOnLibrary(OID)

Indicates whether the ScriptLibrary, or any of the libraries it references, has a reference to a given ScriptLibrary.

public bool DependsOnLibrary(OID libraryOID)

Parameters

NameTypeDescription
libraryOID OID

The OID of the library to check for.

Returns

bool

True if this library or any of its IncludeLibraries (or their dependencies) reference the given library, False otherwise.

Remarks

This method is used to detect circular library references

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Remarks

This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.

See Also

SerializeForCompilation()

Serialize the DTO so it can be passed to ScriptEngine.CompileScriptLibrary.

public string SerializeForCompilation()

Returns

string

Remarks

The Console needs to be able to compile script libraries to assemblies so the Script Editor can read them to do intellisense. Don't want to create ScriptEngine dependency on Client or have client exposing DTO classes, so we serialize the DTO here, and ScriptEngine deserializes it.

ValidateScript(CredentialProfile)

public MessageCollection ValidateScript(CredentialProfile credentials)

Parameters

NameTypeDescription
credentials CredentialProfile

Returns

MessageCollection

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

Inherited Members