OptionsManager

class

• Introduction
• Methods
• • []
  • count
  • each
  • keys
  • size

Introduction

Methods

OptionsManager.[]SketchUp 6.0+

The [] method is used to get an option provider by name or index.

For example, to get the UnitsOptions on the Model, you could use the command:

Arguments:

index

The index of the OptionsProvider object.

name

The name of the OptionsProvider object.

Returns:

optionprovider

an OptionsProvider object if successful, otherwise nil.

 model = Sketchup.active_model
 manager = model.options
 provider = manager[0]
 if (provider)
   UI.messagebox provider.name
 else
   UI.messagebox "Failure"
 end

OptionsManager.countSketchUp 6.0+

The count method is an alias for size.

Returns:

number

number of OptionsProvider objects if successful

 model = Sketchup.active_model
 manager = model.options
 count = manager.count

OptionsManager.eachSketchUp 6.0+

The each method is used to iterate through options providers.

Arguments:

opsprovider

A variable that will hold each OptionsProvider object as they are found.

Returns:

nil

 model = Sketchup.active_model
 manager = model.options
 # Retrieves each provider
 manager.each { |provider| UI.messagebox provider.name }

OptionsManager.keysSketchUp 6.0+

The keys method is used to get a list of keys in the OptionsManager.

Returns:

keys

Array of string keys

 model = Sketchup.active_model
 manager = model.options
 optionproviderarray = manager.keys
 if (optionproviderarray)
   UI.messagebox optionproviderarray
 else
   UI.messagebox "Failure"
 end

OptionsManager.sizeSketchUp 6.0+

The size method returns the number of OptionsProvider objects inside this OptionsManager.

Returns:

number

number of OptionsProvider objects if successful

 model = Sketchup.active_model
 manager = model.options
 size = manager.size