Share

HighlightSet Object


Description

The HighlightSet object defines a set of objects and an associated color to display them with.

Methods

Name Description
AddItem Method that adds an entity to the highlight set.
AddMultipleItems Adds multiple entities to the highlight set.
Clear Method that removes all objects from the highlight set.
Delete Method that deletes the HighlightSet object.
Remove Method that removes the specified object from the highlight set.

Properties

Name Description
Color Gets/Sets the color of the highlight set.
Count Property that returns the number of objects in the highlight set.
Item Returns the specified object from the highlight set.
Type Returns an ObjectTypeEnum indicating this object's type.

Accessed From

ApprenticeServerDocument.CreateHighlightSet, ApprenticeServerDrawingDocument.CreateHighlightSet, AssemblyDocument.CreateHighlightSet, Document.CreateHighlightSet, DrawingDocument.CreateHighlightSet, HighlightSets.Add, HighlightSets.Item, PartDocument.CreateHighlightSet, PresentationDocument.CreateHighlightSet

Samples

Name Description
Interference Analysis This sample demonstrates the functions used to calculate interference analysis in an assembly.
Creating a HighlightSet Demonstrates creating a highlight set.
Highlight Feature Faces This sample highlights the faces of an extrusion, revolution, or hole feature. It differentiates the faces on the start cap, end cap, and side faces by highlighting them in different colors. The HighlightFeatureFaces sub highlights the feature faces. Since the highlight set objects are declared outside of this sub, the highlighting remains after the sub has finished executing. Use the ClearHighlight sub to clear the highlighting that does so by releasing the HighlightSet objects.

Version

Introduced in version 5

Was this information helpful?