SampleText()

Summary

Creates a sample text object for use in a menu or dialog box.

Syntax

sample_text = SampleText(string text, string font, array options)

Argument	Contents
text	The text in the sample
font	The name and size of the font

Option	Type	Contents
Size	2 reals	The width and height (in points) of a rectangle in which the sample can be displayed
Color	Color	The color of the text

Returns

A sample text object.

Notes

• Sample text objects can be used to preview how text will look from within a menu or dialog box.

Examples

sample_text = SampleText("Layer", "Arial|Bold|12", {{"Size", x, y}, {"Color", ColorRGB(0, 0, 0)}})

Error Codes

Error Type	Meaning
Error	The type or one of the options is not valid

See Also

Function	Summary
GetSample()	Gets a sample object indicating how features in a layer or selection set display on a map
GetThemeSamples()	Gets sample objects indicating how features in a theme display on a map.
SampleLine()	Creates a sample line object for use in a menu or dialog box
SampleArea()	Creates a sample area object for use in a menu or dialog box
SamplePoint()	Creates a sample point object for use in a menu or dialog box
SaveSampleToImage()	Creates a sample text object for use in a menu or dialog box
SetSampleText()	Creates a sample object based on an input sample with the specified text for use in a menu or dialog box