Articy.Api Namespace

 

Classes

AddedToListObjectProperty 
AddingToListObjectProperty 
ApiCollaborativeHelper 
ApiConsts static class that contains some constants and a error code helper method
ApiJourneyBuilder 
ApiLocationTools Helper class to work with locations
ApiSession Once the session is created successfully, all further API calls are invoked on this session object.
ArticyApiException The standard exception used when the API has found an expected error
BaseDataLayoutBuilderTBuilder Base class for all Data-Layout builders
ChangeAssetArgs 
CloseProjectArgs Argument class for CloseProject(CloseProjectArgs)
ComplexApiCallArgs base class for the argument objects used for API calls that have many parameters
ConflictContextArgs 
ContentAreaContextArgs 
ContextArgsBase Basis for view specific context arguments, used when adding new menu entries
DataLayoutBuilder A fluent api builder to modify the Data-Layout of a RuleSet
DiscardingArgs Argument class for discarding partition(s)
ExportDataArgs Base class for custom exporters that implements IArgsWithFilename.
ExportDocumentToDocxArgs The parameter args to be used for exporting a document object to Word
ExportObjectSelectionDataArgs Base class for custom exporters that allow pre-selection of to-be-exported objects (by implementing IArgsWithObjectPreselection).
ExportOutputTypeSelectorAttribute 
ExportPropertyAttribute 
ExportToAccessArgs Specialized argument class for the articy:access export
ExportToDocxArgs Specialized argument class for the DOCX export
ExportToFullXmlArgs Specialized argument class for the XML export This export currently has no other configuration options
ExportToXlsxArgs Specialized argument class for the XLSX export
ExportXlsxForReimportArgs Argument class for the XLSX export for Re-Import
ExtendedObjectValueQuery 
FlowListNode Contains the information about a single node in the flow linearization
FlowReference Contains the information about a reference in the flow linearization
GenericEngineExportArgs Export args for the Unity plugin export
GenericExportDataArgs When using the method ExportData(GenericExportDataArgs) an instance of this object needs to be passed along.
GlobalContextArgs Context Args for the ribbon toolbar context menu
ImportAssetInfo A tuple that contains the required information about an asset to be imported
ImportAssetsArgs Base args object for calling ImportAssets(ImportAssetsArgs).
ImportAssetsFromInfoArgs An args class for ImportAssets(ImportAssetsArgs) that uses a list of ImportAssetInfo objects for each to-be-imported asset.
JourneyPointAction 
JsonExportArgs Export args for the JSON export
LocalizableObjectPropertyChanged Called to notify when a basic, non-localizable, property was changed
LocalizableObjectPropertyChanging Called to notify when a basic, non-localizable, property was changed
LocalizationViewContextArgs Context args to create new context menu entries for the localization view
MdkExportDataArgs Base class for custom exporters to add custom settings.
MdkLoggingHelper 
MdkSettingsHandlerBase 
NavigatorContextArgs 
ObjectCreationContextArgs The context args object for the IsObjectCreationAllowed method
ObjectPropertyChanged Called to notify when a basic, non-localizable, property was changed
ObjectPropertyChangesArgumentsWithUndoRedoTracking 
ObjectPropertyChanging Called to notify when a basic, non-localizable, property was changed
ObjectPropertyInfo This class aggregates information about a single property that is exposed from ObjectProxy
ObjectPropertyNames 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
ObjectProxy Represents one articy:draft object like it is shown in the articy:draft GUI.
ObjectProxyExtensions Helper class to get convenient infos from a given ObjectProxy
ObjectTemplatePropertyChangedObsolete
ObjectTemplatePropertyChangingObsolete
ObjectTemplatePropertyCleared 
ObjectTemplatePropertyClearing 
OpenProjectArgs This argument object contains all parameters for the OpenProject(OpenProjectArgs) method
PackageBuilder 
PackageDataLayoutBuilder A fluent api builder to modify the Data-Layout of a package
RemovedFromListObjectProperty 
RemovingFromListObjectProperty 
ResultSet 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.
RuleSetBasedExport Base class for all ruleset based exports
RuleSetHandle Edit handle to modify data layout and packages
RuleSetHelper 
RuleSetInformation 
RuleSetPackageInformation 
SearchContextArgs 
SettingModelAccessorProxy 
SettingNames 
SettingsUiCheckboxAttribute 
SettingsUiEnumAttribute 
SettingsUiLanguageSelectorAttribute 
SettingsUiMultiObjectSelectorAttribute 
SettingsUiObjectSelectorAttribute 
SettingsUiPropertyAttribute 
SettingsUiStringPropertyAttribute 
SimplePartitionActionArgs Base class for arguments that require a partition Guid. Some methods only need these arguments with no additional parameters
TextProxy Gives access to all text and vo related sub properties for a text property in articy.
TextProxyTextPropertyAccessorTPropertyType 
ToastNotificationsHandler 
Transformer 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.
UnclaimPartitionArgs Argument class for unclaiming partition(s)
UnityExportArgs Export args for the Unity plugin export
UnrealExportArgs Export args for the Unreal plugin export
WaitForAssetProcessingArgs 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
WithoutGUI Used to suppress potential message boxes in articy.

Interfaces

IArgsWithFilename Implement this interface with your exporter settings type (MdkExportDataArgs) to add a target path for your export
IArgsWithObjectPreselection Implement this interface with your exporter settings type (MdkExportDataArgs) to add a selectable tree view UI to your export descriptor
IBaseDataLayoutBuilderTBuilder Base interface for a Data-Layout builder
IDataLayoutBuilderTBuilder Interface for a Data-Layout builder that can modify the properties
IExporterPropertyConverter 
IImportExportDescriptor Describes core metadata and creation logic for any import/export worker, enabling dynamic discovery, configuration, and integration in MDK plugins.
IObjectPropertyChangesArguments 
IPackageBuilder Interface for a RuleSet Package builder
IProgressHandler 
IProgressHandlerSegmentAdder 
IRuleSetHandle 
ISettingModelAccessors 
ISettingsProvider 
ISettingsViewModel 
ISettingsViewModelWithFilename 
IToastNotificationProgressBar 

Delegates

IsObjectAllowed delegate used to filter objects for the model picker
LoggingCallback The delegate used to report logging information

Enumerations

ApiExportFormatNodes 
ApiMode Enum that specifies in which context the API is used
ApiSessionFocusPane The split-pane that should be used
ApiSessionFocusTab The tab to be used to focus an object
ApiSessionFocusWindow The window that should be used to focus and object
CloseProgressMode Enumeration that describes what to do with a progress window if its operation has finished
ContextMenuContext Is used as a context indicator when a MDK plugin requests a context menu.
DataLayoutGroup Describes the main groups inside the Data-Layout
DataLayoutObjectTypeMode Describes the different modes a type has inside the Data-Layout
DataLayoutTemplateTypeMode Describes the different modes a template has inside the Data-Layout
EntryType Entry type of log messages
ErrorCode This enumeration contains error codes that are detected by the API
ExporterNames 
ExportTextFormat The text formatter to use when exporting text to Json, Unity, Unreal
ExportXlsxForReimportArgsSortObjectsBy Specifies the property that is used to sort the objects to be exported
FlowReferenceRefType the different types of references
FlowToListTraversalType 
HierarchyAdjustment Specifies the placement of a new document object in respect to the given context object.
JourneyActionTypes Available actions to take while recording a journey
LocalizableObjectPropertyMetaData Describes which part of a localizable property was modified
LocalizationViewContextArgsContextColumn The different columns in the localization editor
ObjectContext 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
ObjectCreationMenuContext Provides information in which context an object a user tries to create an object.
ObjectType This enumeration contains all object types available for API access.
OutputType 
PackageContainerMode Describes the different modes a container object has inside a package
PackageContentsMode Describes the different modes an object with content works inside a package
PackageSelfMode Describes the different modes a singular object works inside a package
ProjectRightLevel right levels of users in projects
ProjectUnavailabilityReason The reason why a project is currently not available
PropertyDataSubType a more detailed information about the data type
PropertyDataType known data types of fields/properties
PropertyFilter Flag based filter for GetAvailableProperties of ObjectProxy
ReadOnlyMode 
RepartitionMode Specifies how repartitioning should work on the given objects
ResolveTemplateLayer 
ResolveTemplateValue 
ScriptType Determines if a property of type Text/Script is either a condition, instruction or not known
SearchConflictsIn Flag enum for searching for conflicts
SearchTextIn Flag enum to specify where the simple text search should look up its strings
SelectionContext Used when reporting a selection to an MDK plugin
SystemFolderNames 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
TextCountMode Enumeration to specify which type of counting is/was used on a Text
TextFilterRelation enumeration of filter relations used for SimpleFindObjects(UInt64, String, TextFilterRelation, SearchTextIn, Boolean)
TextFormat Enumeration to specify if which format the GetText(TextFormat) overload should format the returned text.
TransformerAnchorPosition Specifies the pivot alignment/snapping
TransformerTransformMode Specifies the alignment for the bounding box used for the transformation