StGetPropertyMm

Syntax

StGetPropertyMm(property);

property

The dimensional property to retrieve the value for. For available properties, see the table below. Note: Property keys are case sensitive! Note: To retrieve a non-dimensional property, use StGetProperty.

 

Property	Description
X	The horizontal position of the object’s anchor point relative to the origin (upper left corner) of the parent object, normally the page.
Y	The vertical position of the object’s anchor point relative to the origin (upper left corner) of the parent object, normally the page.
Width	The width of the object’s bounding box.
Height	The height of the object’s bounding box, or the height of a table row.
TextHeightMin	If Vertical size (or TextHeightGrow property if using scripting) is set to Limited, this is the minimum height of the text regardless of the height of the text area.
TextHeightMax	If Vertical size (or TextHeightGrow property if using scripting) is set to Limited, this is the maximum height of the text regardless of the height of the text area.
ContentVShrink	The maximum vertical shrink of the content within a shape.
ContentVGrowth	The maximum vertical growth of the content within a shape.
ContentHShrink	The maximum horizontal shrink of the content within a shape.
ContentHGrowth	The maximum horizontal growth of the content within a shape.
ShapeVShrink	The maximum vertical shrink of the shape.
ShapeVGrowth	The maximum vertical growth of the shape.
ShapeHShrink	The maximum horizontal shrink of the shape.
ShapeHGrowth	The maximum horizontal growth of the shape.
LineThickness	The line thickness.
Columns[]/Width	The column width of the nth column of the table, where n=0 is the left column.
RowHeight	The row height.
Cells[]/LineThickness	The line thickness of the nth cell on the row, where n=0 is the left cell.
Cells[]/TopLineThickness	The line thickness of the top border of the nth cell on the row, where n=0 is the left cell.
Cells[]/LeftLineThickness	The line thickness of the left border of the nth cell on the row, where n=0 is the left cell.
Cells[]/RightLineThickness	The line thickness of the right border of the nth cell on the row, where n=0 is the left cell.
Cells[]/BottomLineThickness	The line thickness of the bottom border of the nth cell on the row, where n=0 is the left cell.

Description

Retrieves the value of the specified property in StoryTeller. The value is returned in millimeters

Returns

num	The value of the specified property in millimeters. For invalid properties 0 is returned.

Example

$Height = StGetPropertyMm("Height");