Adds a rectangular frame to the current page.

[C#]
virtual int FrameRect()
virtual int FrameRect(bool inside)
virtual int FrameRect(double rx, double ry)
virtual int FrameRect(double rx, double ry, bool inside)

[Visual Basic]
Function FrameRect() As Integer
Function FrameRect(ByVal inside As Boolean) As Integer
Function FrameRect(ByVal rx As Double, ByVal ry As Double) As Integer
Function FrameRect(ByVal rx As Double, ByVal ry As Double, ByVal inside As Boolean) As Integer


Adds a rectangular frame to the current page. The frame location and size is determined by the current rectangle, the line color is determined by the current color, the line width is determined by the current width and any options are determined by the current options.

By specifying values for the horizontal and vertical radius parameters you can draw rectangles with rounded corners. The values refers to the radii of the ellipse used to draw the corners.

By setting the horizontal radius parameter to half the width of the rect and the vertical radius parameter to half the height of the rect you can draw ovals and circles.

By default frames are drawn round the outside of the current rectangle. This allows you to add content and then frame it ensuring that the frame and the content do not overlap. However sometimes you may wish to draw the frame round the inside of the rectangle. You can do this by setting the inside parameter to true.

The FrameRect function returns the Object ID of the newly added Graphic Object.

The following code adds a black frame to a document. The frame is inset from the edges of the document by 50 points horizontally and 100 points vertically.

[C#]
Doc theDoc = new Doc();
theDoc.Rect.Inset(50, 100);
theDoc.FrameRect();
theDoc.Save(Server.MapPath("docframerect.pdf"));
theDoc.Clear();

[Visual Basic]
Dim theDoc As Doc = New Doc()
theDoc.Rect.Inset(50, 100)
theDoc.FrameRect()
theDoc.Save(Server.MapPath("docframerect.pdf"))
theDoc.Clear()


docframerect.pdf