articy:draft 3 Macro DevKit Reference
Starter Guide
Articy.Api
ApiConsts Class
ApiLocationTools Class
ApiMode Enumeration
ApiSession Class
ApiSession Properties
ApiSession Methods
BringObjectIntoView Method
ChangeAsset Method
ClaimPartition Method
ClaimPartitions Method
CloneChildren Method
CloneObject Method
CloseProject Method
ConnectPins Method
ConnectToServer Method
ConvertBitmapToBrush Method
CreateBrushFromArray Method
CreateBrushFromBitmap Method
CreateBrushFromFile Method
CreateBrushFromStream Method
CreateComment Method
CreateCondition Method
CreateDialogue Method
CreateDialogueFragment Method
CreateDocument Method
CreateDocumentDialogue Method
CreateDocumentImage Method
CreateDocumentText Method
CreateEntity Method
CreateFlowFragment Method
CreateFolder Method
CreateGlobalVariable Method
CreateHub Method
CreateInstruction Method
CreateJump Method
CreateLink Method
CreateLocation Method
CreateLocationGroup Method
CreateLocationImage Method
CreateLocationLayerFolder Method
CreateLocationText Method
CreatePath Method
CreateSpot Method
CreateVariableSet Method
CreateZoneCircle Method
CreateZonePolygon Method
CreateZoneRect Method
DeleteObject Method
DiscardChangesToPartition Method
DisconnectServer Method
Dispose Method
ExecuteQueryInSearchNavigator Method
ExecuteTaskWithProgressDialog Method
ExportData Method
ExportDocument Method
FeaturePresent Method
FindFlowPosition Method
ForcefullyUnclaimPartition Method
FormatException Method
GetAllowedObjectsForContext Method
GetClaimingStateInfo Method
GetClassPropertyInfo Method
GetCurrentUser Method
GetExportSettings Method
GetFeaturePropertyInfo Method
GetFeaturePropertyNames Method
GetGlobalVariable Method
GetLocationToolsFor Method
GetObjectById Method
GetObjectByTechName Method
GetObjectTypeDisplayName Method
GetPartitionInfo Method
GetPartitionInfos Method
GetProjectFolderPath Method
GetProjectList Method
GetProjectRoot Method
GetRuleSetByName Method
GetSystemFolder Method
GetSystemFolderId Method
GetTemplate Method
GetUser Method
GetUsers Method
GetVariableSetByName Method
ImportAsset Method
IsConnected Method
IsLoggedIn Method
LinearizeFlowSegment Method
LoadExportPreset Method
LocalizeString Method
LocalizeStringNoFormat Method
Login Method
Logout Method
MoveObject Method
MoveObjects Method
OpenProject Method
PublishProject Method
PublishProjectPartitions Method
RefactorVariableReferences Method
ReimportAsset Method
Repartition Method
RunQuery Method
RunQuery Method (String)
RunQuery Method (String, ObjectProxy)
SaveProject Method
SelectObject Method
ShowDialog Method
ShowMessageBox Method
ShowQueryBox Method
SimpleFindConflicts Method
SimpleFindObjects Method
StartJourneyOn Method
TemplatePresent Method
UnclaimAllMyPartitions Method
UnclaimPartition Method
UnclaimPartitions Method
UnclaimProject Method
UpdatePartition Method
UpdatePartitions Method
WaitForAssetProcessing Method
ApiSession.FocusPane Enumeration
ApiSession.FocusTab Enumeration
ApiSession.FocusWindow Enumeration
ArticyApiException Class
CloseProgressMode Enumeration
CloseProjectArgs Class
ComplexApiCallArgs Class
ContextMenuContext Enumeration
EntryType Enumeration
ErrorCode Enumeration
ExportDataArgs Class
ExportDocumentToDocxArgs Class
ExportObjectSelectionDataArgs Class
ExportTextFormat Enumeration
ExportToAccessArgs Class
ExportToDocxArgs Class
ExportToFullXmlArgs Class
ExportToXlsxArgs Class
ExportXlsxForReimportArgs Class
ExportXlsxForReimportArgs.SortObjectsBy Enumeration
FlowListNode Class
FlowReference Class
FlowReference.RefType Enumeration
GenericExportDataArgs Class
HierarchyAdjustment Enumeration
IsObjectAllowed Delegate
JourneyActionTypes Enumeration
JsonExportArgs Class
LoggingCallback Delegate
ObjectContext Enumeration
ObjectPropertyInfo Class
ObjectPropertyNames Class
ObjectProxy Class
ObjectType Enumeration
OpenProjectArgs Class
ProjectRightLevel Enumeration
ProjectUnavailabilityReason Enumeration
PropertyDataSubType Enumeration
PropertyDataType Enumeration
PropertyFilter Enumeration
RepartitionMode Enumeration
ResultSet Class
RuleSetBasedExport Class
SearchConflictsIn Enumeration
SearchTextIn Enumeration
SelectionContext Enumeration
SimplePartitionActionArgs Class
SystemFolderNames Enumeration
TextFilterRelation Enumeration
TextFormat Enumeration
Transformer Class
Transformer.AnchorPosition Enumeration
Transformer.TransformMode Enumeration
UnclaimPartitionArgs Class
Unity3DExportArgs Class
Unreal4ExportArgs Class
WaitForAssetProcessingArgs Class
Articy.Api.Data
Articy.Api.Plugins
Articy.Export.Office
Click or drag to resize

ApiSessionRunQuery Method (String, ObjectProxy)

Searches the opened project for articy objects.

Namespace:  Articy.Api
Assembly:  ArticyApp (in ArticyApp.dll) Version: 1.0.0
Syntax
C#
Copy
public ResultSet RunQuery(
	string aQuery,
	ObjectProxy aSelfReference
)

Parameters

aQuery
Type: SystemString
A string containing the query expression. See the "ArticyDraft API-Programmer's Guide.pdf" chapter 4 for details.
aSelfReference
Type: Articy.ApiObjectProxy
a Object that is used as SELF object reference in the query or the default null if not required/available

Return Value

Type: ResultSet
a ResultSet object containing one row for every found articy object
Remarks
If the API methods SimpleFindObjects(UInt64, String, TextFilterRelation, SearchTextIn, Boolean) and SimpleFindConflicts(UInt64, SearchConflictsIn) are not sufficient to find the required set of articy objects you need to use this method. RunQuery allows searching for a very specific subset of objects in the opened project using a powerful query language.
See Also