Articy.Api Namespace

static class that contains some constants and a error code helper method

Helper class to work with locations

Once the session is created successfully, all further API calls are invoked on this session object.

The standard exception used when the API has found an expected error

Argument class for CloseProject(CloseProjectArgs)

base class for the argument objects used for API calls that have many parameters

The abstract base class for all specialized export arguments

The parameter args to be used for exporting a document object to Word

Abstract base class for all exports that allow pre-selection of to-be-exported objects. Currently this are the office exports (DOCX and XLSX)

Specialized argument class for the articy:access export

Specialized argument class for the DOCX export

Specialized argument class for the XML export This export currently has no other configuration options

Specialized argument class for the XLSX export

Argument class for the XLSX export for Re-Import

Contains the information about a single node in the flow linearization

Contains the information about a reference in the flow linearization

When using the method ExportData(GenericExportDataArgs) an instance of this object needs to be passed along.

Export args for the JSON export

This class aggregates information about a single property that is exposed from ObjectProxy

This class contains constants for all properties that are introduced by the base objects of articy:draft. You can find type infos and restrictions in braces after the name

Represents one articy:draft object like it is shown in the articy:draft GUI.

This argument object contains all parameters for the OpenProject(OpenProjectArgs) method

This object is the container of objects that were found from a query. It is also internally used to cache meta/schema data for all accessed properties from elements in the row collection. This reduces the memory footprint and gives some extra speed when having many object of the same type in the result set.

Base class for all ruleset based exports

Base class for arguments that require a partition Guid. Some methods only need these arguments with no additional parameters

This class contains methods to transform a selection of location objects. This object can only be created from an ApiLocationTools that is bound to a specific location.

Argument class for unclaiming partition(s)

Export args for the Unity plugin export

Export args for teh Unreal 4 plugin export

Argument class for the WaitForAssetProcessing(WaitForAssetProcessingArgs) method. The main purpose is to be able to specify a log source name where progress messages should be reported

delegate used to filter objects for the model picker

The delegate used to report logging information

Enum that specifies in which context the API is used

The split-pane that should be used

The tab to be used to focus an object

The window that should be used to focus and object

Enumeration that describes what to do with a progress window if its operation has finished

Is used as a context indicator when a MDK plugin requests a context menu.

Entry type of log messages

This enumeration contains error codes that are detected by the API

The text formatter to use when exporting text to Json, Unity, Unreal

Specifies the property that is used to sort the objects to be exported

the different types of references

Specifies the placement of a new document object in respect to the given context object.

Available actions to take while recording a journey

Specifies the context a given object resides. The context is calculated by checking if the given object is a child of the matching system folder

This enumeration contains all object types available for API access.

right levels of users in projects

The reason why a project is currently not available

a more detailed information about the data type

known data types of fields/properties

Flag based filter for GetAvailableProperties of ObjectProxy

Specifies how repartitioning should work on the given objects

Flag enum for searching for conflicts

Flag enum to specify where the simple text search should look up its strings

Used when reporting a selection to an MDK plugin

Technical names of system folders. These names can be used in the FROM clause of a query and to get the folder object when using the GetSystemFolder(SystemFolderNames) method

enumeration of filter relations used for SimpleFindObjects(UInt64, String, TextFilterRelation, SearchTextIn, Boolean)

Enumeration to specify if which format the GetText(TextFormat) overload should format the returned text.

Specifies the pivot alignment/snapping

Specifies the alignment for the bounding box used for the transformation