Native
Synchronous
No Custom Parameters
AddBorderedTextRegion adds a text string to the canvas which has a border and background fill color.
The AddBorderedTextRegion action lets a developer add an text string with a border and background fill color 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.
None.
| Parameter Name | .NET Type | Default | Description |
|---|---|---|---|
| Text * | System.String | The text to add to the image. | |
| Font | System.String | The font of the text string. | |
| FontSize | System.Int32 | The height of the font (in pixels). | |
| Top * | System.Int32 | The location of the top of the text region on the ImageBuilder canvas. | |
| Left * | System.Int32 | The location of the left of the text region on the ImageBuilder canvas. | |
| RoundedCorners | System.Boolean | true | Indicates whether to round the corners of the border. |
| HorizontalPadding | System.Int32 | 3 | The amount of padding to place between the left and right edge of the text and the border (in pixels). |
| VerticalPadding | System.Int32 | 3 | The amount of padding to place between the top and bottom edge of the text and the border (in pixels) |
| TextColor | System.Drawing.Color | System.Drawing.Color.Black | The color of the text. |
| BorderColor | System.Drawing.Color | System.Drawing.Color.Black | The color of the border. |
| FillColor | System.Drawing.Color | System.Drawing.Color.White | The color of the background of the region. |
| BorderWidth | System.Int32 | 1 | The width of the border (in pixels). |
| Parameter Name | .NET Type | Description |
|---|---|---|
| Image | Metreos.Utilities.BorderedTextRegion | A standard image region which the ImageBuilder type will append to itself using the specified text properties. |
Branch Conditions
No description.
No description.