BorderDefinition Object
Description
The BorderDefinition object represents a border definition.
Methods
CopyTo |
Method that copies the definition to the target drawing document. |
Delete |
Method that deletes the BorderDefinition object. This method will fail in the case where the definition is being referenced. This can be determined by using the IsReferenced property. |
Edit |
Method that opens a copy of the border definition's sketch for edit in the Sketch environment. |
ExitEdit |
Method that closes the currently active sketch (see below for limitations) and depending on the input parameters, replaces the sketch of the border definition with the edited sketch. |
GetReferenceKey |
Method that generates and returns the reference key for this entity. |
Properties
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. |
AttributeSets |
Property that returns the AttributeSets collection object associated with this object. |
IsDefault |
Gets if the border definition is default or not. |
IsReferenced |
Property that specifies if the border definition is being referenced or not. A border definition is referenced whenever it is used on a sheet. A referenced border definition cannot be deleted. |
Name |
Gets and sets the name of the border definition. |
Parent |
Property returning the parent . |
Sketch |
Property that returns the sketch associated with the border definition. The DrawingSketch returned by the Sketch property supports all query functionality but cannot be edited. To edit the contents of a border definition, use the Edit method. This creates a copy of the border definition's sketch for edit. The ExitEdit method of the BorderDefinition can then be used to save the edited sketch as the border definition's sketch. |
Type |
Returns an ObjectTypeEnum indicating this object's type. |
Accessed From
Border.Definition,
BorderDefinition.CopyTo,
BorderDefinitions.Add,
BorderDefinitions.Item,
DefaultBorder.Definition,
SheetFormat.ReferencedBorderDefinition
Version
Introduced in version 5.3