You are here: Start » FIL.NET » Function Reference » Region » Region Basics » FIL.CreateRectangleBorderRegion
Creates a frame-shaped region with given parameters.
Namespace: | FilNet |
---|---|
Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void CreateRectangleBorderRegion ( FilNet.Rectangle2D inRectangle, FilNet.CoordinateSystem2D? inRectangleAlignment, float inBorderWidth, FilNet.BorderPosition inBorderPosition, int inFrameWidth, int inFrameHeight, FilNet.Region outRegion, NullableValue<FilNet.Rectangle2D> outAlignedRectangle )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
![]() | inRectangle | FilNet.Rectangle2D | |||
![]() | inRectangleAlignment | FilNet.CoordinateSystem2D? | Adjusts the rectangle to the position of the inspected object. Default value: ftl::NIL. | ||
![]() | inBorderWidth | float | <0.0f, INF> | 1.0f | Default value: 1.0f. |
![]() | inBorderPosition | FilNet.BorderPosition | Centered | Default value: Centered. | |
![]() | inFrameWidth | int | <0, 65535> | Width of the created region's frame. | |
![]() | inFrameHeight | int | <0, 65535> | Height of the created region's frame. | |
![]() | outRegion | FilNet.Region | Output region. | ||
![]() | outAlignedRectangle | FilNet.NullableValue<FilNet.Rectangle2D> | The input rectangle transformed to the absolute coordinate system. Can be null to skip this parameter calculation. |
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Incorrect BorderPosition in CreateRectangleBorderRegion. |
Function Overrides
- CreateRectangleBorderRegion(Rectangle2D, Single, BorderPosition, Int32, Int32, Region)
- CreateRectangleBorderRegion(Rectangle2D, Nullable<CoordinateSystem2D>, Single, BorderPosition, Int32, Int32, Region)
- CreateRectangleBorderRegion(Rectangle2D, Nullable<CoordinateSystem2D>, Single, BorderPosition, Int32, Int32, Region, Rectangle2D)