AddTextRegion

Metreos.Native.ImageBuilder.AddTextRegion

Summary

AddTextRegion adds a text string to the canvas.

Usage

The AddTextRegion action lets a developer add an text string to an ImageBuilder type. As with all regions, this region will cover any previously added regions in the same area and can be covered by subsequent regions that occupy the same location as this region.

Remarks

None.

Action Parameters
Parameter Name.NET TypeDefaultDescription
Text *System.StringThe text to add to the image.
FontSystem.StringArialThe font of the text string.
FontSizeSystem.Int3210The height of the font (in pixels).
Top *System.Int32The location of the top of the text region on the ImageBuilder canvas.
Left *System.Int32The location of the left of the text region on the ImageBuilder canvas.
ColorSystem.Drawing.ColorSystem.Drawing.Color.WhiteThe color of the text.
Result Data
Parameter Name.NET TypeDescription
ImageMetreos.Utilities.TextRegionA standard image region which the ImageBuilder type will append to itself using the specified text properties.

Branch Conditions 

Success

No description.

Failure

No description.