ObjectProxy Class
Represents one articy:draft object like it is shown in the articy:draft GUI.
Definition
Namespace: Articy.Api
Assembly: QueryLayer (in QueryLayer.dll) Version: 1.0.0
Assembly: QueryLayer (in QueryLayer.dll) Version: 1.0.0
C#
public class ObjectProxy : IEquatable<ObjectProxy>- Inheritance
- Object ObjectProxy
- Implements
- IEquatableObjectProxy
Remarks
This is the most important data class of the articy:draft API. It encapsulates one single articy object regardless of its actual type.
All object getting methods of the API return either an instance of this class (or a list of such instances) or an ID. Use
the members of this class to learn about what actual type of object is encapsulated or to read or even change the properties of the object.
Properties
| CanBePartitioned | Returns true if this object is a togglable partition (can be created or retired). Will return false in case of system folders as those are always a partition and cannot be retired. |
| CanHaveAttachments | All articy object types that can receive attachments inside a reference strip return true. |
| CanHaveChildren | true for all object types that can have children as visible in the articy:draft navigator tree, otherwise false |
| HasColor | true if the object has the "Color" property, otherwise false |
| HasDisplayName | true for all articy objects that have a display name, otherwise false |
| HasExternalId | true if the object has the "ExternalId" property, otherwise false |
| HasPreviewImage | true if the tiles view of the articy:draft GUI displays this object with an preview image, otherweise false |
| HasShortId | true if the object has the "ShortId" property, otherwise false |
| HasTechnicalName | true for all articy objects, that have a technical name |
| HasText | true if the object has the "Text" property, otherwise false |
| HoldsPartition | Returns true if the object is used as a partition root. |
| Id | the ID of this object |
| IsClaimed | checks if an object is claimed (Always true when working in Single-User projects |
| IsConnectable | true for all object types that can be displayed (and therefore connected) in the articy:draft flow editor (flow fragments, dialogs, dialogue fragments, jumps and hubs), false for all other types of objects |
| IsCustomizable | true if this kind of object can have a template assigned, false otherwise |
| IsDisplayNameCalculated | true if the display name is calculated using the values of other properties and therefore is read-only, otherwise false |
| IsFolder | User folders and system folders return true all other articy object types return false. |
| IsReadOnly | Determines if the object can be written. |
| IsSystemFolder | System folders return true all other articy object types return false. |
| IsUserFolder | User folders return true all other articy object types return false. |
| IsValid | true if the object is a valid object with all properties and functionalities, false if it is a so-called 'broken reference' |
| ItemInt32 | This indexer returns the property with the specified column index. |
| ItemString | This indexer returns the property with the specified property/column name. |
| ObjectType | This property tells, what type the encapsulated articy object really is. |
| TypeName | An untyped string that describes the object type. See ObjectType for details. |
Methods
| AddAttachmentToStrip | Adds an attachment to a reference strip of the object. |
| AddInputPin | Adds a new input pin the the object, if it is "connectable" and the count did not have reached its limit. |
| AddOutputPin | Adds a new output pin the the object, if it is "connectable" and the count did not have reached its limit. |
| ClearLocalTemplateProperty | Clears the local value of a template property, it is the same operation as in the ui the small revert button next to any template property. |
| ClearStrip | Removes all attachments from the specified reference strip. |
| Equals(Object) | (Overrides ObjectEquals(Object)) |
| Equals(ObjectProxy) | |
| ExtendedGetProperty | |
| FindIndex | Returns the column index of an attachment inside a certain reference strip. |
| GetAllowedChildrenTypes | Returns a HashSet containing all ObjectTypes that can appear as direct children of the given object |
| GetAttachments | Returns a list ob ObjectProxy objects, each representing an attachment as can be seen in the articy:draft reference strip of the respective object. |
| GetAvailableProperties | Returns a list of all property names (type string), this object contains. |
| GetAvailableProperties(PropertyFilter) | Returns a list of all property names (type string), this object contains. |
| GetChildren | Returns a list ob ObjectProxy objects, each representing a child as can be seen in the articy:draft navigator tree. |
| GetColor | Returns the object's "Color" property to the specified value. |
| GetColumnIndex | Returns the column index of a property with the specified name. |
| GetDataType | Returns the data type of the property with the specified name. |
| GetDisplayName | Returns the name the object is typically displayed with in the articy:draft GUI (navigator, tiles/list view). |
| GetExternalId | Returns the object's property "ExternalId". |
| GetFlowPosition | Gets the current position of a flow-item object |
| GetFlowSize | Gets the size of a flow flow-item object |
| GetHashCode | (Overrides ObjectGetHashCode) |
| GetInputPin | returns the input pin with the given index |
| GetInputPins | Returns a list of ObjectProxy objects, each representing an input pin. |
| GetObjectContext | Gets the context is which this object appears |
| GetObjectUrl | Gets the Url of the object |
| GetOutputPin | returns the output pin with the given index |
| GetOutputPins | Returns a list of ObjectProxy objects, each representing an output pin. |
| GetParent | Returns an ObjectProxy object representing the direct parent in the object tree as displayed in the articy:draft navigator. |
| GetPartitionId | Returns the Guid of the partition, this object belongs to. |
| GetPreviewImage | Returns the asset that is set as preview image for this object. |
| GetPropertyInfo | Queries for extended property infos. |
| GetReadOnlyMode | |
| GetShortId | Returns the object's property "ShortId". |
| GetSortedChildren | |
| GetStripElements | Helper method to request a list of ObjectProxy objects for a property that is a list type. |
| GetStripIds | Helper method to request a set of object Ids for a given list property |
| GetStripMap | Helper method to request a dictionary of objects keyed by their Id for a given list property |
| GetTechnicalName | Returns the technical name of the object. |
| GetTemplateId | Returns the template that is set for this object. |
| GetTemplateTechnicalName | Returns the technical name of the template that was assigned to this object. |
| GetText(String) | Returns the object's property "Text". |
| GetText(TextFormat, String) | Returns the object's property "Text" in the given format (Plain, HTML or BBCode) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| HasProperty | Checks if the object contains a property with the specified name. |
| InsertAttachmentIntoStrip | Inserts the specified attachment into the specified reference strip |
| IsInContext | Method to check if a given object appears in the given context |
| IsInDocumentContext | Checks if the given object resides in a hierarchy under a Document object |
| IsInFlowContext | Checks if the given object resides in the flow |
| IsInLocationContext | Checks if the given object resides in a hierarchy under a Location object |
| IsValidExpressoScript(String) | Checks if the given string is a valid value for the property "Expression" of the object |
| IsValidExpressoScript(String, String) | Checks if the given string is a valid value for the named property (either object or feature property name) of the object |
| MayAddAttachmentToStrip | Checks if an attachment is allowed to be added to a reference strip of the object. |
| MayInsertAttachmentIntoStrip | Checks if the specified attachment is allowed to by inserted into the specified reference strip |
| MaySetObjectReference | A helper method to check if a given object can be assigned to the object slot with the given property name |
| RemoveAttachmentFromStrip | Removes the specified attachment from the specified reference strip. |
| RemoveAttachmentFromStripAtIndex | Removes the specified attachment from the specified reference strip. |
| RemoveInputPin | Removes the given input pin of the, if it is "connectable", the index is in range the pin is not the last one. |
| RemoveOutputPin | Removes the given output pin of the, if it is "connectable", the index is in range the pin is not the last one. |
| RunQuery | Searches the opened project for articy objects. The object on which this query is executed can be referenced by the "self" query keyword |
| SetColor | Sets the object's "Color" property to the specified value. |
| SetDisplayName | Sets the display name of the object to the specified value. |
| SetExternalId | Sets the object's "ExternalId" property to the specified value. |
| SetFlowPosition(Point) | Sets the current position of a flow-item object |
| SetFlowPosition(Double, Double) | Sets the current position of a flow-item object |
| SetFlowSize(Size) | Sets the size of a flow-item object. The given size if coerces to obey min/max size values for an object |
| SetFlowSize(Double, Double) | Sets the size of a flow-item object. The given size if coerces to obey min/max size values for an object |
| SetPreviewImage | Sets the preview image of this object to the specified value. |
| SetShortId | Sets the object's "ShortId" property to the specified value. |
| SetTechnicalName | Sets the technical name of the object to the specified value. |
| SetTemplate(String, Boolean) | Sets a new template for this object. |
| SetTemplate(UInt64, Boolean) | Sets a new template for this object. |
| SetText(String) | Sets the value of the property with the name "Text". |
| SetText(String, TextFormat, String) | Sets the property "Text" from a string that has the given TextFormat |
| ToString | (Overrides ObjectToString) |
| TryGetValueTValue | Tries to find a value described by the property info |
| ValidateExpressoScript(String) | Checks if the given string is a valid value for the property "Expression" of the object. |
| ValidateExpressoScript(String, String) | Checks if the given string is a valid value for the named property (either object or feature property name) of the object |
Operators
Extension Methods
| Exists | (Defined by ObjectProxyExtensions) |
| GetIncomingConnections |
Get a list of incoming connections for a given Pin
(Defined by ObjectProxyExtensions) |
| GetObjectIcon | (Defined by ObjectProxyExtensions) |
| GetObjectPath | (Defined by ObjectProxyExtensions) |
| GetOutgoingConnections |
Get a list of outgoing connections for a given Pin
(Defined by ObjectProxyExtensions) |
| HasFeature |
Returns if the object has a template or is a template, with the matching feature technical name
(Defined by ObjectProxyExtensions) |
| HasModelCustomizationProperty |
Checks if this template or feature has the given property defined.
(Defined by ObjectProxyExtensions) |
| TraceError | (Defined by TraceHelper) |
| TraceInfo | (Defined by TraceHelper) |
| TraceWarning | (Defined by TraceHelper) |