class Sketchup::OptionsManager

The OptionsManager class manages various kinds of OptionsProviders on a Model.

@version SketchUp 6.0

Public Instance Methods

[](arg) click to toggle source

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:

@example

Sketchup.active_model.options["UnitsOptions"]

@example

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

@overload [](index)

@param index         The index of the OptionsProvider object.
@return              optionprovider - an OptionsProvider object if
                     successful, otherwise nil.

@overload [](name)

@param name          The name of the OptionsProvider object.
@return              optionprovider - an OptionsProvider object if
                     successful, otherwise nil.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb, line 47
def [](arg)
end
count() click to toggle source

@example

optionsmanager = Sketchup.active_model.options
number = manager.count

@note Since SketchUp 2014 the count method is inherited from Ruby's

+Enumable+ mix-in module. Prior to that the {#count} method is an alias
for {#length}.

@return integer - number of OptionsProvider objects if

successful

@see length

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb, line 65
def count
end
each() click to toggle source

The each method is used to iterate through options providers.

@example

model = Sketchup.active_model
manager = model.options
manager.each { |provider| puts provider.name }

@return nil

@version SketchUp 6.0

@yield [opsprovider] A variable that will hold each OptionsProvider object

as they are found.
# File lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb, line 81
def each
end
keys() click to toggle source

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

@example

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

@return keys - Array of string keys

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb, line 99
def keys
end
length() click to toggle source

The {#length} method is an alias of {#size}.

@example

optionsmanager = Sketchup.active_model.options
number = manager.length

@return [Integer]

@see size

@version SketchUp 2014

# File lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb, line 113
def length
end
size() click to toggle source

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

@example

optionsmanager = Sketchup.active_model.options
number = manager.size

@return [Integer]

@see length

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb, line 128
def size
end