You are here: Start » FIL.NET » Function Reference » Region » Region Basics » FIL.CreateBoxRegion

FIL.CreateBoxRegion

Creates a rectangular region corresponding to a given box.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void CreateBoxRegion
(
	FilNet.Box inBox,
	int inFrameWidth,
	int inFrameHeight,
	FilNet.Region outRegion
)

Parameters

Name Type Range Default Description
inBoxFilNet.BoxA box defining pixels that will be converted to white elements.
inFrameWidthint<0, 65535>Width of the created region's frame (not to be confused with the width of the box!).
inFrameHeightint<0, 65535>Height of the created region's frame (not to be confused with the height of the box!).
outRegionFilNet.RegionOutput region.

Description

The operation creates a region containing pixels lying inside the inBox.

The inFrameWidth and inFrameHeight parameters most often should be set equal to the dimensions of the image this region will be used with. If the input box exceeds these dimensions, the output region will be cropped.

Examples

CreateBoxRegion run with inBox = Box(50,100,200,100).

See also