- Inheritance
- < Object
WIN32OLE objects represent OLE Automation object in Ruby.
Classes & Modules
Constants
| Name | Description | |
|---|---|---|
| ARGV | = rb_ary_new() | |
| CP_THREAD_ACP | = INT2FIX(CP_THREAD_ACP) | |
| VERSION | = rb_str_new2(WIN32OLE_VERSION) |
Methods
Class
| Visibility | Signature |
|---|---|
| public | codepage () |
| public | codepage= (p1) |
| public | connect (...) |
| public | const_load (...) |
| public | new (...) |
| public | ole_free (p1) |
| public | ole_reference_count (p1) |
| public | ole_show_help (...) |
Instance
| Visibility | Signature |
|---|---|
| public | [] (...) |
| public | []= (...) |
| public | _getproperty (p1, p2, p3) |
| public | _invoke (p1, p2, p3) |
| public | _setproperty (p1, p2, p3) |
| public | each () |
| public | invoke (...) |
| public | method_missing (...) |
| public | ole_activex_initialize () |
| public | ole_free () |
| public | ole_func_methods () |
| public | ole_get_methods () |
| public | ole_method (p1) |
| public | ole_method_help (p1) |
| public | ole_methods () |
| public | ole_obj_help () |
| public | ole_put_methods () |
| public | setproperty (...) |
Class Method Detail
WIN32OLE.codepage
Returns current codepage.
WIN32OLE.codepage # => WIN32OLE::CP_ACP
WIN32OLE.codepage = CP
Sets current codepage.
WIN32OLE.codepage = WIN32OLE::CP_UTF8
WIN32OLE.connect( ole ) -→ aWIN32OLE
Returns running OLE Automation object or WIN32OLE object from moniker. 1st argument should be OLE program id or class id or moniker.
WIN32OLE.connect('Excel.Application') # => WIN32OLE object which represents running Excel.
WIN32OLE.const_load( ole, mod = WIN32OLE)
Defines the constants of OLE Automation server as mod‘s constants. The first argument is WIN32OLE object or type library name. If 2nd argument is omitted, the default is WIN32OLE. The first letter of Ruby‘s constant variable name is upper case, so constant variable name of WIN32OLE object is capitalized. For example, the ‘xlTop’ constant of Excel is changed to ‘XlTop’ in WIN32OLE. If the first letter of constant variabl is not [A-Z], then the constant is defined as CONSTANTS hash element.
module EXCEL_CONST
end
excel = WIN32OLE.new('Excel.Application')
WIN32OLE.const_load(excel, EXCEL_CONST)
puts EXCEL_CONST::XlTop # => -4160
puts EXCEL_CONST::CONSTANTS['_xlDialogChartSourceData'] # => 541
WIN32OLE.const_load(excel)
puts WIN32OLE::XlTop # => -4160
module MSO
end
WIN32OLE.const_load('Microsoft Office 9.0 Object Library', MSO)
puts MSO::MsoLineSingle # => 1
WIN32OLE.new(server, [host]) → WIN32OLE object
Returns a new WIN32OLE object(OLE Automation object). The first argument server specifies OLE Automation server. The first argument should be CLSID or PROGID. If second argument host specified, then returns OLE Automation object on host.
WIN32OLE.new('Excel.Application') # => Excel OLE Automation WIN32OLE object.
WIN32OLE.new('{00024500-0000-0000-C000-000000000046}') # => Excel OLE Automation WIN32OLE object.
WIN32OLE.ole_free(aWIN32OLE) -→ number
Invokes Release method of Dispatch interface of WIN32OLE object. You should not use this method because this method exists only for debugging WIN32OLE. The return value is reference counter of OLE object.
WIN32OLE.ole_reference_count(aWIN32OLE) -→ number
Returns reference counter of Dispatch interface of WIN32OLE object. You should not use this method because this method exists only for debugging WIN32OLE.
WIN32OLE.ole_show_help(obj [,helpcontext])
Displays helpfile. The 1st argument specifies WIN32OLE_TYPE object or WIN32OLE_METHOD object or helpfile.
excel = WIN32OLE.new('Excel.Application')
typeobj = excel.ole_type
WIN32OLE.ole_show_help(typeobj)
Instance Method Detail
WIN32OLE['property']
Returns property of OLE object.
excel = WIN32OLE.new('Excel.Application')
puts excel['Visible'] # => false
WIN32OLE['property']=val
WIN32OLE.setproperty('property', [arg1, arg2,...] val)
Sets property of OLE object. When you want to set property with argument, you can use this method.
excel = WIN32OLE.new('Excel.Application')
excel['Visible'] = true
book = excel.workbooks.add
sheet = book.worksheets(1)
sheet.setproperty('Cells', 1, 2, 10) # => The B1 cell value is 10.
WIN32OLE#_getproperty(dispid, args, types)
Runs the early binding method to get property. The 1st argument specifies dispatch ID, the 2nd argument specifies the array of arguments, the 3rd argument specifies the array of the type of arguments.
excel = WIN32OLE.new('Excel.Application')
puts excel._getproperty(558, [], []) # same effect as puts excel.visible
WIN32OLE#_invoke(dispid, args, types)
Runs the early binding method. The 1st argument specifies dispatch ID, the 2nd argument specifies the array of arguments, the 3rd argument specifies the array of the type of arguments.
excel = WIN32OLE.new('Excel.Application')
excel._invoke(302, [], []) # same effect as excel.Quit
WIN32OLE#_setproperty(dispid, args, types)
Runs the early binding method to set property. The 1st argument specifies dispatch ID, the 2nd argument specifies the array of arguments, the 3rd argument specifies the array of the type of arguments.
excel = WIN32OLE.new('Excel.Application')
excel._setproperty(558, [true], [WIN32OLE::VARIANT::VT_BOOL]) # same effect as excel.visible = true
WIN32OLE#each {|i|...}
Iterates over each item of OLE collection which has IEnumVARIANT interface.
excel = WIN32OLE.new('Excel.Application')
book = excel.workbooks.add
sheets = book.worksheets(1)
cells = sheets.cells("A1:A5")
cells.each do |cell|
cell.value = 10
end
WIN32OLE#invoke(method, [arg1,...]) => return value of method.
Runs OLE method. The first argument specifies the method name of OLE Automation object. The others specify argument of the method. If you can not execute method directly, then use this method instead.
excel = WIN32OLE.new('Excel.Application')
excel.invoke('Quit') # => same as excel.Quit
WIN32OLE#method_missing(id [,arg1, arg2, ...])
Calls WIN32OLE#invoke method.
WIN32OLE#ole_activex_initialize() → Qnil
Initialize WIN32OLE object(ActiveX Control) by calling IPersistMemory::InitNew.
Before calling OLE method, some kind of the ActiveX controls created with MFC should be initialized by calling IPersistXXX::InitNew.
If and only if you recieved the exception "HRESULT error code: 0x8000ffff catastrophic failure", try this method before invoking any ole_method.
obj = WIN32OLE.new("ProgID_or_GUID_of_ActiveX_Control")
obj.ole_activex_initialize
obj.method(...)
WIN32OLE#ole_free
invokes Release method of Dispatch interface of WIN32OLE object. Usually, you do not need to call this method because Release method called automatically when WIN32OLE object garbaged.
WIN32OLE#ole_func_methods
Returns the array of WIN32OLE_METHOD object . The element of the array is functional method of WIN32OLE object.
excel = WIN32OLE.new('Excel.Application')
properties = excel.ole_func_methods
WIN32OLE#ole_get_methods
Returns the array of WIN32OLE_METHOD object . The element of the array is property (gettable) of WIN32OLE object.
excel = WIN32OLE.new('Excel.Application')
properties = excel.ole_get_methods
WIN32OLE#ole_method_help(method)
Returns WIN32OLE_METHOD object corresponding with method specified by 1st argument.
excel = WIN32OLE.new('Excel.Application')
method = excel.ole_method_help('Quit')
ole_method_help(p1)
Alias for ole_method
WIN32OLE#ole_methods
Returns the array of WIN32OLE_METHOD object. The element is OLE method of WIN32OLE object.
excel = WIN32OLE.new('Excel.Application')
methods = excel.ole_methods
WIN32OLE#ole_obj_help
Returns WIN32OLE_TYPE object.
excel = WIN32OLE.new('Excel.Application')
tobj = excel.ole_obj_help
WIN32OLE#ole_put_methods
Returns the array of WIN32OLE_METHOD object . The element of the array is property (settable) of WIN32OLE object.
excel = WIN32OLE.new('Excel.Application')
properties = excel.ole_put_methods
WIN32OLE['property']=val
WIN32OLE.setproperty('property', [arg1, arg2,...] val)
Sets property of OLE object. When you want to set property with argument, you can use this method.
excel = WIN32OLE.new('Excel.Application')
excel['Visible'] = true
book = excel.workbooks.add
sheet = book.worksheets(1)
sheet.setproperty('Cells', 1, 2, 10) # => The B1 cell value is 10.