ArticyDatabase Methods |
The ArticyDatabase type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | ClearDatabase |
This will completely resets the database and remove all changes.
|
| CloneFrom(String, UInt32) |
Creates a new clone of the object with the given technical name. The clone will get the supplied instance id. The clone must not exist beforehand.
|
| CloneFrom(UInt64, UInt32) |
Creates a new clone of the object with the given object id. The clone will get the supplied instance id. The clone must not exist beforehand.
|
| CloneFromTObject(String, UInt32) |
Creates a new clone of the object with the given technical name. The clone will get the supplied instance id. The clone must not exist beforehand.
|
| CloneOrGetFrom(String, UInt32) |
Try to get the object with the given technical name and instance id, or clone it if the instance id wasn't found.
|
| CloneOrGetFrom(UInt64, UInt32) |
Try to get the object with the given object id and instance id, or clone it if the instance id wasn't found.
|
| CloneOrGetFromTObject(String, UInt32) |
Try to get the object with the given technical name and instance id, or clone it if the instance id wasn't found.
|
| CloneWithConsecutiveInstanceIdFrom(String, UInt32) |
Creates a new clone from the object with the given technical name, and assigns automatically a new free consecutive instance id
|
| CloneWithConsecutiveInstanceIdFrom(UInt64, UInt32) |
Creates a new clone from the object with the given object id, and assigns automatically a new free consecutive instance id
|
| CloneWithConsecutiveInstanceIdFromTObject(String, UInt32) |
Creates a new clone from the object with the given technical name, and assigns automatically a new free consecutive instance id
|
| FilterObjects |
Returns a list of all objects that match the given search string.
|
| FilterObjectsBasedOn |
Returns a list of all objects that match the given search string based on a pre filtered list.
|
| GetAllOfTypeTObject |
Gets all articy objects of the specified type.
|
 | GetObject(String) |
Gets an object by its technical name. This is always the base object.
|
| GetObject(String, UInt32) |
Gets an object by its technical name and instance id.
|
| GetObject(UInt64, UInt32) |
Gets an object by its object id and an optional instance id.
|
| GetObjectTObject(String) |
Gets an object by its technical name and returning it in the specified type.
|
| GetObjectTObject(String, UInt32) |
Gets an object by its technical name and instance id and returning it in the specified type.
|
| GetObjectTObject(UInt64, UInt32) |
Gets an object by its object id and an optional instance id.
|
| GetObjects(String) |
Gets all objects with the given technical name. This will contain all objects: base and clones.
|
| GetObjects(String, UInt32) |
Gets all objects with the given technical name and instance id.
|
| IsDatabaseAvailable |
Determines if the database is ready to be used.
|
| IsObjectAvailable(String) |
Determines whether the object can be found in the database with the given technical name.
|
| IsObjectAvailable(UInt64) |
Determines whether the object can be found in the database with the given object id.
|
| IsObjectInLoadedPackages |
Determines whether the given object is in currently loaded packages.
|
| LoadPackage(String) |
Loads the given package by name.
|
| LoadPackage(UInt64) |
Loads the given package by id.
|
| RemoveAllClones(String) |
Removes all clones for an object with the given id.
|
| RemoveAllClones(UInt64) |
Removes all clones for an object with the given id.
|
| RemoveClone(String, UInt32) |
Removes the clone with a given instance id from the object with the given technical name.
|
| RemoveClone(UInt64, UInt32) |
Removes the clone with a given instance id from the object with the given object id.
|
| UnloadPackage(String, Boolean) |
Unloads a previously loaded package.
|
| UnloadPackage(UInt64, Boolean) |
Unloads a previously loaded package.
|
See Also