ObjectPropertyNames Class |
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
Inheritance HierarchyNamespace: Articy.Api
Assembly: PublicApiTypes (in PublicApiTypes.dll) Version: 1.0.0
SyntaxC#
public static class ObjectPropertyNames
The ObjectPropertyNames type exposes the following members.
Fields| Name | Description | |
|---|---|---|
  | AbsoluteFilePath |
the asset's qualified absolute file path including the currently used project folder. [string, read-only]
|
| AssetCategory |
The category of the asset. [Enum (int), read-only]
|
| AssetFilename |
The filename of the asset in the project dir. only contains the name [string, read-only]
deprecated use "Filename" instead
|
| AssetState |
The state of the asset (Ready, Importing, ...)
When using one the ApiSession.ImportAsset overloads you will discover state changes on the returned object
[enum (int), read-only, volatile]
|
| Attachments |
The name of the property containing the object's attachments.
This property can only be used with the object list management methods.
The list returned from GetAttachments is only a read-only list containing current objects. [IList<ObjectProxy>]
Check CanHaveAttachments to check whether an object has this property. (E.g. Pin or Connections do not have this property)
|
| AutoDisplayNamePosition |
Determines if the display name of an object should be positioned automatically. [boolean]
|
| BBCodeText |
The Text/Description/Spoken text element of most objects as bb markup text [string]
Check HasText to check whether an object has this property. (E.g. Pin or Connections do not have this property)
|
| BooleanValue |
A boolean evaluation of the default value. If the variable has integer type, 0 evaluates to false, any other to true
|
| Color |
The color of the object [System.Windows.Media.Color]
Check HasColor to check whether an object has this property. (E.g. Pin or Connections do not have this property)
|
| Content |
The content of a Note in the XML markup notation.
The XML conforms the ScratchpadDocument.xsd.
[string, read-only, XML markup]
|
| CreatedBy |
The name of the creator of the comment
[string, read-only]
|
| CreatedOn |
The timestamp of the creation of the comment in UTC time.
[DateTime, read-only]
|
| DataType |
The data type of a variable. [Enum (int), e.g. Integer, Boolean]
|
| DefaultValue |
the string representation of the default value of a variable
|
| Description |
The description of a variable. [string]
|
| DisplayName |
The display name as it can be seen in the navigator [string, non empty]
Check HasDisplayName to check whether an object has this property. (E.g. Connections do not have a DisplayName)
|
| DisplayNameColor |
The color of an object's display name. [System.Windows.Media.Color]
|
| DisplayNameColorForImage |
The color of an image's display name. [System.Windows.Media.Color]
|
| DisplayNameColorForLink |
The color of a link's display name. [System.Windows.Media.Color]
|
| DisplayNameColorForPath |
The color of a path's display name. [System.Windows.Media.Color]
|
| DisplayNameColorForSpot |
The color of a spot's display name. [System.Windows.Media.Color]
|
| DisplayNameColorForZone |
The color of a zone's display name. [System.Windows.Media.Color]
|
| DisplayNamePosX |
The X coordinate of a display name's position. [double]
|
| DisplayNamePosY |
The Y coordinate of a display name's position. [double]
|
| DisplayNameSize |
The size of an object's display name. [int]
|
| DisplayNameSizeForImage |
The size of an image's display name. [int]
|
| DisplayNameSizeForLink |
The size of a link's display name. [int]
|
| DisplayNameSizeForPath |
The size of a path's display name. [int]
|
| DisplayNameSizeForSpot |
The size of a spot's display name. [int]
|
| DisplayNameSizeForZone |
The size of a zone's display name. [int]
|
| DropShadow |
Determines if the drop shadow of an object's display name should be shown. [boolean]
|
| DropShadowForImage |
Determines if the display name drop shadow of an image should be shown. [boolean]
|
| DropShadowForLink |
Determines if the display name drop shadow of a link should be shown. [boolean]
|
| DropShadowForPath |
Determines if the display name drop shadow of a path should be shown. [boolean]
|
| DropShadowForSpot |
Determines if the display name drop shadow of a spot should be shown. [boolean]
|
| DropShadowForText |
Determines if a text's drop shadow should be shown. [boolean]
|
| DropShadowForZone |
Determines if the display name drop shadow of a zone should be shown. [boolean]
|
| EndCap |
Defines the ending element of a path.
[Enum (int), e.g. ColoredDot, None, LineArrowHead, FilledArrowHead, Diamond, Square, Disc]
|
| Expression |
A text field which is used as an expression.
|
| ExternalId |
The external Id as it can be found in the objects property sheet. [string]
|
| FileExtension |
The file's extension. [string, read-only]
|
| Filename |
The filename of the asset in the project dir. only contains the name [string, read-only]
|
| FilePath |
the asset's relative file path relative to the currently used project folder. [string, read-only]
|
| FileSize |
The size of the asset on disk. [long, read-only]
|
| FileType |
The file type as reported by the shell. [string, read-only]
|
| FillColor |
The fill color of an object. [System.Windows.Media.Color]
|
| ForcedHeight |
Determines the fixed height of a location text object. [double]
|
| ForcedWidth |
Determines the fixed width of a location text object. [double]
|
| ForObjectType |
This property contains the type of object that is required to assign a given template to
[Enum (int), read-only of type "ObjectType"]
|
| Height |
the Height of a flow-item.
|
| Id |
The Id of an asset. [ulong, read-only]
|
| IdxInJourney |
The index this journey point has in the list of points in the Journey
[int, read-only]
|
| ImageAsset |
The asset of a location image. [ObjectProxy]
|
| ImageHeight |
If the asset contains an image this property holds the height of that image, for all others it is reported as 0. [int, read-only]
|
| ImageOpacity |
The opacity of a location image. [double, 0.0 - 1.0]
|
| ImageWidth |
If the asset contains an image this property holds the width of that image, for all others it is reported as 0. [int, read-only]
|
| JourneyPoints |
a read-only list of JouneyPoint objects.
[IList<ObjectProxy>, read-only]
|
| JourneyPointType |
The type of this point in the journey.
[Enum (int), read-only]
|
| JourneyState |
the state of the journey
[Enum (int)]
|
| Label |
The label text for the connection [string]
|
| LineWidth |
Defines the line thickness of a path. [double]
|
| LinkStyleSize |
Determines the style size for a link.
[Enum (int), e.g. Inherited, Large, Medium, Small]
|
| LinkStyleType |
Determines the style type for a link.
[Enum (int), e.g. Inherited, PreviewImage, IconOnly, Minimal]
|
| MarkupText |
The Text/Description/Spoken text element of most objects including all markup [string]
Check HasText to check whether an object has this property. (E.g. Pin or Connections do not have this property)
|
| MenuText |
the preview/menu text of the dialog fragment.
[string]
|
| Namespaces |
a read-only list of Journey namespaces.
[IList<ObjectProxy>, read-only]
|
| NumericValue |
A numeric (double) evaluation of the default value. If the variable has boolean type, false evaluates to 0.0, true to 1.0
|
| ObjectReference |
describes which object is referenced by this journey point.
When "JourneyPointType" is one of "InputPinSelection", "OutputPinSelection" or "Pin",
the referenced object is a pin (whose parent is the owning object) otherwise its an
"normal" flow object.
[ObjectProxy, read-only]
|
| ObjectType |
The objects type name [enum, non empty]
|
| OriginalSource |
The full filename of the location this asset was initially imported. [string, read-only]
|
| OutlineColor |
The outline color of an object. [System.Windows.Media.Color]
|
| OutlineSize |
The outline size of an object. [double]
|
| OutlineStyle |
The outline style of an object.
[Enum (int), e.g. Solid, Dot, Dash, DashDot, DashDotDot]
|
| Parent |
The object reference to the objects parent or null when object has no parent (like the project's root object).
Connections are rooted in the container that also contain the other flow objects.
The parent of a Pin object is the flow object it is connected to
|
| PartitionGuid |
The Guid (as string) of the partition the object resides in (AD > 3.1.3)
|
| PinIndex |
The index of the pin in a top down order as it is connected to an element of the flow.
[int, read-only]
|
| PinType |
The type of the pin. [Enum (int) e.g. Invalid, Input, Output]
|
| PosX |
X position of a flow-item.
|
| PosY |
Y position of a flow-item.
|
| PreviewImageAsset |
some objects like zones or locations offer a preview image, you can set it using this parameter. [ObjectProxy, only Assets of type Image]
Check HasPreviewImage to check whether an object has this property. (E.g. Pin or Connections do not have this property)
|
| ReachedByActionType |
describes by what action this journey point was reached
[Enum (int), read-only]
|
| ScriptingName |
The scripting name of an object. [string]
|
| Selectability |
Determines if an object is selectable.
[Enum (int), e.g. Unselectable, Selectable]
|
| ShapeType |
The type of a zone.
[Enum (int) e.g. Invalid, Spot, Circle, Rectangle, Path, Polygon, Link ]
|
| ShortId |
The short/articy:access Id as it can be found in the objects property sheet. [int]
Write with care to keep these Ids unique.
|
| ShowCalculatedDisplayName |
Determines if the calculated display name of an object should be shown. [boolean]
|
| ShowDisplayName |
Determines if the display name of an object should be shown. [boolean]
|
| ShowDisplayNameForImage |
Determines if the display name of an image should be shown. [boolean]
|
| ShowDisplayNameForLink |
Determines if the display name of a link should be shown. [boolean]
|
| ShowDisplayNameForPath |
Determines if the display name of a path should be shown. [boolean]
|
| ShowDisplayNameForSpot |
Determines if the display name of a spot should be shown. [boolean]
|
| ShowDisplayNameForZone |
Determines if the display name of a zone should be shown. [boolean]
|
| ShowLabel |
Determines if the label should be shown [boolean]
|
| Source |
The source object of the connection [ObjectProxy, read-only]
|
| SourcePin |
The Pin object of the referenced source object of the connection [ObjectProxy, read-only]
|
| Speaker |
the speaking entity of the dialog fragment.
[ObjectProxy, "Entity" objects only]
|
| SpotStyleSize |
Determines the style type for a link.
[Enum (int), e.g. Inherited, Large, Medium, Small]
|
| SpotStyleType |
Determines the style type for a spot.
[Enum (int), e.g. Inherited, Flag, Cross]
|
| StageDirections |
the stage directions of a dialog fragment
[string]
|
| StartCap |
Defines the starting element of a path.
[Enum (int), e.g. ColoredDot, None, LineArrowHead, FilledArrowHead, Diamond, Square, Disc]
|
| StringValue |
A text (string) evaluation of the default value. A number will be tried to be represented as a string.
|
| Target |
The target object of a connection.
[ObjectProxy, read-only]
|
| TargetPin |
The Pin object of the referenced target object of the connection.
[ObjectProxy, read-only]
|
| TechnicalName |
The TechnicalName as it can be found in the objects property sheet [string, valid identifier names only]
Check HasTechnicalName to check whether an object has this property. (E.g. SystemFolder objects like "Entities" do not have technical names)
|
| TemplateName |
The technical name of an objects template or an empty string if not template was set [string]
|
| Text |
The Text/Description/Spoken text element of most objects [string]
Check HasText to check whether an object has this property. (E.g. Pin or Connections do not have this property)
|
| TransformPivotX |
The X coordinate of a transforms pivot position. [double]
|
| TransformPivotY |
The Y coordinate of a transforms pivot position. [double]
|
| TransformRotation |
The value of a transforms rotation in degrees. [double]
|
| TransformXAxisX |
The X value of a transforms X-Axis vector. [double]
|
| TransformXAxisY |
The Y value of a transforms X-Axis vector. [double]
|
| TransformYAxisX |
The X value of a transforms Y-Axis vector. [double]
|
| TransformYAxisY |
The Y value of a transforms Y-Axis vector. [double]
|
| Url |
the articy:// protocol Url of the object
|
| Variables |
A read-only list of the variables of a variable set.
[IList<ObjectProxy>, read-only]
|
| Visibility |
Determines if an object is visible.
[Enum (int), e.g. Invisible, Visible]
|
| Width |
the width of a flow-item.
|
| ZIndex |
the z-index of a flow-item
|
See Also