ProfilePath Object
Description
The ProfilePath object represents a single set of connected curves or a text box. The order of the collection defines the connected order of the entities. See the article in the overviews section.
Methods
| Delete |
Method that deletes this ProfilePath object. This method can be used to delete profile paths that represent a set of connected curves as well as profile paths that represent text boxes. |
| GetReferenceKey |
Method that generates and returns the reference key for this entity. |
Properties
| AddsMaterial |
Gets or sets a Boolean indicating whether the path adds or removes material from the entire area. |
| 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. |
| Closed |
Property that returns a Boolean indicating if the path is closed or not. Returns True in the case of a closed path. This property is only valid if the profile path denotes a set of connected curves. On the other hand, if the profile path denotes a text box, which will be indicated by the value of the TextPath property being True, then this property does not apply. |
| Count |
Property that returns the number of items in this collection. This property is only valid if the profile path denotes a set of connected curves. On the other hand, if the profile path denotes a text box, which will be indicated by the value of the TextPath property being True, then this property does not apply. |
| Item |
Returns the specified ProfileEntity object from the collection. This property is only valid if the profile path denotes a set of connected curves. On the other hand, if the profile path denotes a text box, which will be indicated by the value of the TextPath property being True, then this property does not apply. |
| Parent |
Property that returns the parent Profile. |
| TextBox |
Property that gets the text box this profile path was derived from. This property is only valid if the profile path denotes a text box which will be indicated by the value of the TextPath property being True. On the other hand, if the profile path denotes a set of connected curves, then this property does not apply and will return Nothing. |
| TextBoxPath |
Property that returns a Boolean indicating if the profile path denotes a text box. Returns True in the case that the path denotes a text box. If the profile path denotes a set of connected curves, then this property will return False. |
| Type |
Returns an ObjectTypeEnum indicating this object's type. |
Accessed From
Profile.Item,
ProfileEntity.Parent,
ProfileEntityProxy.Parent,
ProfilePathProxy.NativeObject,
ProfileProxy.Item
Derived Classes
ProfilePathProxy
Samples
| Sketch profile control |
This sample demonstrates the usage of the Profiles API to control the shape of the profile. The sample creates three concntric circles and creates an extrusion of the region between the inner circles. |
Version
Introduced in version 5
