Click イベントの使用例

次の例は、WithEvents イベントと Set ステートメントを使用して、Click イベント プロシージャにコードを組み込む方法を示します。オブジェクトへの参照を示す変数 ce は、[ツール] メニューの代わりに Click イベントの名前に使われています。

Private WithEvents ce As CommandBarEvents

Sub Test()

    Dim c As CommandBarControl

    Set c = Application.VBE.CommandBars("Tools").Controls(1)

    Set ce = Application.VBE.Events.CommandBarEvents(c)

End Sub

Private Sub ce_Click(ByVal CommandBarControl As Object, Handled As Boolean, CancelDefault As Boolean)

    ' イベント処理コードを記述する。

End Sub


Click イベント
Click イベント (VBA アドイン オブジェクト モデル)

対応するコマンド バー コントロールの OnAction プロパティが設定されたときに発生します。

構文

Sub object_Click (ByVal ctrl As Object, ByRef handled As Boolean, ByRef canceldefault As Boolean)

Click イベントの構文は、次の名前付き引数から構成されています。

指定項目	内容
ctrl	必ず指定します。オブジェクト型 (Object) の値を指定します。Click イベントの発生元のオブジェクトを指定します。
handled	必ず指定します。ブール型 (Boolean) の値を指定します。真 (True) を設定すると、他のアドインによってイベントが処理されます。偽 (False) を設定すると、コマンド バー項目の処理は実行されません。
canceldefault	必ず指定します。ブール型 (Boolean) の値を指定します。真 (True) を設定すると、下位のアドインでキャンセルされない限り、既定の処理が実行されます。偽 (False) を設定すると、下位のアドインで真 (True) に設定されない限り、既定の処理は実行されません。
解説

Click イベントは、CommandBarEvents オブジェクトに固有のイベントです。キーワード WithEvents を指定して宣言した変数を使用して、コマンド バー (CommandBar) コントロールの Click イベントを受け取ります。この変数は、Events オブジェクトの CommandBarEvents プロパティの戻り値に設定されます。CommandBarEvents プロパティでは、コマンド バー (CommandBar) コントロールを引数として受け取ります。キーワード WithEvents を使って宣言した変数のコマンド バー (CommandBar) コントロールをクリックすると、コードが実行されます。


ItemAdded イベント
ItemAdded イベント (VBA アドイン オブジェクト モデル)

プロジェクトに参照が追加されたときにイベントが発生します。

構文

Sub object_ItemAdded(ByVal item As Reference)

引数 item は必ず指定します。この引数には、追加された項目を指定します。

解説

ItemAdded イベントは、Reference オブジェクトが References コレクションに追加されたときに発生します。


ItemRemoved イベント
ItemRemoved イベント (VBA アドイン オブジェクト モデル)

プロジェクトから参照が削除されたときにイベントが発生します。

構文

Sub object_ItemRemoved(ByVal item As Reference)

引数 item は必ず指定します。この引数には、削除された Reference オブジェクトを指定します。


Add メソッド (VBA アドイン オブジェクト モデル)

コレクションにオブジェクトを追加します。

構文

object.Add(component)

Add メソッドの構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
component	必ず指定します。LinkedWindows コレクションには、オブジェクトを指定します。VBComponents コレクションには、クラス モジュール、フォーム、または標準モジュールを表す定数を指定します。 VBProjects コレクションには、プロジェクト タイプを表す定数列挙を指定します。
次のいずれかの定数を引数 component に使用できます。

定数	内容
vbext_ct_ClassModule	コレクションにクラス モジュールを追加します。
vbext_ct_MSForm	コレクションにフォームを追加します。
vbext_ct_StdModule	コレクションに標準モジュールを追加します。
vbext_pt_StandAlone	コレクションにスタンドアロン プロジェクトを追加します。
解説

LinkedWindows コレクションでは、Add メソッドによって現在のリンク ウィンドウのコレクションにウィンドウが追加されます。

メモ   1 つのリンク ウィンドウ フレームのペインであるウィンドウを、別のリンクされたウィンドウ フレームに追加できます。ウィンドウは一方のペインからもう一方のペインに移動されるだけです。ウィンドウの移動元であるリンク ウィンドウ フレームにペインが残っていない場合は、そのウィンドウ フレームは破棄されます。

重要   Macintosh バージョンでは、Windows で作成されたコードとの互換性のために、リンク ウィンドウ、リンク ウィンドウ フレームおよびドッキング ウィンドウを制御するオブジェクト、プロパティおよびメソッドが含まれていますが、これらの言語要素を含むコードを Macintosh 上で実行した場合、実行時エラーが発生します。

VBComponents コレクションでは、Add メソッドによって標準コンポーネントが新しく作成され、プロジェクトに追加されます。

VBComponents コレクションでは、Add メソッドは VBComponent オブジェクトを返します。LinkedWindows コレクションでは、Add メソッドは Nothing を返します。

VBProjects コレクションでは、Add メソッドは VBProject オブジェクトを返し、VBProjects コレクションにプロジェクトを追加します。


AddFromFile メソッド

References コレクションでは、ファイルからプロジェクトに参照を追加します。CodeModule オブジェクトでは、ファイルの内容をモジュールに追加します。

構文

object.AddFromFile(filename)

AddFromFile メソッドの構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
filename	必ず指定します。プロジェクトまたはモジュールに追加するファイルの名前を表す文字列式を指定します。ファイル名が見つからず、パス名が指定されていない場合は、Microsoft Windows の OpenFile 関数が使われ、決められた順序でフォルダ内のファイルが検索されます。
解説

CodeModule オブジェクトで AddFromFile メソッドを呼び出すと、コード モジュール内の最初のプロシージャの前の行から、ファイルの内容の挿入が開始されます。モジュールにプロシージャがない場合は、AddFromFile メソッドによってファイルの内容がモジュールの最後に追加されます。


AddCustom メソッド

VBComponent オブジェクトを返します。または、新しいカスタム コンポーネントを作成し、プロジェクトに追加します。

構文

object.AddCustom (ByVal progid As String) As VBComponent

AddCustom メソッドの構文は、次の指定項目から構成されます。

指定項目	内容
object	オブジェクトへの参照を表すオブジェクト式を指定します。
progid	必ず指定します。作成されるカスタム コンポーネントのプログラム ID (ProgID) を指定します。


AddFromGuid メソッド

GUID (Globally Unique Identifier) を使用して、References コレクションに参照を追加します。

構文

object.AddFromGuid(guid, major, minor) As Reference

AddFromGuid メソッドの構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
guid	必ず指定します。参照の GUID を表す文字列式を指定します。
major	必ず指定します。参照のメジャー バージョン番号を表す長整数型 (Long) の値を指定します。
minor	必ず指定します。参照のマイナ バージョン番号を表す長整数型 (Long) の値を指定します。
解説

AddFromGuid メソッドによって、追加する参照がレジストリ内で検索されます。GUID には、タイプ ライブラリ、コントロール、クラス識別子などがあります。


AddFromString メソッド

モジュールに文字列を追加します。

構文

object.AddFromString

引数 object には、オブジェクトへの参照を表すオブジェクト式を指定します。

解説

AddFromString メソッドを呼び出すと、モジュール内の最初のプロシージャの前の行から、文字列の挿入が開始されます。モジュールにプロシージャがない場合は、AddFromString メソッドによって文字列がモジュールの最後に追加されます。


Close メソッド (VBA アドイン オブジェクト モデル)

ウィンドウを閉じて破棄します。

構文

object.Close

引数 object には、オブジェクトへの参照を表すオブジェクト式を指定します。

解説

次の種類のウィンドウに対して、Close メソッドはそれぞれ異なる結果を返します。

•	コード ペインのウィンドウでは、コード ペインが破棄されます。

•	デザイナのウィンドウでは、含まれているデザイナが破棄されます。

[表示] メニューで常に使用できるウィンドウでは、そのウィンドウは非表示になります。


CreateEventProc メソッド

イベント プロシージャを作成します。

構文

object.CreateEventProc(eventname, objectname) As Long

CreateEventProc の構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
eventname	必ず指定します。モジュールに追加するイベントの名前を表す文字列式を指定します。
objectname	必ず指定します。イベントの発生元のオブジェクトの名前を表す文字列式を指定します。
解説

CreateEventProc メソッドを使用して、イベント プロシージャを作成します。たとえば、Command1 という名前のコマンド ボタン (Command Button) コントロールの Click イベントに対してイベント プロシージャを作成するには、次のコードを使用します。このコードでは、CM は CodeModule 型のオブジェクトであることを表します。

TextLocation = CM.CreateEventProc("Click", "Command1")

CreateEventProc メソッドは、イベント プロシージャが開始されるコード行を返します。引数に存在しないイベントを指定して参照すると、CreateEventProc メソッドは失敗します。


CreateToolWindow メソッド

UserDocument オブジェクトを含む新しいツール ウィンドウを作成します。

構文

object.CreateToolWindow (AddInInst, ProgID, Caption, GuidPosition, DocObj) As Window

CreateToolWindow メソッドの構文は、次の指定項目から構成されます。

指定項目	内容
object	オブジェクトへの参照を表すオブジェクト式を指定します。
AddInInst	必ず指定します。開発環境のアドインを表わすアドイン インスタンス変数を指定します。
ProgID	必ず指定します。UserDocument オブジェクトのプログラム ID (ProgID) を表す文字列を指定します。
Caption	必ず指定します。ウィンドウの標題を含む文字列を指定します。
GuidPosition	必ず指定します。ウィンドウ固有の識別子を含む文字列を指定します。
DocObj	必ず指定します。この引数には、UserDocument オブジェクトである、defObject を指定します。このオブジェクトは、この関数の呼び出し時に設定されます。


DeleteLines メソッド

1 行または指定された範囲の行を削除します。

構文

object.DeleteLines (startline [, count])

DeleteLines メソッドの構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
startline	必ず指定します。削除する最初の行を表す長整数型 (Long) の値を指定します。
count	省略可能です。削除する行数を表す長整数型 (Long) を指定します。
解説

削除する行数を指定しない場合は、1 行だけ削除されます。


DesignerWindow メソッド

コンポーネントのデザイナを表す Window オブジェクトを返します。

構文

object.DesignerWindow

引数 object には、オブジェクトへの参照を表すオブジェクト式を指定します。

解説

デザイナをサポートしているコンポーネントで、デザイナーが開かれていない場合に DesignerWindow プロパティを参照すると、デザイナが作成されます。ただし、デザイナは表示されません。ウィンドウを表示するには、Window オブジェクトの Visible プロパティに真 (True) を設定します。


Export メソッド (VBA アドイン オブジェクト モデル)

コンポーネントを別のファイルとして保存します。

構文

object.Export(filename)

Export メソッドの構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
filename	必ず指定します。コンポーネントをエクスポートするファイルの名前を表す文字列型 (String) の値を指定します。
解説

Export メソッドを使って、コンポーネントを別のファイルとして保存するときは、既存のファイルの名前と重複しない名前を使用します。既存のファイルと同じ名前を使用するとエラーになります。


Find メソッド (VBA アドイン オブジェクト モデル)

アクティブ モジュール内で指定した文字列を検索します。

構文

object.Find(target, startline, startcol, endline, endcol [, wholeword] [, matchcase] [, patternsearch]) As Boolean

Find メソッドの構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
target	必ず指定します。検索する文字列またはパターンを表す文字列型 (String) の値を指定します。
startline	必ず指定します。検索を開始する行を表す長整数型 (Long) の値を指定します。検索で文字列が見つかった場合は、その行が設定されます。最初の行番号は 1 になります。
startcol	必ず指定します。検索を開始する桁を表す長整数型 (Long) を指定します。検索で文字列が見つかった場合は、その桁が設定されます。最初の桁番号は 1 になります。
endline	必ず指定します。検索する範囲の最終行を表す長整数型 (Long) の値を指定します。-1 で最終行を指定できます。
endcol	必ず指定します。検索する範囲の最終桁を表す長整数型 (Long) を指定します。-1 で最終桁を指定できます。
wholeword	省略可能です。完全に一致する単語だけを検索するかどうかを示すブール型 (Boolean) の値を指定します。True を設定すると、完全に一致する単語だけが検索されます。既定値は False です。
matchcase	省略可能です。大文字および小文字を一致させるかどうかを示すブール型 (Boolean) の値を指定します。True を設定すると、大文字および小文字を区別して検索が行われます。既定値は False です。
patternsearch	省略可能です。検索対象の文字列がパターン マッチングの形式であるかどうかを示すブール型 (Boolean) の値を指定します。True を設定すると、検索対象の文字列はパターン マッチングの形式であるとみなされます。既定値は False です。
解説

検索で見つかった場合は真 (True) が返され、見つからなかった場合は偽 (False) が返されます。

引数 matchcase と引数 patternmatch は相互に排他的です。両方の引数に True を指定するとエラーになります。

[検索] ダイアログ ボックスの内容は、Find メソッドの影響を受けません。

検索対象となる指定範囲は、行の指定と桁の指定の両方で制限されます。最終行の末尾まで検索を行うには、その行の最終桁または行の長さが endcol として指定されていなければなりません。


GetSelection メソッド

コード ペインの選択項目を返します。

構文

object.GetSelection(startline, startcol, endline, endcol)

GetSelection の構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
startline	必ず指定します。コード ペインの選択項目の先頭行を表す値を格納するための長整数型 (Long) の変数を指定します。
startcol	必ず指定します。コード ペインの選択項目の先頭列を表す値を格納するための長整数型 (Long) の変数を指定します。
endline	必ず指定します。コード ペインの選択項目の最終行を表す値を格納するための長整数型 (Long) の変数を指定します。
endcol	必ず指定します。コード ペインの選択項目の最終列を表す値を格納するための長整数型 (Long) の変数を指定します。
解説

GetSelection メソッドを使用すると、情報が引数として返されます。情報が返されたとき、その情報を格納するために変更される変数を渡す必要があります。


Import メソッド (VBA アドイン オブジェクト モデル)

コンポーネントをファイルからプロジェクトに追加します。新しく追加されたコンポーネントを返します。

構文

object.Import(filename) As VBComponent

Import メソッドの構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
filename	必ず指定します。インポートするコンポーネントのファイル名とパスを表す文字列型 (String) の値を指定します。
解説

Import メソッドを使用して、コンポーネント、フォーム、モジュール、クラスなどをプロジェクトに追加できます。


InsertLines メソッド

コード ブロックの指定位置にコード行を挿入します。

構文

object.InsertLines(line, code)

InsertLines メソッドの構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
line	必ず指定します。コードを挿入する位置を表す長整数型 (Long) の値を指定します。
code	必ず指定します。挿入するコードを含む文字列型 (String) の値を指定します。
解説

InsertLines メソッドで挿入した文字列がキャリッジ リターンで区切られている場合、継続した行として挿入されます。


Item メソッド (VBA アドイン オブジェクト モデル)

コレクションのインデックス付きのメンバを返します。

構文

object.Item(index)

Item メソッドの構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
index	必ず指定します。コレクションのメンバの場所を表す式を指定します。数式を指定する場合は、引数 index には 1 からコレクションの Count プロパティの値までの範囲の数値を指定する必要があります。文字列式を指定する場合、メンバがコレクションに追加されるときに指定する引数 key  に引数 index が対応している必要があります。
Item メソッドで使用するコレクションとそれに対応する引数 key を次の表に示します。Item メソッドに渡す文字列は、コレクションの引数 key と一致していなければなりません。

コレクション	引数 Key
Windows	Caption プロパティの設定値。
LinkedWindows	Caption プロパティの設定値。
CodePanes	このコレクションに関連付けられている固有の文字列はありません。
VBProjects	Name プロパティの設定値。
VBComponents	Name プロパティの設定値。
References	Name プロパティの設定値。
Properties	Name プロパティの設定値。
解説

引数 index には、数値またはオブジェクトのタイトルを含む文字列を指定できます。

重要   Macintosh バージョンでは、Windows で作成されたコードとの互換性のために、リンク ウィンドウ、リンク ウィンドウ フレームおよびドッキング ウィンドウを制御するオブジェクト、プロパティおよびメソッドが含まれていますが、これらの言語要素を含むコードを Macintosh 上で実行した場合、実行時エラーが発生します。


InsertFile メソッド

ファイル内のコードをコード モジュールに挿入します。

object.InsertFile(filename) As String

InsertFile メソッドの構文は、次の指定項目から構成されています。

指定項目	内容
object	必ず指定します。 オブジェクトへの参照を表すオブジェクト式を指定します。
filename	必ず指定します。挿入するコードが含まれているファイル名を表す文字列型 の値を指定します。


Remove メソッド (VBA アドイン オブジェクト モデル)

コレクションから項目を削除します。

構文

object.Remove(component)

Remove メソッドの構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
component	必ず指定します。LinkedWindows コレクションには、オブジェクトを指定します。References コレクションには、タイプ ライブラリまたはプロジェクトへの参照を指定します。VBComponents コレクションには、クラス モジュール、フォーム、または標準モジュールを表す定数を指定します。VBProjects コレクションには、スタンドアロン プロジェクトを指定します。
解説

LinkedWindows コレクションで使用した場合、Remove メソッドは現在のリンク ウィンドウのコレクションからウィンドウを削除します。削除したウィンドウは、それ自体がリンク ウィンドウ フレームを持つ、フローティング ウィンドウになります。Remove メソッドは、スタンドアロン プロジェクトでのみ使用されます。Remove メソッドをホスト プロジェクトで使用すると、実行時エラーが発生します。

重要   Macintosh バージョンでは、Windows で作成されたコードとの互換性のために、リンク ウィンドウ、リンク ウィンドウ フレームおよびドッキング ウィンドウを制御するオブジェクト、プロパティおよびメソッドが含まれていますが、これらの言語要素を含むコードを Macintosh 上で実行した場合、実行時エラーが発生します。


ReplaceLine メソッド

既存のコード行を指定されたコード行で置換します。

構文

object.ReplaceLine(line, code)

ReplaceLine メソッドの構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
line	必ず指定します。置換する行の位置を表す長整数型 (Long) の値を指定します。
code	必ず指定します。挿入するコードを含む文字列型 (String) の値を指定します。


MakeCompiledFile メソッド

現在のプロジェクトを DLL として作成します。DLL の名前は、BuildFileName プロパティで指定されます。

構文

object.MakeCompiledFile

引数 object には、オブジェクトへの参照を表すオブジェクト式を指定します。


SetFocus メソッド

指定したウィンドウにフォーカスを移動します。

構文

object.SetFocus

引数 object には、オブジェクトへの参照を表すオブジェクト式を指定します。

解説

SetFocus メソッドは、既に表示されているウィンドウに対して使用します。


SaveAs メソッド

新しいファイル名でプロジェクトを保存します。

構文

object.SaveAs (newfilename As String)

SaveAs メソッドの構文は、次の指定項目から構成されます。

指定項目	内容
object	オブジェクトへの参照を表すオブジェクト式を指定します。
newfilename	必ず指定します。コンポーネントを保存する新しいファイルの名前を表す文字列式を指定します。
解説

新しいパス名が指定された場合は、それが使用されます。指定されない場合は、古いパス名が使用されます。新しいファイル名が不正な場合、または読み取り専用の場合、エラーが発生します。

 SaveAs メソッドは、スタンドアロン プロジェクトでのみ使用できます。ホスト プロジェクトでこのメソッドを使用した場合は、実行時エラーが発生します。


SetSelection メソッド

コード ペインに選択項目を設定します。

構文

object.SetSelection(startline, startcol, endline, endcol)

SetSelection メソッドの構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
startline	必ず指定します。選択項目の先頭行を表す長整数型 (Long) の値を指定します。
startcol	必ず指定します。選択項目の先頭列を表す長整数型 (Long) の値を指定します。
endline	必ず指定します。選択項目の最終行を表す長整数型 (Long) の値を指定します。
endcol	必ず指定します。選択項目の最終列を表す長整数型 (Long) の値を指定します。


Show メソッド (VBA アドイン オブジェクト モデル)

指定したコード ペインをウィンドウ内に表示します。

構文

object.Show

引数 object には、オブジェクトへの参照を表すオブジェクト式を指定します。

解説

Show メソッドを使用すると、指定したコード ペインはウィンドウ内でフォーカスを取得します。


Update メソッド

[アドイン マネージャ] ダイアログ ボックスを開いたときと同じルールで、Vbaddin.ini ファイルに一覧されているアドインから AddIns コレクションの内容を更新します。

構文

object.Update

引数 object には、オブジェクトへの参照を表すオブジェクト式を指定します。

解説

Vbaddin.ini ファイルに一覧されているすべてのアドインは、Visual Basic で使用する前に、レジストリの ActiveX コンポーネントに登録しておく必要があります。


Add メソッドの使用例

次の例は、Add メソッドを使用して、VBComponents コレクションに標準モジュールを 1 つ追加します。

Application.VBE.VBProjects(1).VBComponents.Add(vbext_ct_StdModule)


AddFromFile メソッドの使用例

次の例は、AddFromFile メソッドを使用して、指定されたコード ペインにファイルの内容を追加します。

Application.VBE.CodePanes(3).CodeModule.AddFromFile "c:\Code Files\book2.frm"


AddFromGUID メソッドの使用例

次の例は、Reference オブジェクトの GUID (Globally Unique Identifier) 値で参照を指定し、AddFromGUID メソッドを使用して現在のプロジェクトに参照を追加します。

Application.VBE.ActiveVBProject.References.AddFromGuid("{000204EF-0000-0000-C000-000000000046}", 5, 0)


AddFromString メソッドの使用例

次の例は、AddFromString メソッドを使用して、指定されたコード ペインに "Dim intJack As Integer" 行を追加します。

Application.VBE.CodePanes(3).CodeModule.AddFromString "Dim intJack As Integer"


Close メソッドの使用例

次の例は、Close メソッドを使用して、Windows コレクションの指定されたメンバを閉じます。

Application.VBE.Windows(9).Close


CreateEventProc メソッドの使用例

次の例は、CreateEventProc メソッドを使用して、Button_Click プロシージャを作成します。

Debug.Print Application.VBE.SelectVBComponents.CodeModule.CreateEventProc("Click", "Button")


DeleteLines メソッドの使用例

次の例は、2 つのステップに分かれています。最初の For...Next ループでは、InsertLines メソッドを使用して CodePanes(1) にアルファベットの初期値セグメントの 26 文字を、"a" から順に 1 行に 1 文字ずつ行を追加挿入します。最後の 26 行目で、すべてのアルファベットが挿入されます。

2 番目の For...Next ループでは、DeleteLines メソッドを使用して、奇数番号の行を削除します。このようなループの場合は、単純に 1 行おきに削除すると、行を 1 行削除するごとに行の番号が変わっていきます。したがって、行の削除処理は 2 行のコードで行います。

For I = 1 to 26

Application.VBE.SelectedVBComponent.CodeModule.InsertLines I, Mid$("abcdefghijklmnopqrstuvwxyz", 1, I)

Next

For I = 1 to 13

Application.VBE.SelectedVBComponent.CodeModule.DeleteLines I

Next


DesignerWindow メソッドの使用例

次の例は、DesignerWindow メソッドと Visible プロパティを使用してプロパティを使用して、特定のデザイナが表示されているかどうかを調べます。このとき VBComponent オブジェクトはフォームである必要があります。

Debug.Print Application.VBE.VBProjects(1).VBComponents(1).DesignerWindow.Visible


Export メソッドの使用例

次の例は、test.bas という名前のファイルを作成し、Export メソッドを使用して VBComponents(1) コード モジュールの内容をファイルにコピーします。

Application.VBE.ActiveVBProject.VBComponents(1).Export("test.bas")


Find メソッドの使用例

次の例は、Find メソッドを使用して、特定のコード ペインの指定された行ブロックの 1261 行目から 1279 行目に文字列 "Tabs.Clear" が含まれているかどうかを確認します。

Application.VBE.CodePanes(2).CodeModule.Find ("Tabs.Clear", 1261, 1, 1280, 1, False, False)


GetSelection メソッドの使用例

次の例は、CodePanes(1) の現在のセクションの開始位置と終了位置を返します。この例の最後の行では、GetSelection メソッドを使用して 4 つの値を 4 つの変数に代入します。

Dim m As Long

Dim n As Long

Dim x As Long

Dim y As Long

Application.VBE.CodePanes(1).GetSelection m, n, x, y


Import メソッドの使用例

次の例は、Import メソッドを使用して、test.bas ファイルの内容をコード モジュールにコピーします。

Application.VBE.ActiveVBProject.VBComponents.Import("test.bas")


InsertLines メソッドの使用例

次の例は、InsertLines メソッドを使用して、指定されたコード ペインに "Option Explicit" 行を挿入します。

Application.VBE.CodePanes(1).CodeModule.InsertLines 1, "Option Explicit"


Item メソッドの使用例

次の例は、2 種類の方法で、CodePanes コレクションの特定のメンバを表示します。最初の例では、Item メソッドを使用しています。

Application.VBE.CodePanes.Item(2).Show

Application.VBE.CodePanes(2).Show


Remove メソッドの使用例

次の例は、VBComponents コレクションの特定のメンバがモジュールであることを確認してから、Remove メソッドを使用して、そのモジュールを削除します。

Debug.Print Application.VBE.ActiveVBProject.VBComponents(4).Name

Application.VBE.ActiveVBProject.VBComponents.Remove Application.VBE.ActiveVBProject.VBComponents(4)


ReplaceLine メソッドの使用例

次の例は、2 つのステップに分かれています。最初の For...Next ループでは、InsertLines メソッドを使用して CodePanes(1) にアルファベットの初期値セグメントの 26 文字を、"a" から順に 1 行に 1 文字ずつ行を追加挿入します。最後の 26 行目で、すべてのアルファベットが挿入されます。

2 番目の For...Next ループでは、ReplaceLine メソッドを使用して、各偶数行を置き換えます。奇数行は変更されません。

For I = 1 to 26

Application.VBE.CodePanes(1).CodeModule.InsertLines I, Mid$("abcdefghijklmnopqrstuvwxyz", 1, I)

Next I

For I = 1 to 13

Application.VBE.CodePanes(1).CodeModule.ReplaceLine 2*I, Mid$("abcdefghijklmnopqrstuvwxyz", I*2, 1)

Next I


SetFocus メソッドの使用例

次の例は、SetFocus メソッドを使用して、Windows コレクションの特定のメンバにフォーカスを移動します。そのウィンドウのタイトル バーをマウスでクリックしたときと同じ動作になります。

Application.VBE.Windows(9).SetFocus


SetSelection メソッドの使用例

次の例は、SetSelection メソッドを使用して、CodePanes(1) の 2 行目の 4 文字目の文字から、3 行目の 15 文字目までの文字列を選択します。

Application.VBE.CodePanes(1).SetSelection 2,4,3,15


Show メソッドの使用例

次の例は、Show メソッドを使用して、指定されたコード ペインをウィンドウ内に表示します。

Application.VBE.CodePanes(2).Show


AddIn オブジェクト

他のアドインで参照できるアドインの情報を提供します。

構文

object.AddIn

解説

AddIn オブジェクトは、アドイン マネージャに表示されるすべてのアドインに対して作成されます。


AddIns コレクション

VBA に登録されているアドインのコレクションを返します。

構文

object.AddIns

解説

AddIns コレクションは、VBE オブジェクトを使用して参照されます。VBE のアドイン マネージャに表示されるすべてのアドインは、AddIns コレクションのメンバーです。


CommandBar オブジェクト

CommandBar オブジェクトには、ボタンやメニュー コマンドになる他の CommandBar オブジェクトが含まれます。.

構文

CommandBar


CodeModule オブジェクト

フォーム、クラス、またはドキュメントなどのコンポーネントに関連付けられているコードを表します。

解説

コンポーネントに関連付けられているコードに対して、追加、削除、編集などの変更を行うには、CodeModule オブジェクトを使用します。

各コンポーネントは、1 つの CodeModule オブジェクトに関連付けられています。ただし、CodeModule オブジェクトは、複数のコード ペインに関連付けることができます。

CodeModule オブジェクトに関連付けられているメソッドを使用して、コード テキストについての情報を行単位で操作したり、取得したりすることができます。たとえば、AddFromString メソッドを使用して、モジュールに文字列を追加できます。AddFromString メソッドは、モジュールの最初のプロシージャのすぐ上に文字列を配置します。また、プロシージャがない場合は、モジュールの最後に文字列を配置します。

Parent プロパティを使用して、コード モジュールに関連付けられた VBComponent オブジェクトを取得できます。


CommandBarEvents オブジェクト

CommandBarEvents プロパティを使って取得します。コマンドバー上のコントロールをクリックすると、CommandBarEvents オブジェクトがイベントを発生させます。

解説

CommandBarEvents オブジェクトは、Events オブジェクトの CommandBarEvents プロパティによって返されます。返された CommandBarEvents オブジェクトは、インターフェイスとして Click イベントを持ちます。キーワード WithEvents を指定して CommandBarEvents オブジェクトを宣言することにより、このイベントを操作することができます。


CommandBars コレクション

ショートカット メニューをサポートするコマンドバーなど、プロジェクト内のすべてのコマンドバーを含みます。

解説

CommandBars コレクションを使用すると、アドインを使用してコマンドバーおよびコントロールを追加したり、既存の組み込みのコマンドバーにコントロールを追加できるようになります。


CodePane オブジェクト

コード ペインを表します。

解説

CodePane オブジェクトを使用して、コード ペインに表示される文字列の位置または文字列の選択範囲を操作します。

Show メソッドを使って、指定したコード ペインを表示できます。また、SetSelection メソッドを使って、コード ペイン内の選択範囲を設定したり、GetSelection メソッドを使って、コード ペイン内の選択範囲の位置を取得することができます。


CodePanes コレクション

VBE オブジェクト内のアクティブなコード ペインを含みます。

解説

CodePanes コレクションを使用して、プロジェクト内で開かれているコード ペインを操作します。

Count プロパティを使用して、コレクション内のアクティブなコード ペインの数を取得できます。


Events オブジェクト

Visual Basic for Applications 内のすべてのイベントでアドインが接続できるように、プロパティを提供します。

解説

Events オブジェクトは、イベント ソース オブジェクトを返すプロパティを提供します。これらのプロパティを使用して、Visual Basic for Applications 環境内での変化を通知させる、イベント ソース オブジェクトを取得することができます。

Events オブジェクトのプロパティは、プロパティの名前と同じ種類のオブジェクトを返します。たとえば、CommandBarEvents プロパティは、CommandBarEvents オブジェクトを返します。


LinkedWindows コレクション

リンク ウィンドウ フレーム内のすべてのリンク ウィンドウを含みます。

解説

LinkedWindows コレクションを使用して、開発環境内のドッキング ウィンドウおよびリンク ウィンドウを変更します。

重要   Macintosh バージョンでは、Windows で作成されたコードとの互換性のために、リンク ウィンドウ、リンク ウィンドウ フレームおよびドッキング ウィンドウを制御するオブジェクト、プロパティおよびメソッドが含まれていますが、これらの言語要素を含むコードを Macintosh 上で実行した場合、実行時エラーが発生します。

Window オブジェクトの LinkedWindowFrame プロパティは、有効な LinkedWindows コレクションを持つ Window オブジェクトを返します。

リンク ウィンドウ フレームは、リンクまたはドッキング可能なすべてのウィンドウを含みます。このウィンドウには、コード ウィンドウ、デザイナ、[オブジェクト ブラウザ] ウィンドウ、および [置換] ウィンドウを除くすべてのウィンドウが含まれます。

1 つのリンク ウィンドウ フレームのすべてのペインを他のウィンドウに移動すると、ペインを持たないリンク ウィンドウ フレームは破棄されます。ただし、メイン ウィンドウからすべてのペインが削除された場合、メイン ウィンドウは破棄されません。

Visible プロパティを使用して、ウィンドウが表示可能かどうかを調べたり、ウィンドウを表示するかどうかを設定します。

Add メソッドを使用して、現在のリンク ウィンドウのコレクションにウィンドウを追加することができます。1 つのリンク ウィンドウ フレーム内のペインであるウィンドウは、他のリンク ウィンドウ フレームに追加できます。Remove メソッドを使用して、現在のリンク ウィンドウのコレクションからウィンドウを削除すると、ウィンドウはリンクまたはドッキングされていない状態になります。

LinkedWindows コレクションは、メイン ウィンドウ フレームにウィンドウをドッキングさせたり、ドッキングを解除するために使用します。


Property オブジェクト

指定したコンポーネントに対してプロパティ ウィンドウに表示されるオブジェクトのプロパティを表します。

解説

Property オブジェクトの Value プロパティを使用して、コンポーネントのプロパティの値の取得または設定を行います。

どのコンポーネントも、少なくとも Name プロパティは持っています。Property オブジェクトの Value プロパティを使用して、プロパティの値の取得または設定を行います。Value プロパティは、適切な形式のバリアント型 (Variant) で値を返します。返される値がオブジェクトの場合、Value プロパティはオブジェクトの各プロパティを示す Property オブジェクトを含む、Properties コレクションを返します。返された Properties コレクションの Item メソッドを使用することにより、各 Property オブジェクトを操作することができます。

Property プロパティから返される値がオブジェクトの場合、Object プロパティを使って、Property オブジェクトを新しいオブジェクトに設定することができます。


Properties コレクション (VBA アドイン オブジェクト モデル)

オブジェクトのプロパティを表します。

解説

Properties コレクションを使用して、プロパティ ウィンドウに表示されているプロパティを操作します。プロパティ ウィンドウに表示されているすべてのプロパティに対応するオブジェクトが Properties コレクションにあります。


Reference オブジェクト

タイプ ライブラリまたはプロジェクト.への参照を表します。

解説

Reference オブジェクトを使用して、参照が現在も有効かどうかを確認します。

参照が有効な参照先を指していない場合、IsBroken プロパティは真 (True) を返します。参照が既定の参照で移動または削除できない場合、BuiltIn プロパティは真 (True) を返します。追加または削除する参照が正しいかどうかを判断するには、Name プロパティを使用します。


References コレクション

プロジェクト内の参照の集まりを表します。

解説

References コレクションを使用して、参照の追加または削除を行います。References コレクションは、[参照設定] ダイアログ ボックスで選択できる参照と同じです。


ReferencesEvents オブジェクト

ReferencesEvents プロパティによって返されます。

解説

ReferencesEvents オブジェクトは プロジェクトの参照を追加または削除したときにイベントを発生させます。ItemAdded イベントは、プロジェクトに参照が追加された後で発生します。ItemRemoved イベントは、プロジェクトから参照が削除された後で発生します。


VBComponent オブジェクト

プロジェクトに含まれているクラス モジュールまたは標準モジュールなどのコンポーネントを表します。

解説

コンポーネントに関連付けられているコード モジュールを操作したり、コンポーネントのプロパティの設定値を変更するには、VBComponent オブジェクトを使用します。

Type プロパティを使って、VBComponent オブジェクトが参照しているコンポーネントの種類を調べることができます。また、Collection プロパティを使って、コンポーネントがどのコレクションに含まれているのかを調べることもできます。


VBComponents コレクション

プロジェクトに含まれているコンポーネントを表します。

解説

VBComponents コレクションを使用して、プロジェクト内のコンポーネントの操作、追加、または削除を行います。コンポーネントは、フォーム、モジュール、またはクラスなどで構成されています。VBComponents コレクションは、For Each ステートメント ブロックの中で使用される標準的なコレクションです。

Parent プロパティを使用して、VBComponents コレクションが含まれているプロジェクトを取得することができます。

Visual Basic for Applications では、Import メソッドを使用して、ファイルからコンポーネントをプロジェクトに追加することができます。


VBE オブジェクト

Visual Basic for Applications で表される他のすべてのオブジェクトおよびコレクションを含むルート オブジェクトです。

解説

次に示すコレクションを使用して、VBE オブジェクトに含まれるオブジェクトを操作します。

•	プロジェクトのコレクションを操作するには、VBProjects コレクションを使用します。

•	アドインのコレクションを操作するには、AddIns コレクションを使用します。

•	ウィンドウのコレクションを操作するには、Windows コレクションを使用します。

•	コード ペインのコレクションを操作するには、CodePanes コレクションを使用します。

•	コマンドバーのコレクションを操作するには、CommandBars コレクションを使用します。

Visual Basic for Applications 内のすべてのイベントで、アドインが接続できるようにプロパティを操作するには、Events オブジェクトを使用します。Events オブジェクトのプロパティは、プロパティの名前と同じ種類のオブジェクトを返します。たとえば、CommandBarEvents プロパティは、CommandBarEvents オブジェクトを返します。

SelectedVBComponent プロパティを使用して、アクティブなコンポーネントを取得することができます。アクティブなコンポーネントとは、プロジェクト ウィンドウで選択されているコンポーネントです。プロジェクト ウィンドウで選択した項目がコンポーネントでない場合、SelectedVBComponent プロパティは Nothing を返します。

メモ   VBE オブジェクト内のすべてのオブジェクトは、VBE オブジェクトを示す VBE プロパティを持ちます。


VBNewProjects コレクション

開発環境におけるすべての新規プロジェクトを表します。

解説

VBNewProjects コレクションを使用すると、開発環境の任意のインスタンス内における特定のプロジェクトにアクセスできます。VBNewProjects では、通常のコレクションと同様に For... Each ブロックによる繰り返し処理を行うことができます。


VBProject オブジェクト

プロジェクトを表します。

解説

プロジェクトへのプロパティの設定、VBComponents コレクションの操作、および References コレクションの操作を行うには、VBProject オブジェクトを使用します。


VBProjects コレクション

開発環境内で開かれているすべてのプロジェクトを表します。

解説

VBProjects コレクションを使用して、開発環境のインスタンス内の特定のプロジェクトを操作します。VBProjects コレクションは、For Each ステートメント ブロックの中で使用される標準的なコレクションです。


Window オブジェクト

開発環境内のウィンドウを表します。

解説

Window オブジェクトを使用して、ウィンドウの表示/非表示および配置を設定します。

重要   Macintosh バージョンでは、Windows で作成されたコードとの互換性のために、リンク ウィンドウ、リンク ウィンドウ フレームおよびドッキング ウィンドウを制御するオブジェクト、プロパティおよびメソッドが含まれていますが、これらの言語要素を含むコードを Macintosh 上で実行した場合、実行時エラーが発生します。

Close メソッドを使用して、Windows コレクション内のウィンドウを閉じることができます。Close メソッドは、次に示す異なる種類のウィンドウに影響を与えます。

ウィンドウ	Close メソッドの使用結果
コード ウィンドウ	Windows コレクションからウィンドウを削除します。
デザイナ	Windows コレクションからウィンドウを削除します。
リンク ウィンドウ フレームの Window オブジェクト	リンクされていない個別のウィンドウになります。
メモ   Close メソッドをコード ウィンドウおよびデザイナに対して使用すると、実際にウィンドウが閉じます。Visible プロパティを偽 (False) に設定するとウィンドウは非表示になりますが、閉じません。プロジェクト ウィンドウまたはプロパティ ウィンドウなどの開発環境のウィンドウで Close メソッドを使用すると、Visible プロパティを偽 (False) に設定したときと同じ結果になります。

SetFocus メソッドを使用して、フォーカスをウィンドウに移動することができます。

Visible プロパティを使用して、ウィンドウの表示/非表示を設定します。

作業中のウィンドウの種類を調べるには、Type プロパティを使用します。たとえば、複数のデザイナがあるときなど、1 種類のウィンドウが複数存在する場合は、Caption プロパティを使用して、作業中のウィンドウを判断します。また、VBComponent オブジェクトの DesignerWindow プロパティまたは CodePane オブジェクトの Window プロパティを使用して、作業するウィンドウを見つけることもできます。


Windows コレクション

開いているか、または常に表示されているすべてのウィンドウを含みます。

解説

Windows コレクションを使用して、Window オブジェクトを操作します。

Windows コレクションは、コレクション内に常に使用できるウィンドウを持っています。このようなウィンドウには、プロジェクト ウィンドウ、プロパティ ウィンドウ、およびすべての開いているコード ウィンドウおよびデザイナ ウィンドウがあります。コード ウィンドウまたはデザイナ ウィンドウを開くと、Windows コレクションに新しいメンバが追加されます。コード ウィンドウまたはデザイナ ウィンドウを閉じると、Windows コレクションからメンバが削除されます。通常使用する開発環境のウィンドウを閉じると、ウィンドウに対応するオブジェクトはコレクションから削除されませんが、ウィンドウは非表示になります。


ActiveCodePane プロパティの使用例

次の例は、ActiveCodePane プロパティと TopLine プロパティを使用して、アクティブなコード ペインの先頭の行番号を取得します。

Debug.Print Application.VBE.ActiveCodePane.TopLine


ActiveVBProject プロパティの使用例

次の例は、ActiveVBProject プロパティを使用して、アクティブなプロジェクトの名前を返します。

Debug.Print Application.VBE.ActiveVBProject.Name


ActiveWindow プロパティの使用例

次の例は、ActiveWindow プロパティを使用して、アクティブなウィンドウのキャプションを返します。

Debug.Print Application.VBE.ActiveWindow.Caption


BuiltIn プロパティの使用例

次の例は、BuiltIn プロパティを使用して、アクティブなプロジェクトの特定の参照が組み込みかどうかを表すブール型 (Boolean) の値を返します。

Debug.Print Application.VBE.ActiveVBProject.References(1).BuiltIn


Caption プロパティの使用例

次の例は、Caption プロパティを使用して、アクティブ ウィンドウのキャプションを表示します。

Debug.Print Application.VBE.ActiveWindow.Caption


CodeModule プロパティの使用例

次の例は、CodeModule プロパティと CountOfLines プロパティを使用して、特定のコード モジュールの行数を返します。

Debug.Print Application.VBE.ActiveVBProject.VBComponents(6).CodeModule.CountOfLines


CodePane プロパティの使用例

次の例は、CodePane プロパティと TopLine プロパティを使用して、選択された VBComponent オブジェクトにあるコード モジュールの先頭の行番号を表示します。

Debug.Print Application.VBE.SelectedVBComponent.CodeModule.CodePane.TopLine


CodePanes プロパティの使用例

次の例は、CodePanes プロパティと TopLine プロパティを使用して、指定されたコード ペインの先頭の行番号を表示します。

Debug.Print Application.VBE.CodePanes(3).TopLine


CodePaneView プロパティの使用例

次の例は、CodePaneView プロパティを使用して、指定されたコード ペインがプロシージャを表示しているか、またはモジュール全体を連続表示しているかを示す値を返します。

Debug.Print Application.VBE.CodePanes(3).CodePaneView


Collection プロパティの使用例

次の例は、Collection プロパティと Count プロパティを使用して、アクティブなプロジェクトの数を返します。

Debug.Print Application.VBE.ActiveVBProject.Collection.Count


CommandBarEvents プロパティの使用例

次の例は、CommandBarEvents プロパティを含むコードを使用して、コマンド バーでのマウス クリックを処理するためのコードをサポートします。

Private WithEvents ce As CommandBarEvents

Sub Test()

    Dim c As CommandBarControl

    Set c = Application.VBE.CommandBars("Tools").Controls(1)

    Set ce = Application.VBE.Events.CommandBarEvents(c)

End Sub

Private Sub ce_Click(ByVal CommandBarControl As Object, Handled As Boolean, CancelDefault As Boolean)

    ' ここにイベント処理のコードを挿入します

End Sub


Count プロパティの使用例

次の例は、Count プロパティを使用して、特定のプロジェクトにある VBComponent オブジェクトの数を返します。

Debug.Print Application.VBE.VBProjects(1).VBComponents.Count


CountOfDeclarationLines プロパティの使用例

次の例は、CountOfDeclarationLines プロパティを使用して、特定のコード ペインにある宣言行の数を返します。

Debug.Print Application.VBE.CodePanes(2).CodeModule.CountOfDeclarationLines


CountOfLines プロパティの使用例

次の例は、CountOfLines プロパティを使用して、特定のコード ペインにある行の総数を返します。

Debug.Print Application.VBE.CodePanes(2).CodeModule.CountOfLines


CountOfVisibleLines プロパティの使用例

次の例は、CountOfVisibleLines プロパティを使用して、指定されたコードペインで、そのペインの高さに応じて、表示されている行数を返します。

Debug.Print Application.VBE.Codepanes(3).CountOfVisibleLines


Description プロパティの使用例

最初の例は、Description プロパティを使用して、特定のプロジェクトに説明のための文字列を設定します。また、その説明が正しく割り当てられたかどうかを確認するために出力しています。

2 番目の例は、Description プロパティを使用して、特定のプロジェクトにある指定された Reference オブジェクトのタイトル名を返します。

Application.VBE.VBProjects(1).Description = "Hot Sauce"

Debug.Print Application.VBE.VBProjects(1).Description

Debug.Print Application.VBE.VBProjects(1).References(1).Description

Debug.Print Application.VBE.VBProjects(1).References(2).Description


Designer プロパティの使用例

次の例は、Designer プロパティと Count プロパティを使用して、フォームにあるコントロールの数を返します。このとき、そのフォームを含むウィンドウが選択されている必要があります。Designer オブジェクトは、それ自体がフォームです。

Debug.Print Application.VBE.SelectVBComponent.Designer.Controls.Count


FullPath プロパティの使用例

次の例は、FullPath プロパティを使用して、指定された参照のオブジェクト ライブラリの絶対パス名を返します。

Debug.Print Application.VBE.ActiveVBProject.References(1).FullPath


GUID プロパティの使用例

次の例は、GUID プロパティを使用して、指定されたプロジェクトにある指定された Reference オブジェクトの GUID (Globally Unique Identifier) を返します。

Debug.Print Application.VBE.VBProjects(1).References(1).GUID


HasOpenDesigner プロパティの使用例

次の例は、HasOpenDesigner プロパティを使用して、特定のプロジェクトの指定されたコンポーネント、この場合はフォームでデザイナが開かれているかどうかを返します。

Debug.Print Application.VBE.VBProjects(1).VBComponents(1).HasOpenDesigner


Height プロパティ、Width プロパティの使用例

次の例は、Height プロパティと Width プロパティを使用して、指定されたウィンドウの高さと幅を twip 単位で返します。これらのプロパティの設定値は、リンクまたはドッキングされているウィンドウの Window オブジェクトを参照するため、ウィンドウがリンクされたあと、またはドッキングされたあとに変更されます。

Debug.Print Application.VBE.Windows(9).Height

Debug.Print Application.VBE.Windows(9).Width


HelpContextID プロパティの使用例

次の例は、HelpContextID プロパティを使用して、プロジェクトに対応するヘルプ ファイルのコンテキスト ID を返します。

Debug.Print Application.VBE.VBProjects(1).HelpContextID


HelpFile プロパティの使用例

次の例は、HelpFile プロパティを使用して、プロジェクトにヘルプ ファイルを割り当てます。この例では、ヘルプ ファイルの絶対パス名を出力して、割り当てが正しく行われたかどうかを確認しています。

Application.VBE.VBProjects(1).HelpFile = "C:\HelpStuff\veenob3.hlp"

Debug.Print Application.VBE.VBProjects(1).HelpFile


IsBroken プロパティの使用例

次の例は、IsBroken プロパティを使用して、特定のプロジェクトにある指定された Reference オブジェクトが解除されているかどうかを表す値を返します。

Debug.Print Application.VBE.vbprojects(1).References(1).IsBroken


Left プロパティ、Top プロパティの使用例

次の例は、Left プロパティと Top プロパティを使用して、特定のウィンドウの左上隅の座標を twip 単位で返します。これらのプロパティの設定値は、リンクまたはドッキングされているウィンドウの Window オブジェクトを参照するため、ウィンドウがリンクされたあと、またはドッキングされたあとに変更されます。

Debug.Print Application.VBE.Windows(9).Left

Debug.Print Application.VBE.Windows(9).Top


Lines プロパティの使用例

次の例は、Lines プロパティを使用して、指定されたコード ペイン内のコード ブロックの 1 行目から 4 行目を返します。

Debug.Print Application.VBE.CodePanes(1).CodeModule.Lines( 1, 4)


MainWindow プロパティの使用例

次の例は、MainWindow プロパティを使用して、メイン ウィンドウを表す Window オブジェクトを返し、そのメイン ウィンドウのキャプションを出力します。

Debug.Print Application.VBE.MainWindow.Caption


Major プロパティの使用例

次の例は、Major プロパティを使用して、特定のプロジェクトにある指定された Reference オブジェクトのメジャー バージョン番号を返します。

Debug.Print Application.VBE.VBProjects(1).References(1).Major


Minor プロパティの使用例

次の例は、Minor プロパティを使用して、特定のプロジェクトにある指定された Reference オブジェクトのマイナ バージョン番号を返します。

Debug.Print Application.VBE.VBProjects(1).References(1).Minor


Mode プロパティの使用例

次の例は、Mode プロパティを使用して、アクティブなプロジェクトのモードを返します。戻り値は、プロジェクトのモードを表す定義済みの定数です。

Debug.Print Application.VBE.ActiveVBProject.Mode


Name プロパティの使用例

次の例は、Name プロパティを使用して、特定のプロジェクトにある VBComponents コレクションの指定されたメンバの名前を返します。

Debug.Print Application.VBE.VBProjects(1).VBComponents(1).Name


NumIndices プロパティの使用例

次の例は、NumIndices プロパティを使用して、特定の VBComponent オブジェクトの指定されたプロパティに属するインデックスの数を返します。

Debug.Print Application.VBE.VBProjects(1).VBComponents(1).Properties(40).NumIndices


Object プロパティの使用例

次の例は、オブジェクトの MouseIcon プロパティにアイコン ファイルを指定します。このオブジェクトは、フォームである必要があります。

Set Application.VBE.ActiveVBProject.VBComponents(1).Properties("MouseIcon").Object = LoadPicture("Baseball.ico")


Parent プロパティの使用例

次の例は、Parent プロパティを使用して、オブジェクト階層の親オブジェクトの名前を返します。

Debug.Print Application.VBE.ActiveVBProject.VBComponents.Parent.Name


ProcBodyLine プロパティの使用例

次の例は、ProcBodyLine プロパティを使用して、特定のコード ペインにある指定されたプロシージャ SetupTabs のコードの 1 行目の行番号を返します。

Debug.Print Application.VBE.CodePanes(3).CodeModule.ProcBodyLine ("SetupTabs", vbext_pk_Proc)


ProcCountLines プロパティの使用例

次の例は、ProcCountLines プロパティを使用して、特定のコード ペインにある指定されたプロシージャ SetupTabs のコードの行数を返します。

Debug.Print Application.VBE.CodePanes(3).CodeModule.ProcCountLines ("SetupTabs", vbext_pk_Proc)


ProcOfLine プロパティの使用例

次の例は、ProcOfLine プロパティを使用して、特定のコード ペインの指定された行番号が含まれるプロシージャの名前を返します。

Debug.Print Application.VBE.CodePanes(3).CodeModule.ProcOfLine (1270, vbext_pk_Proc)


ProcStartLine プロパティの使用例

次の例は、ProcStartLine プロパティを使用して、特定のコード ペインの指定されたプロシージャの開始行を返します。

Debug.Print Application.VBE.CodePanes(3).CodeModule.ProcStartLine ("SetupTabs", vbext_pk_Proc)


Protection プロパティの使用例

次の例は、Protection プロパティを使用して、プロジェクトが保護されているかどうかを示す値を返します。戻り値は、プロジェクトの状態を表す定義済みの定数に対応する数字です。

Debug.Print Application.VBE.ActiveVBProject.Protection


ReferencesEvents プロパティの使用例

次の例は、ReferencesEvents プロパティを含むコードを使用して、参照を追加または削除するためのイベント処理コードをサポートします。

Private WithEvents X As ReferencesEvents

Sub Test()

    Set X = Application.VBE.Events.ReferencesEvents

End Sub

Private Sub X_ItemAdded(ByVal Reference As VBIDE.Reference)

    ' ここに項目を追加するコードを挿入します。

End Sub

Private Sub X_ItemRemoved(ByVal Reference As VBIDE.Reference)

    ' ここに項目を削除するコードを挿入します。

End Sub


Saved プロパティの使用例

次の例は、Saved プロパティを使用して、指定されたプロジェクトが現在の状態で保存されているかどうかを示すブール型 (Boolean) の値を返します。

Debug.Print Application.VBE.VBProjects(1).Saved


SelectedVBComponent プロパティの使用例

次の例は、SelectedVBComponent プロパティを使用して、選択されたコンポーネント名を返します。

Debug.Print Application.VBE.SelectedVBComponent.Name


TopLine プロパティの使用例

次の例は、TopLine プロパティを使用して、指定されたコード ペインの先頭行の行番号を返します。

Debug.Print Application.VBE.CodePanes(3).TopLine


Type プロパティの使用例

次の例は、Type プロパティを使用して、特定のプロジェクトにある VBComponents コレクションの指定されたメンバの型を示す値を返します。戻り値は、コンポーネントのオブジェクト型の定義済みの定数に対応する数字です。

Debug.Print Application.VBE.VBProjects(1).VBComponents(1).Type


Value プロパティの使用例

次の例は、Value プロパティを使用して、VBComponents コレクションのメンバの指定されたプロパティの値を返します。

Debug.Print Application.VBE. ActiveVBProject.VBComponents(1).Properties("AcceptLabelsInFormulas").Value


VBE プロパティの使用例

次の例は、VBE プロパティと Name プロパティを使用して、アクティブなプロジェクトの名前を返します。

Debug.Print Application.VBE.ActiveVBProject.Name


Version プロパティの使用例

次の例は、Version プロパティを使用して、ホスト アプリケーションのバージョン番号を返します。

Debug.Print Application.VBE.Version


Visible プロパティの使用例

次の例は、Visible プロパティを使用して、指定されたウィンドウが表示されているかどうかを表すブール型 (Boolean) の値を返します。

Debug.Print Application.VBE.Windows(9).Visible


Window プロパティの使用例

次の例は、Window プロパティと Caption プロパティを使用して、指定されたコード ペインのキャプションを返します。

Debug.Print Application.VBE.CodePanes(1).Window.Caption


WindowState プロパティの使用例

次の例は、WindowState プロパティを使用して、指定されたウィンドウの表示状態を返します。戻り値は、ウィンドウの表示状態を表す定義済みの定数に対応する数字です。

Debug.Print Application.VBE.Windows(9).WindowState


ActiveCodePane プロパティ

アクティブな CodePane オブジェクト、または最後にアクティブになった CodePane オブジェクトを返します。また、アクティブな CodePane オブジェクトを設定することもできます。値の取得も可能です。

解説

ActiveCodePane プロパティには、任意の有効な CodePane オブジェクトを設定することができます。次に例を示します。

Set MyApp.VBE.ActiveCodePane = MyApp.VBE.CodePanes(1)

この例は、コード ペインのコレクション内の先頭のコード ペインをアクティブなコード ペイントして設定します。Set メソッドを使用して、アクティブなコード ペインを設定することもできます。


ActiveVBProject プロパティ

プロジェクト ウィンドウ内のアクティブなプロジェクトを返します。値の取得のみ可能です。

解説

ActiveVBProject プロパティは、プロジェクト ウィンドウ内の選択中のプロジェクトまたは選択中のコンポーネントを含むプロジェクトを返します。選択中のコンポーネントを含むプロジェクトを返す場合、プロジェクト自体が選択されている必要はありません。明示的に選択されているプロジェクトがあるかどうかに関係なく、常にアクティブなプロジェクトが存在します。


ActiveWindow プロパティ

開発環境内のアクティブなウィンドウを返します。値の取得のみ可能です。

解説

開発環境内で 1 つ以上のウィンドウが開かれている場合、ActiveWindow プロパティの設定値はフォーカスを持つウィンドウになります。メイン ウィンドウがフォーカスを持つ場合、ActiveWindow プロパティは Nothing を返します。


BuiltIn プロパティ

参照が既定の参照であるかどうかを示すブール型 (Boolean) の値を返します。既定の参照を削除することはできません。値の取得のみ可能です。

戻り値

BuiltIn プロパティの戻り値は、次のとおりです。

値	内容
True	参照は既定の参照です。削除することはできません。
False	参照は既定の参照ではありません。削除することができます。


BuildFileName プロパティ

プロジェクトを作成するときに使用する DLL の名前を設定します。値の取得も可能です。

構文

object.BuildFileName

引数 object には、オブジェクトへの参照を表すオブジェクト式を指定します。


Caption プロパティ

アクティブ ウィンドウのタイトルを表す文字列型 (String) の値を返します。値の取得のみ可能です。

解説

アクティブ ウィンドウのタイトルとは、ウィンドウのタイトル バーに表示される文字列を示します。


CodeModule プロパティ

コンポーネントに関連付けられているコードを示すオブジェクトを返します。値の取得のみ可能です。

解説

コンポーネントに関連付けられているコード モジュールがない場合、CodeModule プロパティは Nothing を返します。

メモ   CodePane オブジェクトは、表示できるコード ウィンドウを表します。指定したコンポーネントは、複数の CodePane オブジェクトを持つことが可能です。CodeModule オブジェクトは、コンポーネント内のコードを表します。コンポーネントが持てる CodeModule オブジェクトは、1 つだけです。


CodePane プロパティ

CodePane オブジェクトを返します。値の取得のみ可能です。

解説

コード ペインが存在する場合は、そのコード ペインがアクティブになり、そのコード ペインを含むウィンドウがアクティブになります。モジュールのコード ペインが存在しない場合は、CodePane プロパティによって作成されます。


CodePanes プロパティ

アクティブな CodePane オブジェクトのコレクションを返します。値の取得のみ可能です。


CodePaneView プロパティ

コード ペインがプロシージャを表示しているであるか、または、モジュール全体を連続表示しているかを示す値を返します。値の取得のみ可能です。

戻り値

CodePaneView プロパティの戻り値は、次のとおりです。

定数	内容
vbext_cv_ProcedureView	指定したコード ペインは、プロシージャを表示しています。
vbext_cv_FullModuleView	指定したプロジェクトは、モジュール全体を連続表示しています。


Collection プロパティ

アクティブなオブジェクトを含むコレクションを返します。値の取得のみ可能です。

解説

このオブジェクト モデルの多くのオブジェクトは、オブジェクトの親オブジェクトを示す Parent プロパティ、または Collection プロパティを持ちます。

Collection プロパティを使用して、オブジェクトが含まれているコレクションのプロパティ、メソッド、およびコントロールを操作します。


CommandBarEvents プロパティ

CommandBarEvents オブジェクトを返します。値の取得のみ可能です。

設定値

CommandBarEvents プロパティに渡す引数の設定値は、次のとおりです。

引数	内容
Vbcontrol	CommandBarControl オブジェクト型のオブジェクトである必要があります。
解説

CommandBarEvents プロパティを使用して、コマンド バーのボタンがクリックされたときにイベントを発生させるイベント ソース オブジェクトを返します。CommandBarEvents プロパティに渡される引数は、Click イベントを発生させるコマンド バー コントロールです。


Connect プロパティ

アドインの接続ステータスを設定します。値の取得も可能です。

解説

アドインが登録されていて、現在接続されている場合は、True を返します。

アドインが登録されていて、現在接続されていない場合は、False を返します。


Count プロパティ

コレクション内の要素の数を表す長整数型 (Long) の値を返します。値の取得のみ可能です。


CountOfLines プロパティ

コード モジュール内のコードの行数を表す長整数型 (Long) の値を返します。値の取得のみ可能です。


CountOfDeclarationLines プロパティ

コード モジュールの宣言セクションのコードの行数を表す長整数型 (Long) の値を返します。値の取得のみ可能です。


CountOfVisibleLines プロパティ

コード ペインに表示される行数を表す長整数型 (Long) の値を返します。値の取得のみ可能です。


Description プロパティ

オブジェクトに関連する説明のための文字列を表す文字列式を設定します。値の取得も可能です。VBProject プロジェクトについては、文字列の設定および取得が可能です。Reference オブジェクトについては、文字列の取得のみ可能です。

解説

VBProject オブジェクトの場合、Description プロパティは、アクティブなプロジェクトに関連する説明のための文字列の設定および取得が可能です。

Reference オブジェクトの場合、Description プロパティは、参照を説明する名前を返します。


Designer プロパティ

コンポーネントのデザイン特性を操作可能にするオブジェクトを返します。

解説

オブジェクトに開かれているデザイナがある場合、Designer プロパティは開かれているデザイナを返します。開かれているデザイナがない場合は、新しいデザイナが作成されます。デザイナは、特定の VBComponent オブジェクトの特性です。たとえば、何種類かの VBComponent オブジェクトを作成すると、オブジェクトに従ってデザイナーが作成されます。コンポーネントはデザイナを 1 つだけ持つことができ、そのデザイナーは常に同じデザイナーです。Designer プロパティを使用すると、コンポーネント特有のオブジェクトを操作できます。標準モジュールおよびクラス モジュールなどでは、VBComponent オブジェクトは、デザイナをサポートしていないので、デザイナは作成されません。

VBComponent オブジェクトがデザイナを持っていない場合、Designer プロパティは Nothing を返します。


DesignerID プロパティ

ActiveX デザイナの プログラム ID (ProgID) を返します。値の取得のみ可能です。


FullPath プロパティ

参照されているタイプ ライブラリのパスおよびファイル名を表す文字列型 (String) の値を返します。値の取得のみ可能です。


FileName プロパティ

 プロジェクト ファイル、またはホスト ドキュメントの完全なパス名を返します。

構文

object.Filename

引数 object には、オブジェクトへの参照を表すオブジェクト式を指定します。

解説

プロジェクトは、ファイル名以外の名前を持ちません。

返されるパス名は、"..\projects\myproject.vba" のように相対パスで表示されていても、常に、"c:\projects\myproject.vba" のような絶対パス名になります。


GUID プロパティ

オブジェクトのクラス識別子を表す文字列型 (String) の値を返します。値の取得のみ可能です。


HasOpenDesigner プロパティ

VBComponent オブジェクトに開いているデザイナが含まれているかどうかを示すブール型 (Boolean) の値を返します。値の取得のみ可能です。

戻り値

HasOpenDesigner プロパティが返す戻り値は、次のとおりです。

値	内容
True	VBComponent オブジェクトは、開かれた Design ウィンドウを含みます。
False	VBComponent オブジェクトは、開かれた Design ウィンドウを含みません。


Height プロパティ (VBA アドイン オブジェクト モデル)

twip 単位でウィンドウの高さを表す単精度浮動小数点数型 (Single) の値を設定します。値の取得も可能です。

解説

リンク ウィンドウまたは、ドッキング ウィンドウの Height プロパティの設定値を変更しても、ウィンドウがリンクまたはドッキングされている間は影響ありません。


HelpContextID プロパティ (VBA アドイン オブジェクト モデル)

Microsoft Windows ヘルプ ファイル内のトピックのコンテキスト番号を表す文字列型 (String) の値を設定します。値の取得も可能です。


HelpFile プロパティ (VBA アドイン オブジェクト モデル)

プロジェクトに対して Microsoft Windows ヘルプ ファイルを指定する文字列型 (String) の値を設定します。値の取得も可能です。


IndexedValue プロパティ (VBA アドイン オブジェクト モデル)

インデックス番号付きのリスト、または配列であるプロパティのメンバに対する値を設定します。値の取得も可能です。

解説

IndexedValue プロパティから取得する値、および IndexedValue プロパティに設定する値は、オブジェクトが受け取るデータ型に評価される式です。インデックス番号付きのリスト、または配列を設定するプロパティの場合、Value プロパティの代わりに IndexedValue プロパティを使用しなければなりません。インデックス番号付きのリストは、インデックス位置を指定する数式です。

IndexedValue プロパティは、最大 4 つのインデックスを認識します。IndexedValue プロパティが認識するインデックスの数は、NumIndices プロパティを使って取得します。

NumIndices プロパティの値が 0 を超える場合のみ、IndexedValue プロパティを使用します。インデックス番号付きのリストの値は、単一のインデックスを使って、設定または取得を行います。


IsBroken プロパティ

Reference オブジェクトがレジストリ内の有効な参照を示しているかどうかを表すブール型 (Boolean) の値を返します。値の取得のみ可能です。

戻り値

IsBroken プロパティの戻り値は、次のとおりです。

値	内容
True	Reference オブジェクトは、レジストリ内の有効な参照を示していません。
False	Reference オブジェクトは、レジストリ内の有効な参照を示しています。


Left プロパティ

twip 単位で画面上のウィンドウの左端の位置を表す単精度浮動小数点数型 (Single) の値を設定します。値の取得も可能です。

解説

Left プロパティが返す値は、ウィンドウがリンク ウィンドウまたは、ドッキング ウィンドウであるかどうかによって異なります。

メモ   リンクまたは、ドッキングされたウィンドウの Left プロパティの設定値を変更しても、ウィンドウがリンクまたは、ドッキングされている間は影響ありません。


Lines プロパティ

指定されたコード行を表す文字列型 (String) の値を返します。

構文

object.Lines(startline, count) As String

Lines プロパティの構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
startline	必ず指定します。取得するコードの先頭行を表す長整数型 (Long) の値を指定します。
count	必ず指定します。取得するコードの行数を表す長整数型 (Long) の値を指定します。
解説

コード モジュールの行番号は、1 から始まります。


LinkedWindowFrame プロパティ

ウィンドウを含むフレームを表す Window オブジェクトを返します。値の取得のみ可能です。

解説

LinkedWindowFrame プロパティを使用すると、リンク ウィンドウ フレームを表すオブジェクトを操作できます。リンク ウィンドウ フレームは、Window オブジェクトとは別のプロパティを持ちます。また、含んでいるウィンドウも異なります。ウィンドウがリンクされていない場合、LinkedWindowFrame プロパティは Nothing を返します。


LinkedWindows プロパティ

リンク ウィンドウ フレーム内に含まれるすべてのリンク ウィンドウのコレクションを返します。値の取得のみが可能です。

解説

LinkedWindows プロパティは、名前と同じ種類のオブジェクト名を返すアクセス プロパティです。


MainWindow プロパティ

Visual Basic 開発環境のメイン ウィンドウを表す Window オブジェクトを返します。値の取得のみ可能です。

解説

MainWindow プロパティによって返される Window オブジェクトを使用して、ドッキング ウィンドウの追加または削除を行うことができます。また、MainWindow プロパティによって返される Window オブジェクトを使用して、Visual Basic 開発環境のメイン ウィンドウの最大化、最小化、非表示設定、または保存を行うことができます。


Major プロパティ

参照しているタイプ ライブラリのメジャー バージョン番号を表す長整数型 (Long) の値を返します。値の取得のみ可能です。

解説

Major プロパティによって返される数値は、参照を設定したタイプ ライブラリに格納されているメジャー バージョン番号に対応しています。


Minor プロパティ

参照しているタイプ ライブラリのマイナ バージョン番号を表す長整数型 (Long) の値を返します。値の取得のみ可能です。

解説

Minor プロパティによって返される数値は、参照を設定したタイプ ライブラリに格納されているマイナ バージョン番号に対応しています。


Mode プロパティ

指定したプロジェクトのモードを表す値を返します。値の取得のみ可能です。

戻り値

Mode プロパティの戻り値は、次のとおりです。

定数	内容
vbext_vm_RunMode	指定したプロジェクトは、実行モードです。
vbext_vm_BreakMode	指定したプロジェクトは、中断モードです。
vbext_vm_DesignMode	指定したプロジェクトは、デザイン モードです。


Name プロパティ (VBA アドイン オブジェクト モデル)

オブジェクトを識別するためにコードで使用されている名前を表す文字列型 (String) の値を設定します。値の取得も可能です。VBProject オブジェクトおよび VBComponent オブジェクトについては、文字列の設定および取得が可能です。Property オブジェクトおよび Reference オブジェクトについては、文字列の取得のみ可能です。

解説

次の表は、オブジェクトによって Name プロパティの設定値がどのように異なるかを示します。

オブジェクト	Name プロパティの設定値を使用した結果
VBProject	アクティブなプロジェクトの名前の取得または設定を行います。
VBComponent	コンポーネントの名前の取得または設定を行います。Name プロパティに既に使用されている名前または不正な名前を設定すると、エラーが発生します。
Property	プロパティ ウィンドウに表示されるプロパティの名前を取得します。このプロパティ名は、Properties コレクションを識別するために使用されます。プロパティ名を設定することはできません。
Reference	コード内の参照の名前を取得します。参照名を設定することはできません。
新しいオブジェクトの既定の名前は、オブジェクト型と重複しない整数を組み合わせた名前になります。たとえば、最初に新規作成された Form オブジェクトは、Form1 です。フォーム上で 3 番目に作成されたテキスト ボックス (TextBox) コントロールは、TextBox3 になります。

オブジェクトの Name プロパティは、文字で始まる必要があります。プロパティには最大 40 文字を格納できます。Name プロパティには、数字およびアンダースコア (_) を含めることができます。ただし、区切り文字またはスペースを含めることはできません。フォームおよびモジュールに Clipboard オブジェクト、Screen オブジェクト、および App オブジェクトのなどの他のパブリック オブジェクトと同じ名前を付けることはできません。Name プロパティには、キーワード、プロパティ名、または他のオブジェクトの名前を設定できるので、コード内で競合する可能性があります。


NumIndices プロパティ (VBA アドイン オブジェクト モデル)

Property オブジェクトによって返されるプロパティのインデックスの数を返します。

解説

NumIndices プロパティの値は、0 ～ 4 の範囲の整数です。多くのプロパティでは、NumIndices プロパティは、0 を返します。通常、インデックス番号付きのプロパティは、1 を返します。プロパティ配列の場合は、2 を返します。


Object プロパティ

プロパティによって返されるオブジェクトの値を設定します。値の取得も可能です。

解説

プロパティがオブジェクトを返す場合、Object プロパティを使ってオブジェクトの値の取得および設定を行わなければなりません。


Parent プロパティ

別のオブジェクトまたはコレクションを含むオブジェクトまたはコレクションを返します。値の取得のみ可能です。

解説

多くのオブジェクトは、このオブジェクト モデル内での親オブジェクトを指す Parent プロパティ、または Collection プロパティのいずれかを持っています。親オブジェクトがコレクションの場合、Collection プロパティが使用されます。

オブジェクトの親オブジェクトのプロパティ、メソッド、およびコントロールを操作するには、Parent プロパティを使用します。


ProcBodyLine プロパティ

プロシージャの先頭行を返します。

構文

object.ProcBodyLine(procname, prockind) As Long

ProcBodyLine の構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
procname	必ず指定します。プロシージャ名を表す文字列型 (String) の値を指定します。
prockind	必ず指定します。対象とするプロシージャの種類を指定します。Property プロシージャの場合、モジュール内で複数の種類が使用されるため、対象とするプロシージャの種類を指定する必要があります。Property プロシージャ以外のプロシージャ (Sub プロシージャおよび Function プロシージャ) では、定数 vbext_pk_Proc を使用します。
引数 prockind には、次の定数のうちの 1 つを使用できます。

定数	内容
vbext_pk_Get	プロパティの値を取得するプロシージャを指定します。
vbext_pk_Let	プロパティに値を設定するプロシージャを指定します。
vbext_pk_Set	オブジェクトへの参照を設定するプロシージャを指定します。
vbext_pk_Proc	Property プロシージャ以外のすべてのプロシージャを指定します。
解説

Sub、Function、または Property の各ステートメントが表示される行が、プロシージャの先頭行になります。


ProcCountLines プロパティ

指定されたプロシージャの行数を返します。

構文

object.ProcCountLines(procname, prockind) As Long

ProcCountLines プロパティの構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
procname	必ず指定します。プロシージャ名を表す文字列型 (String) の値を指定します。
prockind	必ず指定します。対象とするプロシージャの種類を指定します。Property プロシージャの場合、モジュール内で複数の種類が使用されるため、対象とするプロシージャの種類を指定する必要があります。Property プロシージャ以外のプロシージャ (Subプロシージャおよび Function プロシージャ) では、定数 vbext_pk_Proc を使用します。
引数 prockind には、次の定数のうちの 1 つを指定できます。

定数	内容
vbext_pk_Get	プロパティの値を取得するプロシージャを指定します。
vbext_pk_Let	プロパティに値を設定するプロシージャを指定します。
vbext_pk_Set	オブジェクトへの参照を設定するプロシージャを指定します。
vbext_pk_Proc	Property プロシージャ以外のすべてのプロシージャを指定します。
解説

ProcCountLines メソッドを使用すると、プロシージャの宣言以前に記述されたすべての空白行とコメント行を含んだプロシージャの行数を取得できます。指定されたプロシージャがコード モジュール内の最後のプロシージャである場合は、さらにプロシージャ以降の空白行を含んだ行数が返されます。


ProcOfLine プロパティ

指定された行を含むプロシージャの名前を返します。

構文

object.ProcOfLine(line, prockind) As String

ProcOfLine プロパティの構文には次の指定項目があります。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
line	必ず指定します。調べる行を表す長整数型 (Long) の値を指定します。
prockind	必ず指定します。対象とするプロシージャの種類を指定します。Property プロシージャの場合、モジュール内で複数の種類が使用されるため、対象とするプロシージャの種類を指定する必要があります。Property プロシージャ以外のプロシージャ (Sub プロシージャおよび Function プロシージャ) では、定数 vbext_pk_Proc を使用します。
引数 prockind には、次の定数のうちの 1 つが使用できます。

定数	内容
vbext_pk_Get	プロパティの値を取得するプロシージャを指定します。
vbext_pk_Let	プロパティに値を設定するプロシージャを指定します。
vbext_pk_Set	オブジェクトへの参照を設定するプロシージャを指定します。
vbext_pk_Proc	Property プロシージャ以外のすべてのプロシージャを指定します。
解説

プロシージャの宣言以前に記述された空白行とコメント行は、プロシージャ内の行となります。プロシージャがコード モジュール内の最後のプロシージャであるときは、プロシージャ以降の空白行またはコメント行もまたプロシージャ内の行となります。


ProcStartLine プロパティ

指定されたプロシージャが始まる行を返します。

構文

object.ProcStartLine(procname, prockind) As Long

ProcStartLine プロパティの構文は、次の指定項目から構成されます。

指定項目	内容
object	必ず指定します。オブジェクトへの参照を表すオブジェクト式を指定します。
procname	必ず指定します。プロシージャ名を含む文字列型 (String) の値を指定します。
prockind	必ず指定します。対象とするプロシージャの種類を指定します。Property プロシージャの場合、モジュール内で複数の種類が使用されるため、対象とするプロシージャの種類を指定する必要があります。Property プロシージャ以外のプロシージャ (Sub プロシージャおよび Function プロシージャ) では、定数 vbext_pk_Proc を使用します。
引数 prockind には、次の定数のうちの 1 つを指定できます。

定数	内容
vbext_pk_Get	プロパティの値を取得するプロシージャを指定します。
vbext_pk_Let	プロパティに値を設定するプロシージャを指定します。
vbext_pk_Set	オブジェクトへの参照を設定するプロシージャを指定します。
vbext_pk_Proc	Property プロシージャ以外のすべてのプロシージャを指定します。
解説

プロシージャは、前のプロシージャの End Sub ステートメントの次の行から始まります。先頭のプロシージャの場合は、宣言セクションの次の行がプロシージャの開始行になります


Protection プロパティ

プロジェクトの保護状態を示す値を返します。値の取得のみ可能です。

戻り値

Protection プロパティの戻り値は、次のとおりです。

定数	内容
vbext_pp_locked	指定したプロジェクトは、ロックされています。
vbext_pp_none	指定したプロジェクトは、保護されていません。


Properties プロパティ

オブジェクトのプロパティを返します。値の取得のみが可能です。

解説

Properties プロパティは、名前と同じ種類のオブジェクト名を返すアクセス プロパティです。


References プロパティ

プロジェクト内の一連の参照を返します。値の取得のみが可能です。

解説

References プロパティは、名前と同じ種類のオブジェクト名を返すアクセスプロパティです。


ReferencesEvents プロパティ

ReferencesEvents オブジェクトを返します。値の取得のみ可能です。

設定値

ReferencesEvents プロパティに渡される引数の設定値は、次のとおりです。

引数	内容
vbproject	引数 vbproject が Nothing を指す場合、返されるオブジェクトは、VBProjects コレクション内のすべての VBProject オブジェクトの References コレクションに対してイベントを提供します。 引数 vbproject が有効な VBProject オブジェクトを指す場合、返されるオブジェクトは、プロジェクトの References コレクションに対してのみイベントを提供します。
解説

ReferencesEvents プロパティは、引数を取得し、イベント ソース オブジェクトを返します。ReferencesEvents オブジェクトは、参照が追加または削除されたときに発生するイベントの発生元です。


Saved プロパティ

最後に保存した後、オブジェクトが編集されたかどうかを示すブール型 (Boolean) の値を返します。値の設定も可能です。

戻り値

Saved プロパティの戻り値は、次のとおりです。

値	内容
True	最後に保存した後、オブジェクトは編集されていません。
False	最後に保存した後、オブジェクトは編集されています。
解説

SaveAs メソッドは、Saved プロパティに真 (True) 設定します。

メモ   コード内で Saved プロパティに偽 (False) を設定すると、Saved プロパティは偽 (False) を返します。また、オブジェクトは最後に保存した後で編集されたものとみなされます。


SelectedVBComponent プロパティ

選択中のコンポーネントを返します。値の取得のみ可能です。

解説

SelectedVBComponent プロパティは、プロジェクト ウィンドウ内の選択中のコンポーネントを返します。プロジェクト ウィンドウ内の選択中の項目がコンポーネントでない場合、SelectedVBComponent プロパティは Nothing を返します。


Top プロパティ

twip 単位で画面上のウィンドウの左端の位置を表す単精度浮動小数点数型 (Single) の値を設定します。値の取得も可能です。

解説

Top プロパティによって返される値は、ウィンドウがドッキング ウィンドウまたはリンク ウィンドウであるか、またはドッキング ビューの状態であるかどうかによって異なります。

メモ   リンクまたはドッキングされたウィンドウの Top プロパティの設定値を変更しても、ウィンドウがリンクまたはドッキングされている間は影響ありません。


TopLine プロパティ

コード ペインの最上部の行の行番号を表す長整数型 (Long) の値を返します。コード ペインの最上部に表示する行番号の設定も可能です。

解説

TopLine プロパティを使用して、コード ペインの最上部に表示される行数の取得および設定を行うことができます。たとえば、25 行目をコード ペインの最上部に表示する場合、TopLine プロパティに 25 を設定します。

TopLine プロパティには、正の数を設定しなければなりません。TopLine プロパティの設定値がコード ペイン内の実際のコードの行数を超える場合、設定値はコード ペイン内の最後の行になります。


Type プロパティ

オブジェクト型を含む数値または文字列値を返します。値の取得のみ可能です。

戻り値

Window オブジェクトの Type プロパティの戻り値は、次のとおりです。

定数	値	内容
vbext_wt_CodeWindow	0	コード ウィンドウ
vbext_wt_Designer	1	デザイナ
vbext_wt_Browser	2	オブジェクト ブラウザ
vbext_wt_Watch	3	ウォッチ  ウィンドウ
vbext_wt_Locals	4	ローカル ウィンドウ
vbext_wt_Immediate	5	イミディエイト ウィンドウ
vbext_wt_ProjectWindow	6	プロジェクト ウィンドウ
vbext_wt_PropertyWindow	7	プロパティ ウィンドウ
vbext_wt_Find	8	[検索] ダイアログ ボックス
vbext_wt_FindReplace	9	[置換] ダイアログ ボックス
vbext_wt_Toolbox	10	ツールボックス
vbext_wt_LinkedWindowFrame	11	リンク ウィンドウ フレーム
vbext_wt_MainWindow	12	メイン ウィンドウ
vbext_wt_ToolWindow	15	ツール ウィンドウ
重要   Macintosh バージョンでは、Windows で作成されたコードとの互換性のために、リンク ウィンドウ、リンク ウィンドウ フレームおよびドッキング ウィンドウを制御するオブジェクト、プロパティおよびメソッドが含まれていますが、これらの言語要素を含むコードを Macintosh 上で実行した場合、実行時エラーが発生します。

VBComponent オブジェクトの Type プロパティの設定値は、次のとおりです。

定数	値	内容
vbext_ct_StdModule	1	標準モジュール
vbext_ct_ClassModule	2	クラス モジュール
vbext_ct_MSForm	3	Microsoft Form
vbext_ct_ActiveXDesigner	11	ActiveX デザイナ
vbext_ct_Document	100	Document モジュール
Reference オブジェクトの Type プロパティの設定値は、次のとおりです。

定数	値	内容
vbext_rk_TypeLib	0	タイプ ライブラリ
vbext_rk_Project	1	プロジェクト
VBProject オブジェクトの Type プロパティの設定値は、次のとおりです。

定数	値	内容
vbext_pt_HostProject	100	ホスト プロジェクト
vbext_pt_StandAlone	101	スタンドアロン プロジェクト


Value プロパティ

プロパティに設定する値をバリアント型 (Variant) の値で設定します。値の取得も可能です。

解説

Value プロパティはバリアント型 (Variant) で値を返すので、どのプロパティでも操作できます。リストを操作するには、IndexedValue プロパティを使用します。

Property オブジェクトが表すプロパティが値の取得および設定が可能な場合、Value プロパティは値の取得および設定を行うことができます。プロパティが値の取得のみ可能な場合、Value プロパティに値を設定しようとすると、エラーが発生します。プロパティが値の設定のみ可能な場合は、Value プロパティから値を取得しようとすると、エラーが発生します。

Value プロパティは、Property オブジェクトの既定のプロパティです。


VBComponents プロパティ

プロジェクト内に含まれるコンポーネントのコレクションを返します。

解説

VBComponents コレクションを使用すると、プロジェクト内のコンポーネントを使用したり、追加したり、あるいは削除することができます。フォーム モジュール、標準モジュールまたはクラス モジュールがコンポーネントとして挙げられます。VBComponent コレクションは、For... Each ステートメントで使用できる標準的なコレクションです。.

Parent プロパティを使用すると、VBComponents コレクションを含んでいるオブジェクトが返されます。

Visual Basic for Applications Edition では、Import メソッドを使用すると、コンポーネントのファイルをプロジェクトに追加することができます。


VBE プロパティ

VBE オブジェクトのルートを返します。値の取得のみ可能です。

解説

すべてのオブジェクトは、VBE オブジェクトのルートを指す VBE プロパティを持っています。


Version プロパティ

アプリケーションが使用している Visual Basic for Applications のバージョンを表す文字列型 (String) の値を返します。値の取得のみ可能です。

解説

Version プロパティの値は、1 桁または 2桁の数字の後に、ピリオドと 2 桁の数字が続く文字列です。文字列のそれ以降の部分は未定義で、テキストまたは数値を含むことがあります。


Visible プロパティ

Window オブジェクトについては、ウィンドウを表示するか、非表示にするかを指定するブール型 (Boolean) の値を設定します。値の取得も可能です。CodePane オブジェクトについては、ウィンドウ内でコード ペインが表示されているかどうかを示すブール型 (Boolean) の値を返します。値の取得のみ可能です。

戻り値

Visible プロパティの戻り値は、次のとおりです。

値	内容
True	(既定値) オブジェクトは表示されています。
False	オブジェクトは非表示です。


Width プロパティ

twip 単位でウィンドウの幅を表す単精度浮動小数点数型 (Single) の値を設定します。値の取得も可能です。

解説

リンク ウィンドウまたはドッキング ウィンドウの Width プロパティの設定値を変更しても、ウィンドウがリンクまたはドッキングされている間は影響ありません。


Window プロパティ

コード ペイン内に表示されているウィンドウを返します。値の取得のみ可能です。


WindowState プロパティ

ウィンドウの表示状態を指定する数値を設定します。値の取得も可能です。

設定値

WindowState プロパティの設定値は、次のとおりです。

定数	値	内容
vbext_ws_Normal	0	(既定値) ノーマル
vbext_ws_Min	1	最小化 (タスクバーに縮小表示)
vbext_ws_Max	2	最大化 (画面全体に拡大表示)


CommandBars プロパティ

ショートカット メニューをサポートするコマンドバーを含む、プロジェクト内のすべてのコマンドバーを返します。


AddIns プロパティ

アドインのコレクションを返します。拡張オブジェクト モデルにアドインのオートメーション コンポーネントを登録するときに使用します。

構文

object.AddIns

引数 object には、オブジェクトへの参照を表すオブジェクト式を指定します。


Events プロパティ

Visual Basic for Applications Edition のすべてのイベント名が返されます。アドインで VBA のイベントに接続することができます。

構文

object.Events

引数 object には、オブジェクトへの参照を表すオブジェクト式を指定します。


VBProjects プロパティ

現在 Visual Basic の開発環境で開かれているすべてのプロジェクトを表す VBProjects コレクションを返します。

構文

object.VBProjects

引数 object には、オブジェクトへの参照を表すオブジェクト式 を指定します。


Windows プロパティ

Visual Basic の開発環境のウィンドウを表す Window オブジェクトを返します。

構文

object.Window

引数 object には、オブジェクトへの参照を表すオブジェクト式を指定します。


ProgID プロパティ

VBControl オブジェクトによって表されるコントロールのプログラム ID （ProgID) を返します。

構文

object.ProgID

引数 object には、オブジェクトへの参照を表すオブジェクト式を指定します。