214 lines
16 KiB
HTML
214 lines
16 KiB
HTML
<html xmlns:mshelp="http://msdn.microsoft.com/mshelp">
|
|
<head>
|
|
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
|
|
<meta content="history" name="save">
|
|
<meta content="Innovasys Document! X (http://www.innovasys.com)" name="GENERATOR">
|
|
<title>AddCmd Method (IEdmCmdMgr5)</title>
|
|
<link href="stylesheets/dotnet2005.css" type="text/css" rel="stylesheet">
|
|
<script src="script/dotnet2005.js" type="text/javascript">
|
|
</script><xml>
|
|
<MSHelp:Keyword Index="F" Term="EPDM.Interop.epdm.IEdmCmdMgr5.AddCmd" />
|
|
<MSHelp:Attr Name="DevLang" Value="CSharp" />
|
|
<MSHelp:Attr Name="DevLang" Value="VB" />
|
|
<MSHelp:Attr Name="DevLang" Value="JScript" />
|
|
<MSHelp:Attr Name="TopicType" Value="kbSyntax"/>
|
|
<MSHelp:Attr Name="LinkGroup" Value="Help"/>
|
|
<MSHelp:Attr Name="Locale" Value="kbEnglish"/>
|
|
<MSHelp:Attr Name="HelpPriority" Value="1"/>
|
|
</xml>
|
|
|
|
|
|
<script src="script/hs-expandcollapse.js" type="text/javascript"></script>
|
|
<script src="script/hs-enlargeimage.js" type="text/javascript"></script>
|
|
<script src="script/swfobject.js" type="text/javascript"></script>
|
|
<script src="script/hs-common.js" type="text/javascript"></script>
|
|
<script src="script/hs-heading-expandcollapse.js" type="text/javascript"></script>
|
|
<script src="script/hs-tabstrip.js" type="text/javascript"></script>
|
|
</head>
|
|
|
|
<body id="dxBody" topmargin="0">
|
|
<form>
|
|
<input class="userDataStyle" id="userDataCache" type="hidden" name="userDataCache"> <input id="hiddenScrollOffset" type="hidden" name=
|
|
"hiddenScrollOffset"> <img id="collapseImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/collapse.gif"> <img id="expandImage"
|
|
style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/expand.gif"> <img id="collapseAllImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px"
|
|
src="dotnetimages/collapse.gif"> <img id="expandAllImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/expand.gif"> <img id=
|
|
"dropDownImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/drpdown.gif"> <img id="dropDownHoverImage" style=
|
|
"DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/drpdown_orange.gif"> <img id="copyImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src=
|
|
"dotnetimages/copycode.gif"> <img id="copyHoverImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/copycodeHighlight.gif">
|
|
|
|
</form>
|
|
|
|
<div id="pagetop">
|
|
|
|
|
|
<table id="pagetoptable1" width="100%">
|
|
<tbody>
|
|
<tr id="pagetoptable1row1">
|
|
<td align="left"><span id="projecttitle">SOLIDWORKS PDM Professional API Help</span></td>
|
|
|
|
<td align="right"><span id="feedbacklink"><a href="mailto:apihelp.feedback@3ds.com?subject=Documentation Feedback: EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmCmdMgr5~AddCmd.html">Send Feedback</a></span></td>
|
|
</tr>
|
|
|
|
<tr id="pagetoptable1row2">
|
|
<td align="left" colspan="2"><span id="pagetitle">AddCmd Method (IEdmCmdMgr5)</span></td>
|
|
</tr>
|
|
|
|
<tr id="pagetoptable1row3">
|
|
<td colspan="2"><a onclick="javascript:openSectionById('seeAlsoSectionHeader');" href="#seealsobookmark">
|
|
See Also</a>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<table id="pagetoptable2" cellspacing="0" cellpadding="0" width="100%">
|
|
<tbody>
|
|
<tr>
|
|
<td><span id="toggleExpandedAll"><img class="toggleAll" id="toggleExpandedAllImage" src="dotnetimages/collapse.gif"> <label id=
|
|
"collapseAllLabel" style="DISPLAY: none" for="toggleExpandedAllImage">Collapse All</label> <label id="expandAllLabel" style="DISPLAY: none" for="toggleExpandedAllImage">
|
|
Expand All</label></span> <span id="languageFilterToolTip"
|
|
onmouseover='document.getElementById("languageFilterImage").src=document.getElementById("dropDownHoverImage").src;' style="CURSOR: default"
|
|
onfocusout='document.getElementById("languageFilterImage").src=document.getElementById("dropDownImage").src;' onclick=
|
|
"showBox('dxlanguagemenu',event,document.getElementById('languageFilterImage'))" onfocusin=
|
|
'document.getElementById("languageFilterImage").src=document.getElementById("dropDownHoverImage").src;' onmouseout=
|
|
'document.getElementById("languageFilterImage").src=document.getElementById("dropDownImage").src;'><img id="languageFilterImage" src=
|
|
"dotnetimages/drpdown.gif"> <label id="showAllLabel" style="DISPLAY: none" for="languageFilterImage">
|
|
Language Filter: All</label> <label id="multipleLabel" style=
|
|
"DISPLAY: none" for="languageFilterImage">Language Filter: Multiple</label>
|
|
|
|
<label id="VBLabel" for="languageFilterImage" style="display: none;">Language Filter: Visual Basic</label>
|
|
<label id="CSLabel" for="languageFilterImage" style="display: none;">Language Filter: C#</label>
|
|
<label id="CPP2005Label" for="languageFilterImage" style="display: none;">Language Filter: C++/CLI</label>
|
|
</span></td>
|
|
</tr>
|
|
</tbody>
|
|
</table><table width="100%" id="pagetopbreadcrumbs" cellspacing="0" cellpadding="0"><tr><td>
|
|
<a href="EPDM.Interop.epdm~EPDM.Interop.epdm_namespace.html">EPDM.Interop.epdm Namespace</a>
|
|
> <a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmCmdMgr5.html">IEdmCmdMgr5 Interface</a>
|
|
: AddCmd Method (IEdmCmdMgr5)</td></tr></table>
|
|
|
|
<div class="dxpopupbubble" id="dxlanguagemenu">
|
|
|
|
<input id="VBCheckbox" type="checkbox" name="languageFilter" onClick="setLanguage(this)" />
|
|
<label class="languageFilter" for="VBCheckbox">
|
|
Visual Basic
|
|
</label>
|
|
<br /><input id="CSCheckbox" type="checkbox" name="languageFilter" onClick="setLanguage(this)" />
|
|
<label class="languageFilter" for="CSCheckbox">
|
|
C#
|
|
</label>
|
|
<br /><input id="CPP2005Checkbox" type="checkbox" name="languageFilter" onClick="setLanguage(this)" />
|
|
<label class="languageFilter" for="CPP2005Checkbox">
|
|
C++/CLI
|
|
</label>
|
|
|
|
</div>
|
|
<div id="lCmdID_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>lCmdID</I></DT>
|
|
<DD class="popupbubble">Command ID (see <STRONG>Remarks</STRONG>)</DD></DL>
|
|
</div>
|
|
<div id="bsMenuString_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>bsMenuString</I></DT>
|
|
<DD class="popupbubble">Text to show in the menu</DD></DL>
|
|
</div>
|
|
<div id="lEdmMenuFlags_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>lEdmMenuFlags</I></DT>
|
|
<DD class="popupbubble">Optional combination of <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmMenuFlags.html">EdmMenuFlags</A></DD></DL>
|
|
</div>
|
|
<div id="bsStatusBarHelp_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>bsStatusBarHelp</I></DT>
|
|
<DD class="popupbubble">Optional text to show in the File Explorer status bar when the user highlights the menu entry in the right-click context menu</DD></DL>
|
|
</div>
|
|
<div id="bsToolbarToolTip_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>bsToolbarToolTip</I></DT>
|
|
<DD class="popupbubble">Optional message to display when the cursor is located over the command's toolbar button</DD></DL>
|
|
</div>
|
|
<div id="lToolbarButtonIndex_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>lToolbarButtonIndex</I></DT>
|
|
<DD class="popupbubble">Optional index of a toolbar button in a resource image (see <STRONG>Remarks</STRONG>)</DD></DL>
|
|
</div>
|
|
<div id="lToolbarImageID_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>lToolbarImageID</I></DT>
|
|
<DD class="popupbubble">Optional ID of the image to use as a toolbar button (see <STRONG>Remarks</STRONG>)</DD></DL>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="pagebody" valign="bottom">
|
|
<a name="topBookmark"></a>
|
|
|
|
<div id="mainbody">
|
|
<div class="saveHistory" id="allHistory" onsave="saveAll()" onload="loadAll()"></div>
|
|
Adds a toolbar button to the File Explorer <STRONG>Tools</STRONG> menu and a menu command to the right-click context-sensitive menu of SOLIDWORKS PDM Professional vault files and folders.
|
|
|
|
|
|
<h1 class="heading"><span class="expandcollapse" tabindex="0"><img id="syntaxToggle" class="toggle" name="toggleSwitch" src="dotnetimages/collapse.gif"></img>Syntax</span></h1><div id="syntaxSection" class="section" name="collapseableSection"><DIV class=LanguageSpecific id=Syntax_VB><table class="syntaxtable" width="100%" cellpadding="0" cellspacing="0"><tr><th>Visual Basic</th><th> </th></tr><tr><td colspan="2"><pre>Sub AddCmd( _
|
|
ByVal <i><a class="parameter" id="lCmdID" href="#" onclick="javascript:showParamBox(event);">lCmdID</a></i> As System.Integer, _
|
|
ByVal <i><a class="parameter" id="bsMenuString" href="#" onclick="javascript:showParamBox(event);">bsMenuString</a></i> As System.String, _
|
|
Optional ByVal <i><a class="parameter" id="lEdmMenuFlags" href="#" onclick="javascript:showParamBox(event);">lEdmMenuFlags</a></i> As System.Integer, _
|
|
Optional ByVal <i><a class="parameter" id="bsStatusBarHelp" href="#" onclick="javascript:showParamBox(event);">bsStatusBarHelp</a></i> As System.String, _
|
|
Optional ByVal <i><a class="parameter" id="bsToolbarToolTip" href="#" onclick="javascript:showParamBox(event);">bsToolbarToolTip</a></i> As System.String, _
|
|
Optional ByVal <i><a class="parameter" id="lToolbarButtonIndex" href="#" onclick="javascript:showParamBox(event);">lToolbarButtonIndex</a></i> As System.Integer, _
|
|
Optional ByVal <i><a class="parameter" id="lToolbarImageID" href="#" onclick="javascript:showParamBox(event);">lToolbarImageID</a></i> As System.Integer _
|
|
) </pre></tr></table></div>
|
|
<DIV class=LanguageSpecific id=Syntax_CS><table class="syntaxtable" width="100%" cellpadding="0" cellspacing="0"><tr><th>C#</th><th> </th></tr><tr><td colspan="2"><pre>void AddCmd(
|
|
System.int <i><a class="parameter" id="lCmdID" href="#" onclick="javascript:showParamBox(event);">lCmdID</a></i>,
|
|
System.string <i><a class="parameter" id="bsMenuString" href="#" onclick="javascript:showParamBox(event);">bsMenuString</a></i>,
|
|
System.int <i><a class="parameter" id="lEdmMenuFlags" href="#" onclick="javascript:showParamBox(event);">lEdmMenuFlags</a></i>,
|
|
System.string <i><a class="parameter" id="bsStatusBarHelp" href="#" onclick="javascript:showParamBox(event);">bsStatusBarHelp</a></i>,
|
|
System.string <i><a class="parameter" id="bsToolbarToolTip" href="#" onclick="javascript:showParamBox(event);">bsToolbarToolTip</a></i>,
|
|
System.int <i><a class="parameter" id="lToolbarButtonIndex" href="#" onclick="javascript:showParamBox(event);">lToolbarButtonIndex</a></i>,
|
|
System.int <i><a class="parameter" id="lToolbarImageID" href="#" onclick="javascript:showParamBox(event);">lToolbarImageID</a></i>
|
|
)</pre></tr></table></div>
|
|
<DIV class=LanguageSpecific id=Syntax_CPP2005><table class="syntaxtable" width="100%" cellpadding="0" cellspacing="0"><tr><th>C++/CLI</th><th> </th></tr><tr><td colspan="2"><pre>void AddCmd(
|
|
& System.int <i><a class="parameter" id="lCmdID" href="#" onclick="javascript:showParamBox(event);">lCmdID</a></i>,
|
|
& System.String^ <i><a class="parameter" id="bsMenuString" href="#" onclick="javascript:showParamBox(event);">bsMenuString</a></i>,
|
|
& System.int <i><a class="parameter" id="lEdmMenuFlags" href="#" onclick="javascript:showParamBox(event);">lEdmMenuFlags</a></i>,
|
|
& System.String^ <i><a class="parameter" id="bsStatusBarHelp" href="#" onclick="javascript:showParamBox(event);">bsStatusBarHelp</a></i>,
|
|
& System.String^ <i><a class="parameter" id="bsToolbarToolTip" href="#" onclick="javascript:showParamBox(event);">bsToolbarToolTip</a></i>,
|
|
& System.int <i><a class="parameter" id="lToolbarButtonIndex" href="#" onclick="javascript:showParamBox(event);">lToolbarButtonIndex</a></i>,
|
|
& System.int <i><a class="parameter" id="lToolbarImageID" href="#" onclick="javascript:showParamBox(event);">lToolbarImageID</a></i>
|
|
) </pre></tr></table></div>
|
|
|
|
<h4 class=dxh4>Parameters</h4><DL><DT><I>lCmdID</I></DT>
|
|
<DD>Command ID (see <STRONG>Remarks</STRONG>)</DD><DT><I>bsMenuString</I></DT>
|
|
<DD>Text to show in the menu</DD><DT><I>lEdmMenuFlags</I></DT>
|
|
<DD>Optional combination of <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmMenuFlags.html">EdmMenuFlags</A></DD><DT><I>bsStatusBarHelp</I></DT>
|
|
<DD>Optional text to show in the File Explorer status bar when the user highlights the menu entry in the right-click context menu</DD><DT><I>bsToolbarToolTip</I></DT>
|
|
<DD>Optional message to display when the cursor is located over the command's toolbar button</DD><DT><I>lToolbarButtonIndex</I></DT>
|
|
<DD>Optional index of a toolbar button in a resource image (see <STRONG>Remarks</STRONG>)</DD><DT><I>lToolbarImageID</I></DT>
|
|
<DD>Optional ID of the image to use as a toolbar button (see <STRONG>Remarks</STRONG>)</DD></DL>
|
|
|
|
</div>
|
|
|
|
<a name="exampleBookmark"></a>
|
|
|
|
|
|
|
|
<h1 class="heading"><span class="expandcollapse" tabindex="0"><img id="remarksToggle" class="toggle" name="toggleSwitch" src="dotnetimages/collapse.gif"></img>Remarks</span></h1><div id="remarksSection" class="section" name="collapseableSection"><P>Call this method in your implementation of <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmAddIn5~GetAddInInfo.html">IEdmAddIn5::GetAddInInfo</A> to:</P>
|
|
<UL>
|
|
<LI>Add command buttons to the File Explorer toolbar. Before calling IEdmCmdMgr5::AddCmd, call <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmCmdMgr5~AddToolbarImage.html">IEdmCmdMgr5::AddToolbarImage</A> to register an image with the toolbar button you want to add.
|
|
<LI>Add menu commands to the File Explorer Tools menu.
|
|
<LI>Add menu commands to the right-click context menu of files or folders in the SOLIDWORKS PDM Professional vault.</LI></UL>
|
|
<P>lCmdID can be any value. SOLIDWORKS PDM Professional passes it to your implementation of <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmAddIn5~OnCmd.html">IEdmAddIn5::OnCmd</A> via <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmCmd.html">EdmCmd</A>::mlCmdID.</P>
|
|
<P>lToolbarButtonIndex is the index of the toolbar image in a resource image that contains several images.</P>
|
|
<P>lToolbarImageID is the same as the lImageID parameter of IEdmCmdMgr5::AddToolbarImage.</P>
|
|
<P><STRONG>NOTE:</STRONG> Menu commands and toolbar buttons added using this method display only when the user browses a SOLIDWORKS PDM Professional file vault. They do not display for ordinary Windows folders.</P>
|
|
<P><A href="ReturnCodes.htm">Return codes</A>:</P>
|
|
<UL>
|
|
<LI>S_OK: The method successfully executed.
|
|
<LI>S_FALSE: One of the arguments is invalid. </LI></UL></div>
|
|
<a name="seealsobookmark"></a>
|
|
<h1 class="heading"><span class="expandcollapse" tabindex="0"><img id="seealsoToggle" class="toggle" name="toggleSwitch" src="dotnetimages/collapse.gif"></img>See Also</span></h1><div id="seealsoSection" class="section" name="collapseableSection"><h4 class="dxh4"></h4><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmCmdMgr5.html">IEdmCmdMgr5 Interface</a>
|
|
<br/><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmCmdMgr5_members.html">IEdmCmdMgr5 Members</a>
|
|
<br/><a href="AddInAdminMenu.htm">Administration Menu for Add-ins</a>
|
|
<br/><a href="vbmenuitem.htm">Creating Menu Commands (VB.NET)</a>
|
|
</p>
|
|
</div>
|
|
<h1 class="heading"><span class="expandcollapse" tabindex="0"><img id="availabilityToggle" class="toggle" name="toggleSwitch" src="dotnetimages/collapse.gif"></img>Availability</span></h1><div id="availabilitySection" class="section" name="collapseableSection">SOLIDWORKS PDM Professional Version 5.2</div>
|
|
</div>
|
|
|
|
<div id="pagefooter"></div>
|
|
</div>
|
|
</body>
|
|
</html> |