Share

GeneralNote Object

Derived from: DrawingNote Object

Description

The GeneralNote object represents a general note on a sheet and derives from the DrawingNote object.

Methods

Name Description
Delete Method that deletes the DrawingNote.
GetReferenceKey Method that generates and returns the reference key for this entity.

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.
AttributeSets Property that returns the AttributeSets collection object associated with this object.
BackgroundColor Gets/Sets the BackgroundColor associated with the GeneralNote.
Color Gets/Sets color of the DrawingNote.
Fitted Property that returns whether the note remains tightly fitted to the text within the box.
FittedTextHeight Property that returns the actual height of the text within the note. This does not necessarily represent the current height of the note, but only the text within the note. If the Fitted property is True then this value is the same as the height of the note.
FittedTextWidth Property that returns the actual width of the text within the note. This does not necessarily represent the current width of the note, but only the text within the note. If the Fitted property is True then this value is the same as the width of the note.
FormattedText Gets/Sets formatted text of the DrawingNote.
Height Gets/Sets the height of the GeneralNote.
HorizontalJustification Gets/Sets horizontal justification of the DrawingNote.
Layer Gets/Sets the layer used by the DrawingNote.
LineSpacing Gets/Sets the LineSpacing used by the DrawingNote.
LineSpacingType Gets/Sets the LineSpacingType used by the DrawingNote.
Parent Property that returns the parent sheet of the object.
Position Gets/Sets the position of the DrawingNote on the sheet.
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.
Retrieved Indicates whether the drawing note was created as a result of retrieving it from the model.
RetrievedFrom Returns the model annotation this drawing note was retrieved from.
Rotation Gets/Sets the rotation of the GeneralNote.
ShowTextBorder Gets/Sets whether to show the text border or not.
StackedTextPosition Gets and sets the position (alignment) of the stacked text with respect to regular text.
Text Gets/Sets text of the DrawingNote.
TextStyle Gets/Sets the TextStyle of the GeneralNote.
Type Returns an ObjectTypeEnum indicating this object's type.
UnitAttributes Get the unit attributes associated with the GeneralNote.
UseBackgroundColor Gets/Sets the UseBackgroundColor associated with the GeneralNote.
VerticalJustification Gets/Sets vertical justification of the DrawingNote.
Width Gets/Sets the width of the GeneralNote.
WidthScale Gets/Sets the width scale factor of the DrawingNote.

Accessed From

GeneralNotes.AddByRectangle, GeneralNotes.AddFitted, GeneralNotes.Item

Version

Introduced in version 10

Was this information helpful?