PropertySets Object
Description
Object that manages the collection of objects and provides the ability to add new property sets to the collection. See the article in the overviews section.
Methods
| Add |
Adds a new PropertySet. The new set's FMTID can be optionally provided (as a string). |
| FlushToFile |
Flush all of the Properties in each of the PropertySets onto the file. The 'dirty' flags are reset. Please note that this method is available in Apprentice only. |
| PropertySetExists |
Function that returns a Boolean to indicate whether a PropertySet with the specified name exists in the PropertySets collection. |
| RefreshFromFile |
Refresh all of the Properties in each of the PropertySets from the File. The 'dirty' flags are reset and any edits are lost. Please note that this method is available in Apprentice only. |
Properties
| Count |
Property that returns the number of items in this collection. |
| Dirty |
Property that returns a Boolean flag that indicates whether any of the Properties have been edited, deleted or created. |
| Item |
Gets the set in this collection in a sequences fashion; by index, or by its name -- Display or Internal. |
| Parent |
Property that returns the parent object from whom this object can logically be reached. |
| Type |
Returns an ObjectTypeEnum indicating this object's type. |
Accessed From
ApprenticeServerDocument.FilePropertySets,
ApprenticeServerDocument.PropertySets,
ApprenticeServerDrawingDocument.FilePropertySets,
ApprenticeServerDrawingDocument.PropertySets,
AssemblyDocument.FilePropertySets,
AssemblyDocument.PropertySets,
BOMRow.OccurrencePropertySets,
ComponentOccurrence.OccurrencePropertySets,
ComponentOccurrenceProxy.OccurrencePropertySets,
Document.FilePropertySets,
Document.PropertySets,
DrawingDocument.FilePropertySets,
DrawingDocument.PropertySets,
PartDocument.FilePropertySets,
PartDocument.PropertySets,
PresentationDocument.FilePropertySets,
PresentationDocument.PropertySets,
PropertySet.Parent,
VirtualComponentDefinition.PropertySets
Samples
| Using the BOM APIs |
This sample demonstrates the Bill of Materials API functionality in assemblies. |
| Update iProperty values using Apprentice |
Updates some iProperty values using Apprentice. The document specified in the code for the Open method must exist. |
| Create custom iProperties |
Creates custom iProperties of various types. A document must be open when this sample is run. |
| Get value of iProperty |
Demonstrates getting the values of the "Part Number" iProperty. Any property can be retrieved by accesing the correct property set and property.
A document must be open when this sample is run. |
Version
Introduced in version 4
