AddToolbarButton メソッド(ActiveX)

ツールバー項目をツールバーの指定した位置に追加します。

サポートされているプラットフォーム: Windows のみ

構文と要素

VBA:

RetVal = object.AddToolbarButton(Index, Name, HelpString, Macro [, FlyoutButton])

object

タイプ: Toolbar

このメソッドが適用されるオブジェクト。

Index

アクセス: 入力のみ

タイプ: バリアント型

ツールバー項目を追加するツールバーのインデックス位置

インデックスは整数または文字列でなければなりません。整数を指定する場合は 0 から N-1 までとし、この場合 N はツールバー内のオブジェクトの数です。   この項目は、指定されたインデックス位置の直前に追加されます。

Name

アクセス: 入力のみ

タイプ: 文字列

ツールバー ボタンを識別する文字列。この文字列は、英数字、ダッシュ(-)、アンダースコア(_)で構成されていなければなりません。これら以外の句読点を使うことはできません。この文字列は、カーソルをツールバー ボタンの上に置いたときにツールチップとして表示されます。

HelpString

アクセス: 入力のみ

タイプ: 文字列

ボタンの AutoCAD のステータス行に表示される文字列。

Macro

アクセス: 入力のみ

タイプ: 文字列

この項目に関連付けられたマクロの名前。

FlyoutButton

アクセス: 入力のみ; オプション

タイプ: バリアント型

新しいボタンがフライアウト ボタンかそうでないかを示すブール型変数。ボタンがフライアウト ボタンである場合は、このパラメータを True に設定しなければなりません。ボタンがフライアウト ボタンでない場合は、このパラメータを False に設定するか無視することができます。このようにすると新しい ToolbarItem オブジェクトが返されます。

• True: ボタンはフライアウト ボタンです。
• Fakse: ボタンはフライアウト ボタンではありません。

戻り値(RetVal)

タイプ: ToolbarItem

新しく作成されるツールバー項目

注意

ツールバーが表示可能な場合、ツールバー ボタンのみ追加/削除できます。

例

VBA:

Sub Example_AddToolbarButton()
    ' This example creates a new toolbar called TestToolbar and inserts a
    ' toolbar button into it. The toolbar is then displayed.
    ' To remove the toolbar after execution of this macro, use the Customize Menu
    ' option from the Tools menu.
    
    Dim currMenuGroup As acadMenuGroup
    Set currMenuGroup = ThisDrawing.Application.MenuGroups.Item(0)
    
    ' Create the new toolbar
    Dim newToolBar As AcadToolbar
    Set newToolBar = currMenuGroup.Toolbars.Add("TestToolbar")
    
    ' Add a button to the new toolbar
    Dim newButton As AcadToolbarItem
    Dim openMacro As String
    
    ' Assign the macro string the VB equivalent of "ESC ESC _open "
    openMacro = Chr(3) & Chr(3) & Chr(95) & "open" & Chr(32)
    
    Set newButton = newToolBar.AddToolbarButton("", "NewButton", "Open a file.", openMacro)
    
    ' Display the toolbar
    newToolBar.Visible = True
    
End Sub

Visual LISP:

(vl-load-com)
(defun c:Example_AddToolbarButton()
    ;; This example creates a new toolbar called TestToolbar and inserts a
    ;; toolbar button into it. The toolbar is then displayed.
    ;; To remove the toolbar after execution of this macro, use the Customize Menu
    ;; option from the Tools menu.
    (setq acadObj (vlax-get-acad-object))
    (setq currMenuGroup (vla-Item (vla-get-MenuGroups acadObj) 0))
    
    ;; Create the new toolbar
    (setq newToolBar (vla-Add (vla-get-Toolbars currMenuGroup) "TestToolbar"))
    
    ;; Assign the macro string the VB equivalent of "ESC ESC _open "
    (setq openMacro (strcat (Chr 3) (Chr 3) (Chr 95) "open" (Chr 32)))
    (setq newButton (vla-AddToolbarButton newToolBar "" "NewButton" "Open a file." openMacro))
    
    ;; Display the toolbar
    (vla-put-Visible newToolBar :vlax-true)
)