The Object Properties column, shown in the Build Dynamo with User Prompts dialog box, displays the objects that comprise the Dynamo object and their animated properties. The basic format for an Object Property is shown below:
Object Name.Property
Where Object Name is the name of the object that is animated, and Property is the property of the object that is animated.
You may also have some animated object properties that reside within groups. In this case, the object property displays as shown below:
Group Name.Object Name.Property
The following tables describe the properties of objects that you can animate. These properties are all viewed on the Advanced Animations dialog box.
Visible Tab
|
Property |
Description |
Objects |
|
Visibility |
Specifies whether or not a shape appears on the screen. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline, Text, Datalink, Chart, Bitmap |
Size Tab
|
Property |
Description |
Objects |
|
Height |
The number of logical units or postscript points occupied by the shape in the vertical direction. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline, Text, Datalink, Chart, Bitmap |
|
Width
|
The number of logical units or postscript points occupied by the shape in the horizontal direction. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline, Text, Datalink, Chart, Bitmap |
|
HorizontalScalePercentage |
The ratio of the current shape width to its original width. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline, Text, Datalink, Chart, Bitmap |
|
VerticalScalePercentage |
The ratio of the current shape height to its original height. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline, Text, Datalink, Chart, Bitmap |
|
HorizontalScaleDirection |
Specifies whether the left or right side of the shape will expand or contract when the horizontal scale percentage is changed. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline, Text, Datalink, Chart, Bitmap |
|
VerticalScaleDirection |
Specifies whether the top or bottom side of the shape will expand or contract when the vertical scale percentage is changed. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline, Text, Datalink, Chart, Bitmap |
|
UniformScale |
Specifies whether or not a shape scales horizontally and vertically by the same amount. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline, Text, Datalink, Chart, Bitmap |
Misc Tab
|
Property |
Description |
Objects |
|
Layer |
The layer of the shape. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline, Text, Command Button, Datalink, Chart |
|
StartX |
Specifies the X coordinate starting point of the line. |
Chord, Pie, Arc, Line |
|
StartY |
Specifies the Y coordinate starting point of the line. |
Chord, Pie, Arc, Line |
|
EndX |
The horizontal location (in logical units or postscript points) of the last point in the shape. |
Chord, Pie, Arc, Line |
|
EndY |
The vertical location (in logical units or postscript points) of the last point in the shape. |
Chord, Pie, Arc, Line |
|
StartAngle |
The angle that starts the sweep of the pie. |
Pie |
|
EndAngle |
The angle that ends the sweep of the pie. |
Pie |
|
Radius |
The current radius of the pie. |
Pie |
|
Pie Type |
Specifies whether the pie is limited to less than 180 degrees of arc. |
Pie |
|
MousePointer |
Specifies the mouse pointer to display in run mode. |
Command Button |
|
Accelerator |
Specifies the accelerator to use in run mode. |
Command Button |
|
Name |
Specifies the name of the object. |
Command Button, Alarm Summary |
|
IsSelectable |
Controls whether the object can be selected in run mode. |
Command Button, Alarm Summary |
|
Description |
A user defined description of this object's function. |
Command Button, Alarm Summary |
|
ContextID |
The user-defined context ID for the user's context sensitive help file. |
Command Button, Alarm Summary |
|
Visible |
Specifies whether or not a shape appears on the screen. |
Command Button, Alarm Summary |
|
Height |
The number of logical units or postscript points occupied by the shape in the vertical direction. |
Command Button, Alarm Summary |
|
Width |
The number of logical units or postscript points occupied by the shape in the horizontal direction. |
Command Button, Alarm Summary |
|
HorizontalPosition |
The shape's distance (in logical units or postscript points) from the left side of the picture. |
Command Button, Alarm Summary |
|
VerticalPosition |
The shape's distance (in logical units or postscript points) from the top of the picture. |
Command Button, Alarm Summary |
|
HorizontalScalePercentage |
The ratio of the current shape width to its original width. |
Command Button, Alarm Summary |
|
VerticalScalePercentage |
The ratio of the current shape height to its original height. |
Command Button, Alarm Summary |
|
HorizontalScaleDirection |
Specifies whether the left or right side of the shape will expand or contract when the horizontal scale percentage is changed. |
Command Button, Alarm Summary |
|
VerticalScaleDirection |
Specifies whether the top or bottom side of the shape will expand or contract when the vertical scale percentage is changed. |
Command Button, Alarm Summary |
|
UniformScale |
Specifies whether or not a shape scales horizontally and vertically by the same amount. |
Command Button, Alarm Summary |
|
EnableTooltips |
Specifies whether a shape's tooltips are shown. |
Command Button, Alarm Summary |
|
ControlOrderIndex |
The order in which this object will be selected via the up and down arrow keys. |
Command Button, Alarm Summary |
|
HighlightEnabled |
Indicates that the button should have a highlight rectangle drawn around it when the mouse passes over it in run mode. |
Command Button, Alarm Summary |
|
Default |
Specifies whether the button is the default button on the picture. |
Command Button, Alarm Summary |
|
Cancel |
Specifies the ability of the button to accept the cancel event on the picture. |
Command Button, Alarm Summary |
|
EnableAlarmAcknowledge |
Specifies whether or not alarm acknowledgement is enabled. |
Alarm Summary |
|
EnableAlarmDeletion |
Specifies whether or not alarm deletion is enabled. |
Alarm Summary |
|
EnableColumnQuickSort |
Specifies whether or not column quick sort is enabled. |
Alarm Summary |
|
FilterString |
Specifies the filter string. |
Alarm Summary |
|
ShowHeaders |
Specifies whether or not to display the column headers. |
Alarm Summary |
|
ShowRowNumbers |
Specifies whether or not to display row numbers. |
Alarm Summary |
|
UseUnacknowledgeAlarmColor |
Specifies whether or not to display a color for unacknowledged alarms. |
Alarm Summary |
|
ShowScrollBars |
Specifies whether or not to display scroll bars. |
Alarm Summary |
|
SortColumnName |
Specifies the column name to sort by. |
Alarm Summary |
|
SortOrderDescending |
Specifies whether or not the descending sort type is enabled. |
Alarm Summary |
|
AlarmUserdefField1 |
Specifies the User Defined Field 1 property. |
Alarm Summary |
|
AlarmUserdefField2 |
Specifies the User Defined Field 2 property. |
Alarm Summary |
|
EnableRightMouseClick |
Specifies whether or not the right mouse menu is enabled. |
Alarm Summary |
|
BlinkEnabled |
Specifies whether or not the blink property is enabled. |
Alarm Summary |
|
ShowGridLines |
Specifies whether or not the grid lines are displayed. |
Alarm Summary |
|
UnacknowledgedAlarmColor |
Specifies the color to display for unacknowledged alarms. |
Alarm Summary |
|
EnableRunTimeConfiguration |
Specifies whether or not run-time configuration is enabled. |
Alarm Summary |
|
UpdateOnPropChange |
Specifies whether or not to update when property values change. |
Alarm Summary |
|
ShowStatusBar |
Specifies whether or not the status bar is displayed. |
Alarm Summary |
|
AlarmRefreshInterval |
Specifies the alarm refresh interval in seconds. |
Alarm Summary |
|
BlinkRate |
Specifies the rate, in seconds, at which blinking occurs. |
Alarm Summary |
|
SelectionTimeout |
Specifies the length of time, in seconds, that a row remains selected. |
Alarm Summary |
|
StatusFontSize |
Specifies the font size of the alarm status text. |
Alarm Summary |
|
PauseIndicatorBlink |
Specifies whether or not the pause status color blinks. |
Alarm Summary |
|
PauseIndicatorColor |
Specifies the color of the pause status. |
Alarm Summary |
|
PauseWithNewAlarmIndicatorBlink |
Specifies whether or not the pause alarm status color blinks. |
Alarm Summary |
|
PauseWithNewAlarmIndicatorColor |
Specifies the color of the pause alarm status. |
Alarm Summary |
|
RunIndicatorBlink |
Specifies whether or not the run status color blinks. |
Alarm Summary |
|
RunIndicatorColor |
Specifies the color of the run status. |
Alarm Summary |
|
UserDef1ColumnName |
Specifies the name of the User Defined Field 1 property. |
Alarm Summary |
|
UserDef2ColumnName |
Specifies the name of the User Defined Field 2 property. |
Alarm Summary |
|
BackgroundColor |
Specifies the background alarm color. |
Alarm Summary |
|
AlarmHornEnabled |
Specifies whether or not the alarm horn is enabled. |
Alarm Summary |
|
VisibleUnacknowledgedAlarms |
Specifies whether or not unacknowledged alarms are displayed. |
Alarm Summary |
|
TotalFilteredAlarms |
Specifies the total number of filtered alarms. |
Alarm Summary |
|
CheckForNewAlarms |
Specifies whether or not to check for new alarms. |
Alarm Summary |
|
TopVisibleRow |
Specifies the number of top rows that are visible. |
Alarm Summary |
|
BottomVisibleRow |
Specifies the number of bottom rows that are visible. |
Alarm Summary |
|
CheckForAlarmListChanged |
Specifies whether or not to check if the alarm list has changed. |
Alarm Summary |
|
EnableAcknowledgeAll |
Specifies whether or not the Allow Acknowledge All Alarms property is enabled. |
Alarm Summary |
|
CurrentImage |
Specifies the index of the image currently displayed. |
Bitmap |
|
ApplyProperties |
Specifies how the properties are applied to the list of images. |
Bitmap |
|
ButtonStyle |
Specifies the button behavior of the bitmap. |
Bitmap |
|
ButtonState |
Specifies the state of a multi-state button. |
Bitmap |
|
SecondaryImageDisplayed |
Specifies whether or not a secondary image at the current index is being displayed as the primary (or mouse-up) image. |
Bitmap |
|
DownImageDisplayed |
Specifies whether or not the secondary image is to be displayed on a mouse down. |
Bitmap |
|
Transparency |
Specifies whether or not a bitmap can effectively have a bleed-through area that can be used for animation and visualization. |
Bitmap |
Position Tab
|
Property |
Description |
Objects |
|
HorizontalPosition |
The shape's distance (in logical units or postscript points) from the left side of the picture. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline, Text, Datalink, Chart, Bitmap |
|
VerticalPosition |
The shape's distance (in logical units or postscript points) from the top of the picture. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline, Text, Datalink, Chart, Bitmap |
Color Tab
|
Property |
Description |
Objects |
|
ForegroundColor |
The color used to fill the interior of the shape. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Text, Datalink, Chart |
|
BackgroundColor |
The color used to fill in the interior of the shape. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Text, Datalink, Chart, Bitmap |
|
EdgeColor |
The color used to outline the shape. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline, Text, Datalink, Chart |
|
ForegroundEdgeColor |
The foreground edge color of a shape. |
Chart |
|
BackgroundEdgeColor |
The background edge color of a shape. |
Chart |
|
HorizontalGridColor |
The color of the horizontal grid lines. |
Chart |
|
VerticalGridColor |
The color of the vertical grid lines. |
Chart |
|
TransparentColor |
The transparent color of the bitmap. |
Bitmap |
Style Tab
|
Property |
Description |
Objects |
|
FillStyle |
The pattern used to fill the interior of the shape. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Text, Datalink, Chart |
|
BackgroundStyle |
Specifies whether the fill style is either a "visible" or "see through" background. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline, Text, Datalink, Bitmap |
|
EdgeStyle |
The pattern used to outline the object. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline, Text, Datalink, Chart, Bitmap |
|
EdgeWidth |
The width (in pixels) of the object's outline. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline, Text, Datalink, Chart |
|
RoundnessX |
Specifies the horizontal roundness of the rounded rectangle. |
Rounded Rectangle |
|
RoundnessY |
Specifies the vertical roundness of the rounded rectangle. |
Rounded Rectangle |
|
Thickness |
Specifies the thickness (in pixels) of the pipe object. |
Pipe |
|
StartCap |
Specifies the style to use for the start cap of the pipe object. |
Pipe |
|
EndCap |
Specifies the style to use for the end cap of the pipe object. |
Pipe |
|
ElbowStyle |
Specifies the style to use for the elbow of the pipe object. |
Pipe |
|
FontSize |
Specifies the font size used to display text. |
Chart |
|
FontName |
Specifies the font family used to display text. |
Chart |
|
FontStyle |
Specifies the style of font used to display text. |
Chart |
|
Transparent |
Specifies whether or not the chart is transparent. |
Chart |
|
MultipleEGU |
Specifies whether or not the chart displays multiple EGUs. |
Chart |
|
MultipleTimes |
Specifies whether or not the chart displays multiple times. |
Chart |
|
ShowLegend |
Show/hides the chart legend. |
Chart |
|
ShowTimeAxis |
Specifies whether or not to display the time axis. |
Chart |
|
ShowValueAxis |
Specifies whether or not to display the value axis. |
Chart |
|
ShowTimeCursor |
Specifies whether or not to display the time cursor. |
Chart |
|
BackgroundEdgeStyle |
Specifies the background edge style of the shape. |
Chart |
|
ForegroundEdgeStyle |
Specifies the foreground edge style of the shape. |
Chart |
|
ForegroundEdgeWidth |
Specifies the width of the shape's foreground border. |
Chart |
|
BackgroundEdgeWidth |
Specifies the width of the shape's background border. |
Chart |
|
ShowTimecursorToolTips |
Specifies whether to show the time cursor tool tips. |
Chart |
|
TimeCursorColor |
Specifies the time cursor color. |
Chart |
|
ShowHorizontalGrid |
Shows/hides the horizontal grid lines. |
Chart |
|
ShowVerticalGrid |
Shows/hides the vertical grid lines. |
Chart |
|
HorizontalGridStyle |
Specifies the style of the horizontal grid lines. |
Chart |
|
VerticalGridStyle |
Specifies the style of the vertical grid lines. |
Chart |
|
GridWidth |
Specifies the width of the grid lines. |
Chart |
|
NumberOfHorizontalGridLines |
Specifies the number of horizontal grid lines. |
Chart |
|
NumberOfVerticalGridLines |
Specifies the number of vertical grid lines. |
Chart |
|
ShowDate |
Specifies whether or not to show the date. |
Chart |
|
TimeAxisTitle |
Specifies the title of the time axis. |
Chart |
|
ValueAxisTitle |
Specifies the title of the value axis. |
Chart |
|
TimeAxisNumTicks |
Specifies the number of ticks on the time axis. |
Chart |
|
TimeAxisNumLabels |
Specifies the number of labels on the time axis. |
Chart |
|
ValueAxisNumTicks |
Specifies the number of ticks on the value axis. |
Chart |
|
ValueAxisNumLabels |
Specifies the number of labels on the value axis. |
Chart |
|
ShowTimeAxisTitle |
Specifies whether or not to show the time axis title. |
Chart |
|
ShowValueAxisTitle |
Specifies whether or not to show the value axis title. |
Chart |
Rotate Tab
|
Property |
Description |
Objects |
|
RotationAngle |
The angle (in radians or degrees) by which the shape has been rotated since its creation. |
Rectangle, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline |
|
AngleUnits |
Specifies whether the angles are measured in degrees or radians. |
Rectangle, Chord, Polygon, Pie, Pipe, Arc, Line, Polyline |
Text Tab
|
Property |
Description |
Objects |
|
Caption |
Specifies the displayed text. |
Time, Date, Text, Datalink |
|
FontName |
Specifies the font family used to display text. |
Time, Date, Text, Datalink |
|
FontSize |
Specifies the font size used to display text. |
Time, Date, Text, Datalink |
|
FontStyle |
Specifies the font style used to display text. |
Time, Date, Text, Datatlink |
Behavior Tab
|
Property |
Description |
Objects |
|
AutoSize |
Controls whether the text object automatically picks a new font that will fit into the bounding rectangle as the caption changes. |
Time, Date, Text, Command Button, Datalink |
|
ScalesWidth |
Specifies whether the width of the text or datalink object can be changed. |
Time, Date, Text, Datalink |
|
MaxLines |
Specifies the maximum number of text lines allowed. |
Time, Date, Text, Datalink |
|
MaxCharactersPerLine |
Specifies the maximum number of characters allowed per line. |
Time, Date, Text, Datatlink |
|
Alignment |
Specifies the alignment of the text string within the text's bounding rectangle. |
Datalink |
|
StrikeThrough |
Specifies whether the text has a strike through it. |
Time, Date, Text, Datalink |
|
Enabled |
Specifies whether or not the command button is enabled. |
Command Button |
|
Locked |
Specifies whether or not the command button is locked. |
Command Button |
|
WordWrap |
Specifies whether or not the text displayed on the command button wraps. |
Command Button |
|
RefreshRate |
Specifies the refresh rate of the chart. |
Chart |
|
CurrentPen |
Specifies the current pen. |
Chart |
|
Timeout |
Specifies the amount of time to pause for. |
Chart |
|
ScrollDirection |
Specifies the direction to scroll. |
Chart |
|
ResetPercentage |
Specifies the chart's reset percentage. |
Chart |
|
ScrollPercentage |
Specifies the chart's scroll percentage. |
Chart |
|
ZoomDirection |
Specifies the direction in which to zoom. |
Chart |
|
StartDateMode |
Specifies the start date mode. |
Chart |
|
DaysBeforeNow |
Specifies the number of days before now that will be included in the chart. |
Chart |
|
StartTimeMode |
Specifies the start time mode. |
Chart |
|
TimeBeforeNow |
Specifies the amount of time before now to use in the chart. |
Chart |
|
Duration |
Specifies the time duration. |
Chart |
|
Interval |
Specifies the length of time between intervals. |
Chart |
|
ScrollGrid |
Specifies the scroll grid mode. |
Chart |
|
TimeZoneBiasExplicit |
Specifies the explicit time zone bias. |
Chart |
|
TimeZoneBiasRelative |
Specifies the relative time zone bias. |
Chart |
|
DaylightSavingsTime |
Specifies whether to use Daylight Savings Time when displaying data. |
Chart |
|
LockStartTime |
Specifies whether or not to lock the start time. |
Chart |
|
IntervalMilliseconds |
Specifies the millisecond component of the interval. |
Chart |
|
AutoUpdateRate |
Specifies the auto-update rate. |
Chart |
|
DisplayMilliseconds |
Specifies whether or not to display milliseconds. |
Chart |
Gradient Tab
|
Property |
Description |
Objects |
|
FadeColor |
Specifies the fade color used for the gradient fill. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Text, Datalink, Chart |
|
FadeType |
Specifies the fade type used for the gradient fill. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Text, Datalink, Chart |
|
GradientAngle |
Specifies the angle of the shape's gradient fill. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Text, Datalink, Chart |
|
Blend |
Specifies the blend percentage used for the gradient fill. |
Time, Date, Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Text, Datalink, Chart |
Fill Tab
|
Property |
Description |
Objects |
|
HorizontalFillPercentage |
The percentage of the shape's interior that will be filled horizontally with color and pattern, starting at the location identified by the HorizontalFillDirection. |
Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Bitmap |
|
VerticalFillPercentage |
The percentage of the shape's interior that will be filled vertically with color and pattern, starting at the location identified by the VerticalFillDirection. |
Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Bitmap |
|
HorizontalFillDirection |
Specifies the direction of a shape's horizontal fill. |
Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Bitmap |
|
VerticalFillDirection |
Specifies the direction of a shape's vertical fill. |
Rectangle, Rounded Rectangle, Oval, Chord, Polygon, Pie, Pipe, Bitmap |
Appearance Tab
|
Property |
Description |
Objects |
|
BackColor |
Specifies the background color of the command button. |
Command Button |
|
BackStyle |
Specifies the background style of the command button. |
Command Button |
|
Caption |
Specifies the text to be displayed on the command button. |
Command Button |
|
ForeColor |
Specifies the foreground color of the command button. |
Command Button |
Picture Tab
|
Property |
Description |
Objects |
|
PicturePosition |
Specifies the position of the picture. |
Command Button |
Variable Tab
|
Property |
Description |
Objects |
|
VariableType |
Specifies the variable type. |
Local Variable |
|
InitialValue |
Specifies the initial value of the variable. |
Local Variable |
|
CurrentValue |
Specifies the current value of the variable. |
Local Variable |
|
Source |
Specifies the source string for an animation. |
Global Variable |
|
GlobalToggle |
The source of data for triggering a "GlobalOutputToggle" setting that will alternate with the actual setting from the lookup table. |
Global Variable |
|
ToggleSource |
Specifies the data source or expression used to determine if the output of the Lookup object should toggle between output1 and output2. |
Global Variable |
