Class: WIN32OLE_VARIABLE

Inherits:
Object
  • Object
show all
Defined in:
win32ole.c,
win32ole.c

Overview

WIN32OLE_VARIABLE objects represent OLE variable information.

Instance Method Summary collapse

Instance Method Details

#nameObject Also known as: to_s

Returns the name of variable.

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
 puts "#{variable.name}"
end

The result of above script is following:
 xlChart
 xlDialogSheet
 xlExcel4IntlMacroSheet
 xlExcel4MacroSheet
 xlWorksheet


4029
4030
4031
# File 'win32ole.c', line 4029

static VALUE
folevariable_name(self)
VALUE self;

#ole_typeObject

Returns OLE type string.

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
puts "#{variable.ole_type} #{variable.name}"
end

The result of above script is following:
INT xlChart
INT xlDialogSheet
INT xlExcel4IntlMacroSheet
INT xlExcel4MacroSheet
INT xlWorksheet


4071
4072
4073
# File 'win32ole.c', line 4071

static VALUE
folevariable_ole_type(self)
VALUE self;

#ole_type_detailObject

Returns detail information of type. The information is array of type.

tobj = WIN32OLE_TYPE.new('DirectX 7 for Visual Basic Type Library', 'D3DCLIPSTATUS')
variable = tobj.variables.find {|variable| variable.name == 'lFlags'}
tdetail  = variable.ole_type_detail
p tdetail # => ["USERDEFINED", "CONST_D3DCLIPSTATUSFLAGS"]


4107
4108
4109
# File 'win32ole.c', line 4107

static VALUE
folevariable_ole_type_detail(self)
VALUE self;

#valueObject

Returns value if value is exists. If the value does not exist, this method returns nil.

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
 puts "#{variable.name} = #{variable.value}"
end

The result of above script is following:
 xlChart = -4109
 xlDialogSheet = -4116
 xlExcel4IntlMacroSheet = 4
 xlExcel4MacroSheet = 3
 xlWorksheet = -4167


4153
4154
4155
# File 'win32ole.c', line 4153

static VALUE
folevariable_value(self)
VALUE self;

#variable_kindObject

Returns variable kind string.

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
 puts "#{variable.name} #{variable.variable_kind}"
end

The result of above script is following:
 xlChart CONSTANT
 xlDialogSheet CONSTANT
 xlExcel4IntlMacroSheet CONSTANT
 xlExcel4MacroSheet CONSTANT
 xlWorksheet CONSTANT


4260
4261
4262
# File 'win32ole.c', line 4260

static VALUE
folevariable_variable_kind(self)
VALUE self;

#varkindObject

Returns the number which represents variable kind. tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'XlSheetType') variables = tobj.variables variables.each do |variable| puts "#WIN32OLE_VARIABLE.variablevariable.name #WIN32OLE_VARIABLE.variablevariable.varkind" end

The result of above script is following:
 xlChart 2
 xlDialogSheet 2
 xlExcel4IntlMacroSheet 2
 xlExcel4MacroSheet 2
 xlWorksheet 2


4303
4304
4305
# File 'win32ole.c', line 4303

static VALUE
folevariable_varkind(self)
VALUE self;

#visible?Boolean

Returns true if the variable is public.

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
 puts "#{variable.name} #{variable.visible?}"
end

The result of above script is following:
 xlChart true
 xlDialogSheet true
 xlExcel4IntlMacroSheet true
 xlExcel4MacroSheet true
 xlWorksheet true

Returns:

  • (Boolean)


4201
4202
4203
# File 'win32ole.c', line 4201

static VALUE
folevariable_visible(self)
VALUE self;