class WIN32OLE_TYPE - RDoc Documentation

# class WIN32OLE_TYPE

`WIN32OLE_TYPE` objects represent OLE type libarary information.

### Public Class Methods

new(typelib, ole_class) → WIN32OLE_TYPE object click to toggle source

Returns a new `WIN32OLE_TYPE` object. The first argument typelib specifies OLE type library name. The second argument specifies OLE class name.

    WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Application')
        # => WIN32OLE_TYPE object of Application class of Excel.

    static VALUE
    foletype_initialize(VALUE self, VALUE typelib, VALUE oleclass)
    {
        VALUE file;
        OLECHAR * pbuf;
        ITypeLib *pTypeLib;
        HRESULT hr;

        SafeStringValue(oleclass);
        SafeStringValue(typelib);
        file = typelib_file(typelib);
        if (file == Qnil) {
            file = typelib;
        }
        pbuf = ole_vstr2wc(file);
        hr = LoadTypeLibEx(pbuf, REGKIND_NONE, &pTypeLib);
        if (FAILED(hr))
            ole_raise(hr, eWIN32OLERuntimeError, "failed to LoadTypeLibEx");
        SysFreeString(pbuf);
        if (oleclass_from_typelib(self, pTypeLib, oleclass) == Qfalse) {
            OLE_RELEASE(pTypeLib);
            rb_raise(eWIN32OLERuntimeError, "not found `%s` in `%s`",
                     StringValuePtr(oleclass), StringValuePtr(typelib));
        }
        OLE_RELEASE(pTypeLib);
        return self;
    }

ole_classes(typelib) click to toggle source

Returns array of `WIN32OLE_TYPE` objects defined by the typelib type library. This method will be OBSOLETE. Use `WIN32OLE_TYPELIB.new(typelib)`.ole_classes instead.

    static VALUE
    foletype_s_ole_classes(VALUE self, VALUE typelib)
    {
        VALUE obj;

        /*
        rb_warn("%s is obsolete; use %s instead.",
                "WIN32OLE_TYPE.ole_classes",
                "WIN32OLE_TYPELIB.new(typelib).ole_types");
        */
        obj = rb_funcall(cWIN32OLE_TYPELIB, rb_intern("new"), 1, typelib);
        return rb_funcall(obj, rb_intern("ole_types"), 0);
    }

progids click to toggle source

Returns array of ProgID.

    static VALUE
    foletype_s_progids(VALUE self)
    {
        HKEY hclsids, hclsid;
        DWORD i;
        LONG err;
        VALUE clsid;
        VALUE v = rb_str_new2("");
        VALUE progids = rb_ary_new();

        err = reg_open_key(HKEY_CLASSES_ROOT, "CLSID", &hclsids);
        if(err != ERROR_SUCCESS) {
            return progids;
        }
        for(i = 0; ; i++) {
            clsid = reg_enum_key(hclsids, i);
            if (clsid == Qnil)
                break;
            err = reg_open_vkey(hclsids, clsid, &hclsid);
            if (err != ERROR_SUCCESS)
                continue;
            if ((v = reg_get_val2(hclsid, "ProgID")) != Qnil)
                rb_ary_push(progids, v);
            if ((v = reg_get_val2(hclsid, "VersionIndependentProgID")) != Qnil)
                rb_ary_push(progids, v);
            RegCloseKey(hclsid);
        }
        RegCloseKey(hclsids);
        return progids;
    }

typelibs click to toggle source

Returns array of type libraries. This method will be OBSOLETE. Use `WIN32OLE_TYPELIB.typelibs`.collect{|t| t.name} instead.

    static VALUE
    foletype_s_typelibs(VALUE self)
    {
        /*
        rb_warn("%s is obsolete. use %s instead.",
                "WIN32OLE_TYPE.typelibs",
                "WIN32OLE_TYPELIB.typelibs.collect{t|t.name}");
        */
        return rb_eval_string("WIN32OLE_TYPELIB.typelibs.collect{|t|t.name}");
    }

### Public Instance Methods

WIN32OLE_TYPE#default_event_sources click to toggle source

Returns the array of `WIN32OLE_TYPE` object which is implemented by the `WIN32OLE_TYPE` object and having IMPLTYPEFLAG_FSOURCE and IMPLTYPEFLAG_FDEFAULT.

    tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', "InternetExplorer")
    p tobj.default_event_sources  # => [#<WIN32OLE_TYPE:DWebBrowserEvents2>]

    static VALUE
    foletype_default_event_sources(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_type_impl_ole_types(pTypeInfo, IMPLTYPEFLAG_FSOURCE|IMPLTYPEFLAG_FDEFAULT);
    }

WIN32OLE_TYPE#default_ole_types click to toggle source

Returns the array of `WIN32OLE_TYPE` object which is implemented by the `WIN32OLE_TYPE` object and having IMPLTYPEFLAG_FDEFAULT.

    tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', "InternetExplorer")
    p tobj.default_ole_types
    # => [#<WIN32OLE_TYPE:IWebBrowser2>, #<WIN32OLE_TYPE:DWebBrowserEvents2>]

    static VALUE
    foletype_default_ole_types(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_type_impl_ole_types(pTypeInfo, IMPLTYPEFLAG_FDEFAULT);
    }

WIN32OLE_TYPE#guid #→ GUID click to toggle source

Returns GUID.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Application')
    puts tobj.guid  # => {00024500-0000-0000-C000-000000000046}

    static VALUE
    foletype_guid(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_type_guid(pTypeInfo);
    }

WIN32OLE_TYPE#helpcontext click to toggle source

Returns helpcontext. If helpcontext is not found, then returns nil.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Worksheet')
    puts tobj.helpfile # => 131185

    static VALUE
    foletype_helpcontext(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_type_helpcontext(pTypeInfo);
    }

WIN32OLE_TYPE#helpfile click to toggle source

Returns helpfile path. If helpfile is not found, then returns nil.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Worksheet')
    puts tobj.helpfile # => C:\...\VBAXL9.CHM

    static VALUE
    foletype_helpfile(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_type_helpfile(pTypeInfo);
    }

WIN32OLE_TYPE#helpstring #→ help string. click to toggle source

Returns help string.

    tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', 'IWebBrowser')
    puts tobj.helpstring # => Web Browser interface

    static VALUE
    foletype_helpstring(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_type_helpstring(pTypeInfo);
    }

WIN32OLE_TYPE#implemented_ole_types click to toggle source

Returns the array of `WIN32OLE_TYPE` object which is implemented by the `WIN32OLE_TYPE` object.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Worksheet')
    p tobj.implemented_ole_types # => [_Worksheet, DocEvents]

    static VALUE
    foletype_impl_ole_types(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_type_impl_ole_types(pTypeInfo, 0);
    }

WIN32OLE_TYPE#inspect → String click to toggle source

Returns the type name with class name.

    ie = WIN32OLE.new('InternetExplorer.Application')
    ie.ole_type.inspect => #<WIN32OLE_TYPE:IWebBrowser2>

    static VALUE
    foletype_inspect(VALUE self)
    {
        return default_inspect(self, "WIN32OLE_TYPE");
    }

WIN32OLE_TYPE#major_version click to toggle source

Returns major version.

    tobj = WIN32OLE_TYPE.new('Microsoft Word 10.0 Object Library', 'Documents')
    puts tobj.major_version # => 8

    static VALUE
    foletype_major_version(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_type_major_version(pTypeInfo);
    }

WIN32OLE_TYPE#minor_version #→ OLE minor version click to toggle source

Returns minor version.

    tobj = WIN32OLE_TYPE.new('Microsoft Word 10.0 Object Library', 'Documents')
    puts tobj.minor_version # => 2

    static VALUE
    foletype_minor_version(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_type_minor_version(pTypeInfo);
    }

WIN32OLE_TYPE#name #→ OLE type name click to toggle source

Returns OLE type name.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Application')
    puts tobj.name  # => Application

    static VALUE
    foletype_name(VALUE self)
    {
        return rb_ivar_get(self, rb_intern("name"));
    }

Also aliased as: to_s
WIN32OLE_TYPE#ole_methods # the array of WIN32OLE_METHOD objects. click to toggle source

Returns array of `WIN32OLE_METHOD` objects which represent OLE method defined in OLE type library.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Worksheet')
    methods = tobj.ole_methods.collect{|m|
      m.name
    }
    # => ['Activate', 'Copy', 'Delete',....]

    static VALUE
    foletype_methods(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_methods_from_typeinfo(pTypeInfo, INVOKE_FUNC | INVOKE_PROPERTYGET | INVOKE_PROPERTYPUT | INVOKE_PROPERTYPUTREF);
    }

WIN32OLE_TYPE#ole_type #→ OLE type string. click to toggle source

returns type of OLE class.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Application')
    puts tobj.ole_type  # => Class

    static VALUE
    foletype_ole_type(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_ole_type(pTypeInfo);
    }

WIN32OLE_TYPE#ole_typelib click to toggle source

Returns the `WIN32OLE_TYPELIB` object which is including the `WIN32OLE_TYPE` object. If it is not found, then returns nil.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Worksheet')
    puts tobj.ole_typelib # => 'Microsoft Excel 9.0 Object Library'

    static VALUE
    foletype_ole_typelib(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_typelib_from_itypeinfo(pTypeInfo);
    }

WIN32OLE_TYPE#progid #→ ProgID click to toggle source

Returns ProgID if it exists. If not found, then returns nil.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Application')
    puts tobj.progid  # =>   Excel.Application.9

    static VALUE
    foletype_progid(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_type_progid(pTypeInfo);
    }

WIN32OLE_TYPE#source_ole_types click to toggle source

Returns the array of `WIN32OLE_TYPE` object which is implemented by the `WIN32OLE_TYPE` object and having IMPLTYPEFLAG_FSOURCE.

    tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', "InternetExplorer")
    p tobj.source_ole_types
    # => [#<WIN32OLE_TYPE:DWebBrowserEvents2>, #<WIN32OLE_TYPE:DWebBrowserEvents>]

    static VALUE
    foletype_source_ole_types(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_type_impl_ole_types(pTypeInfo, IMPLTYPEFLAG_FSOURCE);
    }

WIN32OLE_TYPE#src_type #→ OLE source class click to toggle source

Returns source class when the OLE class is 'Alias'.

    tobj =  WIN32OLE_TYPE.new('Microsoft Office 9.0 Object Library', 'MsoRGBType')
    puts tobj.src_type # => I4

    static VALUE
    foletype_src_type(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_type_src_type(pTypeInfo);
    }

WIN32OLE_TYPE#name #→ OLE type name

Returns OLE type name.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Application')
    puts tobj.name  # => Application

Alias for: name
WIN32OLE_TYPE#typekind #→ number of type. click to toggle source

Returns number which represents type.

    tobj = WIN32OLE_TYPE.new('Microsoft Word 10.0 Object Library', 'Documents')
    puts tobj.typekind # => 4

    static VALUE
    foletype_typekind(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_type_typekind(pTypeInfo);
    }

WIN32OLE_TYPE#variables click to toggle source

Returns array of `WIN32OLE_VARIABLE` objects which represent variables defined in OLE class.

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

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

    static VALUE
    foletype_variables(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_variables(pTypeInfo);
    }

WIN32OLE_TYPE#visible? #→ true or false click to toggle source

Returns true if the OLE class is public.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Application')
    puts tobj.visible  # => true

    static VALUE
    foletype_visible(VALUE self)
    {
        ITypeInfo *pTypeInfo = itypeinfo(self);
        return ole_type_visible(pTypeInfo);
    }