Share

Border Object


Description

The Border object represents the instance of a border on a sheet.

Methods

Name Description
Delete Method that deletes the title block from the sheet.
GetResultText Method that returns the text that is currently displayed for a specific text box. This is useful for text boxes that use input form other sources to define their content, i.e. properties and prompted text. The string displayed within this text box is returned.
SetPromptResultText Method that sets the text that was supplied for a specified border that contains prompted text. The string displayed within this border is changed.

Properties

Name Description
Application Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
Definition Property returning the border definition object that this border is an instance of.
Name Gets and sets the name of the border instance.
Parent Property returning the parent sheet object.
RangeBox Property that returns a Box2D object which contains the lower-left and upper-right corners of a rectangle that is guaranteed to enclose this object.
Type Returns an ObjectTypeEnum indicating this object's type.

Accessed From

Sheet.AddBorder, Sheet.Border

Derived Classes

DefaultBorder

Samples

Name Description
Creating a parts list This sample demonstrates the creation of a parts list. The parts list is placed at the top right corner of the border if one exists, else it is placed at the top right corner of the sheet.
Border Insert This sample illustrates inserting a default border.
Border Insert Default This sample illustrates inserting a default border using the default values.

Version

Introduced in version 5.3

Was this information helpful?