AddStandardImageRegion

Metreos.Native.ImageBuilder.AddStandardImageRegion

Summary

AddStandardRegion adds an image of a specific size and location to the image canvas.

Usage

The AddStandardRegion action lets a developer add an image 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.

Region width and height are determined as follows: if Width is specified, then it will be used as the width of the image. If Right and Left are both specified and Width is not, then the Width is computed as the difference of Right and Left. The height of the image is similiar: if Height is specified, then it will be used as the height of the image. If Bottom and Top are both specified and Height is not, then the Height is computed as the difference of Bottom and Top.

Remarks

None.

Action Parameters
Parameter Name.NET TypeDefaultDescription
Location *System.StringThe location of the image. This can be a local filepath or an HTTP URL. The image can be PNG, BMP, or JPEG.
TopSystem.Int32The location of the top side of the image region on the ImageBuilder canvas. This does not have to be specified if Bottom and Height are specified.
LeftSystem.Int32The location of the left side of the image region on the ImageBuilder canvas. This does not have to be specified if Right and Width are specified.
RightSystem.Int32The location of the right side of the image region on the ImageBuilder canvas. This number is specified relative to the right edge of the canvas. This does not have to be specified if Left and Width are specified.
BottomSystem.Int32The location of the bottom side of the image region on the ImageBuilder canvas. This number is specified relative to the bottom edge of the canvas. This does not have to be specified if Top and Width are specified.
WidthSystem.Int32The width of the image region on the ImageBuilder canvas. This does not have to be specified if Left and Right are specified.
HeightSystem.Int32The height of the image region on the ImageBuilder canvas. This does not have to be specified if Top and Bottom are specified.
Result Data
Parameter Name.NET TypeDescription
ImageMetreos.Utilities.StandardImageRegionA standard image region which the ImageBuilder type will append to itself using the specified image properties.

Branch Conditions 

Success

No description.

Failure

No description.