Function InsertToolbarItem( _
   const dsString& ApiUuid As System.String, _
   dsToolbarItemType_e ItemType As dsToolbarItemType_e, _
   long Position As System.Integer, _
   const dsString& ItemName As System.String, _
   const dsString& UserCmdID As System.String _
) As ToolbarItem

ToolbarItem InsertToolbarItem( 
   System.string ApiUuid,
   dsToolbarItemType_e ItemType,
   System.int Position,
   System.string ItemName,
   System.string UserCmdID
)

InsertToolbarItem( 
   ApiUuid : String,
   ItemType : String,
   Position : Number,
   ItemName : String,
   UserCmdID : String
) : dsToolbarItem

HRESULT InsertToolbarItem( 
   BSTR ApiUuid,
   dsToolbarItemType_e ItemType,
   LONG Position,
   BSTR ItemName,
   BSTR UserCmdID,
   IToolbarItem** Item
) 

DSRESULT InsertToolbarItem( 
   const dsString& ApiUuid,
   dsToolbarItemType_e ItemType,
   long Position,
   const dsString& ItemName,
   const dsString& UserCmdID,
   dsToolbarItem** Item
) 

Parameters

ApiUuid

UUID of the add-in or non add-in application

ItemType

Type of toolbar item as defined in dsToolbarItemType_e

Position

1-based index indicating where to insert toolbar item in the toolbar

ItemName

Name of toolbar item

UserCmdID

User-defined command ID when ItemType is dsToolbarItemType_e.dsToolBarItemType_UserCommand

Item[out] or Return Value

Toolbar item

The following code snippets show how to add a toolbar button with a ToolTip to a toolbar:

• COM native C++ (from the DraftSight API COM native C++ template files DsAddinConnection.cpp and DsAddinUserCommand.cpp)
• C++ (COM native C++ (from the DraftSight API C++ template file dsAddinConnection.cpp)

COM native C++

DsAddinConnection.cpp

DsAddinUserCommand pNotepad(m_sApiUuid, L"Notepad", L"^C^CNotepad", L"Opens Notepad", L"path_and_file_name.bmp", L"path_and_file_name.png");

IToolbarPtr pToolbar = m_DsApp->AddToolbar( m_sApiUuid, dsUIState_Document, L"DsAddin Toolbar");

IToolbarItemPtr pToolbarItem;

pToolbarItem = pToolbar->InsertToolbarItem( m_sApiUuid, dsToolBarItemType_UserCommand, ++position, L"Open Notepad", pNotepad.GetUserCommandID()); 

DsAddinUserCommand.cpp 

C++

dsUserCommand_ptr pUserCmd;

dsApp->CreateUserCommand( myApplication::appID, UserCommandName, UserCmdString, Description, L"path_and_file_name.bmp", L"path_and_file_name.png", dsUIState_Document, &Error, &pUserCmd );

dsMenuItem_ptr pMenu;

dsApp->AddMenu(myApplication::appID, dsUIState_Document, MENU_POSITION, UserCommandName, &pMenu);

dsString UserCmdID1;

pUserCmd->GetID( &UserCmdID1 );

dsMenuItem_ptr pMenuItem;

pMenu->InsertMenuItem(myApplication::appID, dsMenuItemType_UserCommand, 1, L"Open Notepad", UserCmdID1, &pMenu);

if( ( dsCreateCommand_Succeeded == Error ) && ( NULL != pUserCmd ) )

{

dsString ToolbarName = L"QAddIn1_Toolbar";

dsToolbar_ptr pToolbar;

dsApp->AddToolbar( myApplication::appID, dsUIState_Document, ToolbarName, &pToolbar );

if( NULL != pToolbar )

 

{

dsToolbarItem_ptr pToolbarItem;

dsString ButtonName = L"Notepad";

dsString UserCmdID;

pMenu->GetID( &UserCmdID );

pToolbar->InsertToolbarItem( myApplication::appID, dsToolBarItemType_UserCommand, 1, ButtonName, UserCmdID, &pToolbarItem );

}

}

}

Back to top

To display the list of available toolbars, right-click a toolbar in the DraftSight user interface and select Toolbars to open the Specify Toolbars dialog.