AttributeDictionaries

SketchUp 6.0+

class

Parent: Entity

Introduction
Methods
- []
- delete
- each

Introduction

The AttributeDictionaries class is a collection of all of the AttributeDictionary objects that are attached to a given Entity object.

The Entity class is a popular parent class in SketchUp, meaning you can attach AttributeDictionaries to almost anything, from geometric items like edges and faces and components to more conceptual things like pages or materials.

You access this class not by performing an AttributeDictionaries.new but by grabbing a handle from an existing entity.

     # Grab the first entity from the model.
     my_layer = Sketchup.active_model.entities[0]

     # Grab a handle to its attribute dictionaries.
     attrdicts = my_layer.attribute_dictionaries

Methods

AttributeDictionaries.[]SketchUp 6.0+

Get an AttributeDictionary by name. Returns nil if there is none with the given name.

Arguments:

key: The name of the attribute dictionary.

Returns:

dictionary: the dictionary

 model = Sketchup.active_model
 attrdicts = model.attribute_dictionaries
 # Iterates through all dictionaries and prints to screen.
 dict = attrdicts['my_dictionary']
 if dict
   UI.messagebox("Found: " + dict.to_s)
 else
   UI.messagebox("No dictionary found.")
 end

AttributeDictionaries.deleteSketchUp 6.0+

The delete method destroys a given AttributeDictionary. This AttributeDictionary can be passed directly or identified by its string name.

Arguments:

key_or_dict: The name of the attribute dictionary to delete, or the dictionary object itself.

Returns:

dictionaries: the modified AttributeDictionaries object

 model = Sketchup.active_model
 attrdicts = model.attribute_dictionaries
 # Deletes a dictionary called 'my_dictionary'
 attrdicts.delete 'my_dictionary'

AttributeDictionaries.eachSketchUp 6.0+

The each method is used to iterate through all of the attributes dictionaries.

Throws an exception if there are no keys.

Arguments:

dict: Each AttributeDictionary as it is found.

Returns:

nil

 model = Sketchup.active_model
 attrdicts = model.attribute_dictionaries
 # Iterates through all dictionaries and prints to screen.
 attrdicts.each { | dict | UI.messagebox dict }