SetSampleText()
Summary
Creates a sample object based on an input sample with the specified text for use in a menu or dialog box.
Syntax
sample = SetSampleText(sample_object input_sample, string text)
| Argument | Contents |
|---|---|
| input_sample | The sample object from which the new sample object will be created |
| text | The new text |
Returns
A sample object that is the same as the input sample object but has the specified text instead.
Notes
-
This function is useful for setting the text of the sample object to null as well as for adding or changing the text of the sample object.
Example
sample = GetSample("Streets|")
new_sample = SetSampleText(sample, "New York Streets")See Also
| Function | Summary |
|---|---|
| GetSample() | Gets a sample object indicating how features in a layer or selection set display on a map |
| SampleArea() | Creates a sample area object for use in a menu or dialog box |
| SampleLine() | Creates a sample line object for use in a menu or dialog box |
| SamplePoint() | Creates a sample point object for use in a menu or dialog box |
| SaveSampleToImage() | Saves a sample object to an image file. |