ライブラリ
- win32ole (34)
クラス
- WIN32OLE (7)
-
WIN32OLE
_ METHOD (2) -
WIN32OLE
_ PARAM (6) -
WIN32OLE
_ TYPE (9) -
WIN32OLE
_ TYPELIB (5) -
WIN32OLE
_ VARIABLE (5)
キーワード
- default (1)
-
default
_ event _ sources (1) -
default
_ ole _ types (1) -
implemented
_ ole _ types (1) - invoke (1)
-
library
_ name (1) -
ole
_ classes (1) -
ole
_ func _ methods (1) -
ole
_ get _ methods (1) -
ole
_ methods (1) -
ole
_ respond _ to? (1) -
ole
_ type (1) -
ole
_ type _ detail (1) -
ole
_ typelib (2) -
ole
_ types (1) - optional? (1)
- output? (1)
- retval? (1)
- setproperty (2)
-
source
_ ole _ types (1) -
to
_ s (5) - value (1)
- variables (1)
検索結果
先頭5件
-
WIN32OLE
_ METHOD # name -> String (87361.0) -
メソッド名を取得します。
メソッド名を取得します。
@return メソッド名を文字列で返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
puts method.name # => SaveAs -
WIN32OLE
_ PARAM # name -> String (87361.0) -
パラメータ名を取得します。
パラメータ名を取得します。
@return パラメータ名を返します。名前付き引数形式でメソッドを呼び出すときに指定します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
param1 = method.params[0]
puts param1.name # => Filename -
WIN32OLE
_ TYPE # name -> String (87343.0) -
selfの型名を取得します。
selfの型名を取得します。
@return selfの型名を文字列で返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
p tobj.name # => "Application" -
WIN32OLE
_ TYPELIB # name -> String (87343.0) -
TypeLibのドキュメント文字列を取得します。
TypeLibのドキュメント文字列を取得します。
ドキュメント文字列は、コンテキストヘルプなどに利用可能なTypeLibの簡単な
説明文で、通常バージョン番号を含みます。
@return TypeLibのドキュメント文字列を返します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.name # => 'Microsoft Excel 14.0 Object Library' -
WIN32OLE
_ VARIABLE # name -> String (87343.0) -
変数名を取得します。
変数名を取得します。
@return 変数名を文字列で返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
puts "#{variable.name}" # => xlChart, xlDialogSheet, ...
end -
WIN32OLE
# ole _ get _ methods -> [WIN32OLE _ METHOD] (51499.0) -
オブジェクトの参照可能プロパティ情報をWIN32OLE_METHODの配列として 返します。
オブジェクトの参照可能プロパティ情報をWIN32OLE_METHODの配列として
返します。
ole_get_methodsメソッドは、OLEオートメーションサーバのメソッドのうち読
み取り可能なプロパティをWIN32OLE_METHODの配列として返します。
@return WIN32OLE_METHODの配列。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。
excel = WIN32OLE... -
WIN32OLE
# ole _ func _ methods -> [WIN32OLE _ METHOD] (51481.0) -
オブジェクトのファンクション情報をWIN32OLE_METHODの配列として返し ます。
オブジェクトのファンクション情報をWIN32OLE_METHODの配列として返し
ます。
ole_func_methodsメソッドは、OLEオートメーションサーバのメソッドのうちファ
ンクション(何らかの機能的な操作)に属するものをWIN32OLE_METHODの
配列として返します。
@return WIN32OLE_METHODの配列。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。
exc... -
WIN32OLE
# ole _ typelib -> WIN32OLE _ TYPELIB (51445.0) -
オブジェクトに対応する型情報ライブラリ(TypeLib)を WIN32OLE_TYPELIBとして返します。
オブジェクトに対応する型情報ライブラリ(TypeLib)を
WIN32OLE_TYPELIBとして返します。
OLEオートメーションではクラス、インターフェイス、メソッド、引数などの型
情報と文書情報を型情報ライブラリとして利用します。型情報ライブラリは独
立したファイル(拡張子tlb)の場合もあれば、オブジェクトのバイナリへリソー
スとして埋め込まれている場合があります。
OLEオートメーションでは型情報ライブラリの提供方法を問わずに統一したイン
ターフェイスでアプリケーションが参照できるように、オブジェクトの形式
(ITypeInfoインターフェイス)で提供します。WIN32OLEは... -
WIN32OLE
# invoke(name , *args) -> object | nil (51361.0) -
メソッド名を指定してオブジェクトのメソッドを呼び出します。
メソッド名を指定してオブジェクトのメソッドを呼び出します。
OLEオートメーションサーバのメソッドを動的に呼び出したい場合に利用します。
なお、OLEオートメーションの仕様により、メソッド名の大文字、小文字は区別
されません。
@param name メソッド名を文字列またはシンボルで指定します。
@param args メソッドの引数を指定します。また、最後の引数にHashを
与えることで、名前付き引数を指定できます。この場合、キーに
文字列またはシンボルでパラメータ名、値に引数を指定します。
@return メソッドの返り値。ただし返り... -
WIN32OLE
# ole _ respond _ to?(name) -> bool (51361.0) -
指定したメソッドをオブジェクトがサポートしているか調べます。
指定したメソッドをオブジェクトがサポートしているか調べます。
OLEオートメーションサーバが引数で指定した名前のメソッド(プロパティ)を
サポートしているかどうかを調べます。
なお、OLEオートメーションの仕様により、メソッド名の大文字、小文字は区別
されません。
@param name 調べるメソッド名を文字列またはシンボルで指定します。
@return nameで指定したメソッドをオブジェクトが提供していれば真を返します。
excel = WIN32OLE.new('Excel.Application')
excel.ole_respond_to?(:quit) #=... -
WIN32OLE
# setproperty(name , args . . . , val) -> () (51346.0) -
オブジェクトのプロパティを設定します。
オブジェクトのプロパティを設定します。
プロパティ名を指定してOLEオートメーションオブジェクトのプロパティ
(Rubyの属性に相当)を設定します。
なお、OLEオートメーションの仕様により、プロパティ名の大文字、小文字は区
別されません。
@param name プロパティ名を文字列またはシンボルで指定します。
@param val プロパティに設定する値を指定します。
@param args 集合的なプロパティに対する設定項目を特定するための引数を指
定します。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗し... -
WIN32OLE
# setproperty(name , val) -> () (51346.0) -
オブジェクトのプロパティを設定します。
オブジェクトのプロパティを設定します。
プロパティ名を指定してOLEオートメーションオブジェクトのプロパティ
(Rubyの属性に相当)を設定します。
なお、OLEオートメーションの仕様により、プロパティ名の大文字、小文字は区
別されません。
@param name プロパティ名を文字列またはシンボルで指定します。
@param val プロパティに設定する値を指定します。
@param args 集合的なプロパティに対する設定項目を特定するための引数を指
定します。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗し... -
WIN32OLE
_ TYPELIB # library _ name -> String (51343.0) -
TypeLibのヘルプファイル用ドキュメント文字列からTypeLibの名前を取得します。
TypeLibのヘルプファイル用ドキュメント文字列からTypeLibの名前を取得します。
@return TypeLibの名前を文字列で返します。
@raise WIN32OLERuntimeError ドキュメント文字列が取得できなかった場合に通知します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
tlib.library_name # => Excel -
WIN32OLE
_ METHOD # to _ s -> String (42061.0) -
メソッド名を取得します。
メソッド名を取得します。
@return メソッド名を文字列で返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
puts method.name # => SaveAs -
WIN32OLE
_ PARAM # to _ s -> String (42061.0) -
パラメータ名を取得します。
パラメータ名を取得します。
@return パラメータ名を返します。名前付き引数形式でメソッドを呼び出すときに指定します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
param1 = method.params[0]
puts param1.name # => Filename -
WIN32OLE
_ TYPE # to _ s -> String (42043.0) -
selfの型名を取得します。
selfの型名を取得します。
@return selfの型名を文字列で返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
p tobj.name # => "Application" -
WIN32OLE
_ TYPELIB # to _ s -> String (42043.0) -
TypeLibのドキュメント文字列を取得します。
TypeLibのドキュメント文字列を取得します。
ドキュメント文字列は、コンテキストヘルプなどに利用可能なTypeLibの簡単な
説明文で、通常バージョン番号を含みます。
@return TypeLibのドキュメント文字列を返します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.name # => 'Microsoft Excel 14.0 Object Library' -
WIN32OLE
_ VARIABLE # to _ s -> String (42043.0) -
変数名を取得します。
変数名を取得します。
@return 変数名を文字列で返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
puts "#{variable.name}" # => xlChart, xlDialogSheet, ...
end -
WIN32OLE
_ TYPE # default _ event _ sources -> [WIN32OLE _ TYPE] (33703.0) -
型が持つソースインターフェイスを取得します。
型が持つソースインターフェイスを取得します。
default_event_sourcesメソッドは、selfがCoClass(コンポーネントクラス)
の場合、そのクラスがサポートするデフォルトのソースインターフェイス(イ
ベントの通知元となるインターフェイス)を返します。
@return デフォルトのソースインターフェイスをWIN32OLE_TYPEの配列と
して返します。返すのは配列ですが、デフォルトのソースインターフェ
イスは最大でも1インターフェイスです。ソースインターフェイスを持
たない場合は空配列を返します。
tobj = ... -
WIN32OLE
_ TYPE # variables -> [WIN32OLE _ VARIABLE] (33397.0) -
型が持つ変数を取得します。
型が持つ変数を取得します。
型がEnum(列挙型)やユーザ定義型の場合、メンバ変数の情報を
WIN32OLE_VARIABLEオブジェクトの配列として返します。
@return 型が持つ変数情報をWIN32OLE_VARIABLEの配列として返します。
変数を持たない場合は空配列を返します。
@raise WIN32OLERuntimeError 型属性が取得できない場合に通知します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
vars = to... -
WIN32OLE
_ TYPE # ole _ methods -> [WIN32OLE _ METHOD] (33379.0) -
型が持つメソッドのメタデータを取得します。
型が持つメソッドのメタデータを取得します。
@return 型が持つメソッドのメタデータをWIN32OLE_METHODの配列として返します。
メソッドを持たない場合は空配列を返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
methods = tobj.ole_methods.map {|m| m.name }
# => ['QueryInterface', 'AddRef', 'Release',..... -
WIN32OLE
_ TYPE # source _ ole _ types -> [WIN32OLE _ TYPE] (33379.0) -
型が持つソースインターフェイスを取得します。
型が持つソースインターフェイスを取得します。
source_ole_typesメソッドは、selfがCoClass(コンポーネントクラス)の場合、
そのクラスがサポートするすべてのソースインターフェイス(イベントの通知
元となるインターフェイス)を返します。
ActiveXコントロールのようにイベント(WIN32OLE_EVENT)をサポートし
ているコンポーネントクラスの場合は、このメソッドの呼び出しによりイベン
トインターフェイスを調べることが可能です。
@return ソースインターフェイスをWIN32OLE_TYPEの配列として返します。
ソースインターフェイスを... -
WIN32OLE
_ TYPELIB # ole _ classes -> [WIN32OLE _ TYPE] (33364.0) -
TypeLibに格納されているすべての型を取得します。
TypeLibに格納されているすべての型を取得します。
TypeLibに格納されている型には、クラス(CoClass——コンポーネントクラス)
やEnum(列挙子)、構造体などがあります。
@return TypeLibに格納されているすべての型をWIN32OLE_TYPEオブジェ
クトの配列として返します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
classes = tlib.ole_types.map{|k| k.name} # => ["Adjustments... -
WIN32OLE
_ TYPELIB # ole _ types -> [WIN32OLE _ TYPE] (33364.0) -
TypeLibに格納されているすべての型を取得します。
TypeLibに格納されているすべての型を取得します。
TypeLibに格納されている型には、クラス(CoClass——コンポーネントクラス)
やEnum(列挙子)、構造体などがあります。
@return TypeLibに格納されているすべての型をWIN32OLE_TYPEオブジェ
クトの配列として返します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
classes = tlib.ole_types.map{|k| k.name} # => ["Adjustments... -
WIN32OLE
_ TYPE # default _ ole _ types -> [WIN32OLE _ TYPE] (33361.0) -
型が持つデフォルトのインターフェイスを取得します。
型が持つデフォルトのインターフェイスを取得します。
default_ole_typesメソッドは、selfがCoClass(コンポーネントクラス)の場
合、そのクラスが実装しているデフォルトのインターフェイスと、サポートし
ていればデフォルトのソースインターフェイスを返します。
@return デフォルトインターフェイスをWIN32OLE_TYPEの配列として返し
ます。デフォルトインターフェイスは、最大でも、クラス操作用のイ
ンターフェイス(OLEオートメーション用)と、イベント用のソースイ
ンターフェイスの2要素です。デフォルトインターフ... -
WIN32OLE
_ TYPE # implemented _ ole _ types -> [WIN32OLE _ TYPE] (33361.0) -
この型が実装するインターフェイスを取得します。
この型が実装するインターフェイスを取得します。
implemented_ole_typesメソッドは、selfがCoClass(コンポーネントクラス)
の場合、そのクラスが実装しているすべてのインターフェイスを返します。
@return クラスが実装するすべてのインターフェイスをWIN32OLE_TYPEの
配列として返します。この型がインターフェイスを実装しない場合は、
空配列を返します。
@raise WIN32OLERuntimeError 型属性が取得できない場合に通知します。
tobj = WIN32OLE_TYPE.new('Micro... -
WIN32OLE
_ TYPE # ole _ typelib -> WIN32OLE _ TYPELIB | nil (33361.0) -
この型を登録してある型情報ライブラリ(TypeLib)を取得します。
この型を登録してある型情報ライブラリ(TypeLib)を取得します。
@return この型を登録しているTypeLibをWIN32OLE_TYPELIBオブジェクト
として返します。見つからない場合はnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
puts tobj.ole_typelib.name # => 'Microsoft Excel 14.0 Object Library' -
WIN32OLE
_ PARAM # output? -> bool (33094.0) -
パラメータがクライアントからの結果を受け取るためのものかを判定します。
パラメータがクライアントからの結果を受け取るためのものかを判定します。
OLEオートメーションのパラメータは、in(クライアントからサーバへ与える。
WIN32OLE_PARAM#input?が真)、out(サーバがクライアントへ与える。
WIN32OLE_PARAM#output?が真)および、inout(クライアントからサーバ
へ与え、サーバがクライアントへ与える)の3種類の方向属性のいずれかを持ち
ます。
output?メソッドはout属性またはinout属性なら真を返します。
@return メソッドの方向属性がoutまたはinoutならば真を返します。
tobj = W... -
WIN32OLE
_ PARAM # retval? -> bool (33094.0) -
パラメータが戻り値かどうかを判定します。
パラメータが戻り値かどうかを判定します。
OLEオートメーションの規定では、メソッドの戻り値は引数リストの最右端のパ
ラメータをout属性(WIN32OLE_PARAM#output?が真)とすることで実現し
ます。ただし、そのパラメータをOLEオートメーション呼び出しを記述する言語
が戻り値のように扱うか、それとも引数リストに並べるかはretval属性によっ
て決定されます。
retval?メソッドは、戻り値として記述する場合に真となります。
@return パラメータが戻り値として扱われる場合に真を返します。
tobj = WIN32OLE_TYPE.new('DirectX... -
WIN32OLE
_ VARIABLE # ole _ type _ detail -> [String] (33094.0) -
変数の型と属性を取得します。
変数の型と属性を取得します。
@return 変数の型と属性を文字列配列で返します。
tobj = WIN32OLE_TYPE.new('Microsoft XML, v5.0', 'tagSTATSTG')
tobj.variables.each do |v|
puts "#{v.ole_type} [#{v.ole_type_detail.join(', ')}] #{v.name}"
end
出力結果
Unknown Type 31 [] pwcsName # => VT_LPWSTR はWIN32OLE::VARIANTで未定義なので変換でき... -
WIN32OLE
_ PARAM # default -> object | nil (33058.0) -
パラメータを指定しなかった場合の既定値を取得します。
パラメータを指定しなかった場合の既定値を取得します。
当パラメータが必須パラメータの場合はnilを返します。
@return パラメータを指定しなかった場合の既定値。必須パラメータならばnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
method.params.each do |param|
if param.default
puts "... -
WIN32OLE
_ PARAM # optional? -> bool (33058.0) -
パラメータがオプションかどうかを取得します。
パラメータがオプションかどうかを取得します。
@return パラメータがオプション(省略可能)であれば真を返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
param1 = method.params[0]
puts "#{param1.name} #{param1.optional?}" # => Filename true -
WIN32OLE
_ VARIABLE # ole _ type -> String (33058.0) -
変数の型を取得します。
変数の型を取得します。
@return 変数の型名を文字列で返します。型名を文字列に変換できない場合は、
「Unknown Type nn」(nnはバリアント型を示す数値)の形式の文字列
を返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
puts "#{variable.ole_type} #{variabl... -
WIN32OLE
_ VARIABLE # value -> object | nil (33040.0) -
変数の値を取得します。
変数の値を取得します。
変数情報によってはenum値のように定数値を持つものがあります。valueメソッ
ドはこのような定数値を返します。
@return この変数が持つ定数値。値を持たない場合はnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
puts "#{variable.name}=#{variable.value...