DefaultBorder Object

Derived from: Border Object

Description

The DefaultBorder object represents an instance of the default border.

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.
BottomMargin	Property that returns the space between the bottom edge of the sheet and the border line. The distance is specified in centimeters.
Centermarks	Property that returns if center marks are displayed on the border. A value of True indicates center marks are displayed.
Definition	Property returning the border definition object that this border is an instance of.
DelimitZonesByLines	Property that returns if delimit zones are indicated by lines or arrowheads. A value of True indicates lines are used and False specifies arrowheads.
HorizontalZoneCount	Property that returns the number of horizontal zones to be created for the border.
HorizontalZoneLabelMode	Property that returns the label style for the horizontal labels. Valid values are kBorderLabelModeAlphabetical, kBorderLabelModeNumeric, and kBorderLabelModeNone.
LabelFromBottomRight	Property that returns whether the zone numbers begin at the bottom-right or top-left corner. A value of True indicates the bottom-right corner and False specifies the top-left.
LeftMargin	Property that returns the space between the left edge of the sheet and the border line. The distance is specified in centimeters.
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.
RightMargin	Property that returns the space between the right edge of the sheet and the border line. The distance is specified in centimeters.
TopMargin	Property that returns the space between the top edge of the sheet and the border line. The distance is specified in centimeters.
Type	Returns an ObjectTypeEnum indicating this object's type.
VerticalZoneCount	Property that returns the number of vertical zones to be created for the border.
VerticalZoneLabelMode	Property that returns the label style for the vertical labels. Valid values are kBorderLabelModeAlphabetical, kBorderLabelModeNumeric, and kBorderLabelModeNone.

Accessed From

Sheet.AddDefaultBorder

Samples

Name	Description
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