StGetProperty

Syntax

StGetProperty(property);

property

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

 

Property	Description
Name	The object name
Description	The object description
Visibility	The visibility of the object 0 – Normal 1 – Hidden (Object is suppressed) 2 – Invisible
Rotation	Clockwise rotation in degrees.
SizeMode	For images: 0 – Resize 1 – Original
Positioning	For images: 0 – Left top 1 – Left center 2 – Left bottom 3 – Center top 4 – Center center 5 – Center bottom 6 – Right top 7 – Right center 8 – Right bottom
Alignment	For images when SizeMode is set to Resize and ScaleMode is None or Proportional, this specifies the alignment of the image within the bounding box (or just refer to ST doc) 0 – Left top 1 – Left center 2 – Left bottom 3 – Center top 4 – Center center 5 – Center bottom 6 – Right top 7 – Right center 8 – Right bottom
Visibility	This property represents the Visibility property in the Properties panel. 0 – Visible 1 – Hidden 2 – Invisible
TextHeightGrow	This property represents the Vertical size property in the Properties panel. 0 – Fixed 1 – Limited Note: Use the TextHeightMin/TextHeightMax property keys with StSetPropertyMm() or StSetPropertyPt() to set the limits. To use "no limit" for the text height, specify a very high number.
LineColor	The line color. See StoryTeller documentation for supported formats.
FillType	This property represents the Fill > Type property in Properties panel. 0 – Solid 1 – Linear gradient horizontal 2 – Linear gradient vertical 3 – Radial gradient
FillColor	The fill color. See StoryTeller documentation for supported formats.
FillSecondColor	The second fill color for gradient colors.
ScaleMode	0 – None 1 – Scale 2 – Proportional
ImageURI	The URI to the image.
ImageFormat	The image format. Read-only.
ImageBitDepth	The image bit depth. Read-only.
ImagePixelWidth	The image pixel width. Read-only.
ImagePixelHeight	The image pixel height. Read-only.
ImageResolutionX	The horizontal image resolution.
ImageResolutionY	The vertical image resolution.
ImagePage	The number of the page for a multi-page TIFF image.
OverlayURI	The URI to the overlay
OverlayPage	The number of the page for a multi-page overlay.
BarcodeName	The barcode type.
BarcodeData	The barcode data.
SubstitutionURI	The URI to the substitution.
Cells[n]/FillColor	The fill color of the nth cell on the row, where n=0 is the left cell.
Cells[]/LineColor	The border color of the nth cell on the row, where n=0 is the left cell.
Cells[]/TopLineColor	The border color of the top border of the nth cell on the row, where n=0 is the left cell.
Cells[]/LeftLineColor	The border color of the left border of the nth cell on the row, where n=0 is the left cell.
Cells[]/RightLineColor	The border color of the right border of the nth cell on the row, where n=0 is the left cell.
Cells[]/BottomLineColor	The border color of the bottom border of the nth cell on the row, where n=0 is the left cell.
ColumnsCount	The number of columns in a table. Use in script before the table.
CellsCount	The number of cells in a row. Use in script before the row.

Description

Retrieves the value of the specified non-dimensional property in StoryTeller.

Returns

string

The value of the specified property. For invalid properties an empty string is returned.

Example

$visibility = StGetProperty("Visibility");