Initial Commit of the PDM project (ready for DWS migration)
This commit is contained in:
will
235
documentation/api_extracted/csharpserno.htm
Normal file
235
documentation/api_extracted/csharpserno.htm
Normal file
@@ -0,0 +1,235 @@
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<title>Creating Serial Numbers (C#)</title>
|
||||
<meta name=MS-HKWD content="Serial numbers">
|
||||
<meta name=MS-HKWD content="Add-ins,C#">
|
||||
<meta name=MS-HKWD content="C# add-ins, serial numbers ">
|
||||
<meta http-equiv="Content-Language" content="en-us">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
|
||||
<link rel="stylesheet" type="text/css" href="ApiHelp.css">
|
||||
<style>
|
||||
<!--
|
||||
div.Section1
|
||||
{page:Section1;}
|
||||
.auto-style2 {
|
||||
color: #2B91AF;
|
||||
}
|
||||
-->
|
||||
</style>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1><span style="font-weight: normal; font-size: 7.5pt;">SOLIDWORKS PDM Professional API Help</span></h1>
|
||||
<h1>Creating Serial Numbers (C#)</h1>
|
||||
|
||||
<p class=MsoNormal><span lang=EN-US style='font-family:Verdana'>This
|
||||
sample shows how to generate serial numbers for file data cards using
|
||||
an add-in written in Visual C#.</span></p>
|
||||
<p class="MsoNormal"><font face="Verdana"><b>NOTES:</b> </font></p>
|
||||
<ul>
|
||||
<li>
|
||||
<p class=MsoNormal>
|
||||
<span lang=EN-US style='font-family:Verdana;
|
||||
mso-ansi-language:EN-US'>Because SOLIDWORKS PDM Professional cannot force a reload of
|
||||
add-ins if they are written in .NET, all client machines must be restarted to ensure that the latest version of the add-in is used.<o:p></o:p></span></p>
|
||||
</li>
|
||||
<li>
|
||||
<p class=MsoNormal><span lang=EN-US style='font-family:Verdana'>SOLIDWORKS
|
||||
PDM Professional recommends that serial numbers be generated using the built-in format strings or lists.
|
||||
They provide better performance than serial numbers generated by add-ins
|
||||
or serial numbers from files. Write an add-in to generate the serial
|
||||
number only if built-in format strings or lists are insufficient.</span><font face="Verdana"><span lang=EN-US> </span> </font></p>
|
||||
</li>
|
||||
<li>
|
||||
<p class=MsoNormal><span lang=EN-US style='font-family:Verdana'>The
|
||||
differences between serial number generation and <a href="csharpreactor.htm">other types of hooks</a>
|
||||
are:</span></p>
|
||||
<ul>
|
||||
<li>
|
||||
<p class=MsoNormal><span style="font-family: Verdana">H</span><span lang=EN-US style='font-family:Verdana'>ook you register in
|
||||
your
|
||||
<a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmAddIn5~GetAddInInfo.html">IEdmAddIn5::GetAddInInfo</a>
|
||||
method. </span></p></li>
|
||||
<li>
|
||||
<p class=MsoNormal><span style="font-family: Verdana">C</span><span lang=EN-US style='font-family:Verdana'>ontents of your
|
||||
<a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmAddIn5~OnCmd.html">IEdmAddIn5::OnCmd</a> method.</span></p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ol style="font-family: Verdana; font-size: 8pt">
|
||||
<li>
|
||||
<p class=MsoNormal><span style="font-family: Verdana">Follow </span><span lang=EN-US><font face="Verdana">
|
||||
<a href="csharpmenuitem.htm">Creating Menu Commands (C#)</a> to
|
||||
create a basic add-in.</font></span></p>
|
||||
</li>
|
||||
<li>
|
||||
<p class=MsoNormal><span style="font-family: Verdana">Register a hook to
|
||||
notify</span><span lang=EN-US style='font-family:Verdana'>
|
||||
your add-in when a serial
|
||||
number needs to be generated. Implement IEdmAddIn5::GetAddInInfo as follows:</span></p>
|
||||
<blockquote>
|
||||
<p style="font-family: Courier New; font-size: 13; color: black; background: white" class="APICODE">
|
||||
<span style="color:blue;">public</span> <span style="color:blue;">void</span> GetAddInInfo(<span style="color:blue;">ref</span> <span style="color:#2b91af;">EdmAddInInfo</span> poInfo, <span style="color:#2b91af;">IEdmVault5</span> poVault, <span style="color:#2b91af;">IEdmCmdMgr5</span> poCmdMgr)<br>
|
||||
{<br>
|
||||
<span style="color:green;">//Return information about this add-in to the Administrate Add-ins dialog</span><br>
|
||||
poInfo.mbsAddInName = <span style="color:#a31515;">"My serial number generator"</span>;<br>
|
||||
poInfo.mbsCompany = <span style="color:#a31515;">"The name of my company"</span>;<br>
|
||||
poInfo.mbsDescription = <span style="color:#a31515;">"Implements serial numbers"</span>;<br>
|
||||
poInfo.mlAddInVersion = 1;<br>
|
||||
poInfo.mlRequiredVersionMajor = 5;<br>
|
||||
poInfo.mlRequiredVersionMinor = 2;<br>
|
||||
<br>
|
||||
<span style="color:green;">//Notify that a serial number needs to be generated</span><br>
|
||||
poCmdMgr.AddHook(<span style="color:#2b91af;">EdmCmdType</span>.EdmCmd_SerialNo);<br>
|
||||
}</p>
|
||||
</blockquote>
|
||||
|
||||
<li>
|
||||
<p class=MsoNormal style='background:white'>
|
||||
<span style="font-family: Verdana">Implement IEdmAddIn5::OnCmd as follows</span><span lang=EN-US style='font-family:Verdana'>:</span></p></li>
|
||||
|
||||
<blockquote>
|
||||
<p style="font-family: Courier New; font-size: 13; color: black; background: white" class="APICODE">
|
||||
<span style="color:blue;">public</span> <span style="color:blue;">void</span> OnCmd(<span style="color:blue;">ref</span> <span style="color:#2b91af;">EdmCmd</span> poCmd, <span style="color:blue;">ref</span> <span class="auto-style2">EdmCmdData</span>[] ppoData)<br>
|
||||
{<br>
|
||||
<span style="color:green;">//Check the upper and lower bounds of the array </span><br>
|
||||
<span style="color:blue;">int</span> Index = ppoData.GetLowerBound(0);<br>
|
||||
<span style="color:blue;">int</span> last = ppoData.GetUpperBound(0);<br>
|
||||
<br>
|
||||
<span style="color:blue;">if</span> (Index <= last) {<br>
|
||||
<span style="color:blue;">int</span> cnt; <br>
|
||||
cnt = last - Index + 1 ;<br>
|
||||
<br>
|
||||
<span style="color:green;">//Create a temporary array to which you have full access</span><br>
|
||||
<span style="color:#2b91af;">EdmCmdData</span>[] tmpArr; <br>
|
||||
tmpArr = (<span style="color:#2b91af;">EdmCmdData</span>[])ppoData; <br>
|
||||
<br>
|
||||
<span style="color:green;">//Generate serial numbers for all of the affected files </span><br>
|
||||
<span style="color:#2b91af;">String</span> CounterVal; <br>
|
||||
<br>
|
||||
<span style="color:blue;">while</span> (Index <= last) {<br>
|
||||
CounterVal = tmpArr[Index].mlLongData1.ToString() ;<br>
|
||||
<span style="color:#2b91af;">String</span> s;<br>
|
||||
s = <span style="color:#a31515;">"My serno("</span> + CounterVal + <span style="color:#a31515;">")"</span> ;<br>
|
||||
tmpArr[Index].mbsStrData1 = s ;<br>
|
||||
Index = Index + 1 ;<br>
|
||||
}<br>
|
||||
<br>
|
||||
<span style="color:green;">//Return the updated data </span><br>
|
||||
ppoData = tmpArr;<br>
|
||||
}<br>
|
||||
}</p>
|
||||
<p style='background:white'>
|
||||
<span lang=EN-US style="font-size:10pt;font-family:Courier New">
|
||||
<br>
|
||||
</span>
|
||||
<span lang=EN-US style='font-family:Verdana'>The second argument to
|
||||
OnCmd
|
||||
is an array of <a href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmCmdData.html">EdmCmdData</a> structures. There is
|
||||
one element in the array for each file that is affected by the call. </span><span lang=EN-US style='font-family:Verdana'>
|
||||
See EdmCmdData for a complete list
|
||||
of members and their descriptions.<o:p></o:p></span></p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<li>
|
||||
<p class=MsoNormal style='background:white'>
|
||||
<span lang=EN-US style='mso-ansi-language:EN-US'>Click <b>Build > Build
|
||||
Solution</b> to build the add-in.</span></p></li>
|
||||
<li>
|
||||
<span lang="en-us">I</span><span lang=EN-US style='mso-ansi-language:EN-US'>nstall
|
||||
the add-in through the SOLIDWORKS PDM Professional
|
||||
Administration tool: <br> </span><ol style="font-family: Verdana; font-size: 8pt">
|
||||
<li><span lang="en-us">Open</span><span lang=EN-US style='mso-ansi-language:EN-US'> the SOLIDWORKS
|
||||
PDM Professional Administration tool.<br> </span></li>
|
||||
<li><span lang=EN-US style='mso-ansi-language:EN-US'>Expand the vault where
|
||||
you want to install this add-in and log in as Admin.<br> </span></li>
|
||||
<li><span lang="en-us">Right-click <b>Add-ins</b> and click <b>New
|
||||
Add-in</b>.<b><br>
|
||||
</b></span></li>
|
||||
<li>B<span lang="en-us">rowse to </span>
|
||||
<span lang=EN-US style='mso-ansi-language:EN-US'>
|
||||
<i style='mso-bidi-font-style:
|
||||
normal'>project_path</i><span style='mso-bidi-font-style:
|
||||
normal; '><i>\</i></span></span><span style='mso-bidi-font-style:
|
||||
normal; mso-ansi-language:EN-US' lang="EN-US"><i>project_name\project_name</i><b>\bin\Debug</b>,
|
||||
click <i>project_name</i><b>.dll</b> and <b>EPDM.Interop.epdm.dll</b>.<br> </span></li>
|
||||
<li><span lang="en-us">Click <b>Open</b>.<br>
|
||||
</span></li>
|
||||
<li>Click <b>OK</b>.<br>
|
||||
</li>
|
||||
<li>Click <b>OK</b>.</li>
|
||||
</ol>
|
||||
</li>
|
||||
<li>
|
||||
<p class=MsoNormal style='background:white'><font face="Verdana">
|
||||
<span lang=EN-US>Right-click the <strong>Serial Numbers</strong> node in the
|
||||
tree and click </span></font><span style='font-family:Verdana' lang="EN-US">
|
||||
<strong>New Serial
|
||||
Number</strong></span><font face="Verdana"><span lang=EN-US>. </span></font>
|
||||
</p></li>
|
||||
<li>
|
||||
<p class=MsoNormal style='background:white'><font face="Verdana">
|
||||
<span lang=EN-US>Create a new serial number
|
||||
in the <b>Name</b> field and select </span></font>
|
||||
<span lang=EN-US style='font-family:Arial'><strong>
|
||||
<span style='font-family:Verdana'>Serial number from add-in</span></strong></span><font face="Verdana"><span lang=EN-US>
|
||||
in the Type dropdown.<br>
|
||||
<br>
|
||||
<img border="0" src="serno.gif" width="497" height="286"></span></font></p>
|
||||
<p class=MsoNormal style='background:white'><font face="Verdana">
|
||||
<span lang=EN-US>The name of your add-in is displayed in<b> Name of add-in</b>.</span></font></p>
|
||||
<li>
|
||||
<p class=MsoNormal style='background:white'><font face="Verdana">
|
||||
<span lang=EN-US>After ensuring that your add-in is selected, click
|
||||
</span></font><span lang=EN-US style='font-family:Arial'><strong>
|
||||
<span style='font-family:Verdana'>OK.</span></strong></span></p>
|
||||
<p class=MsoNormal style='background:white'><font face="Verdana">
|
||||
<span lang=EN-US>Now you can connect the add-in serial number to controls in
|
||||
your file data cards. </span></font></p>
|
||||
|
||||
<li>
|
||||
<p class=MsoNormal style='background:white'>
|
||||
<span style="background-position: 0 0"><font face="Verdana">Click <b>
|
||||
Cards > File Cards</b>, double-click <b>Text Card</b>,</font></span><font face="Verdana"><span lang=EN-US> and click the </span></font>
|
||||
<span lang=EN-US style='font-family:Arial'><strong>
|
||||
<span style='font-family:Verdana'>Title</span></strong></span><span lang=EN-US><font face="Verdana">
|
||||
control.</font><o:p></o:p></span></p></li>
|
||||
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p class=MsoNormal style='background:white'>
|
||||
<span style="background-position: 0 0"><font face="Verdana">I</font></span><span lang=EN-US><font face="Verdana">n
|
||||
the Default value group box on the Edit-box properties panel, </font></span><span style="background-position: 0 0">
|
||||
<font face="Verdana">click</font></span><span lang=EN-US><font face="Verdana"> <b>Serial number</b> and
|
||||
select the serial number that you created in step 7.</font><o:p></o:p></span></p></li>
|
||||
|
||||
<p class=MsoNormal style='background:white'>
|
||||
<span lang=EN-US style='font-size:
|
||||
10.0pt;font-family:Arial'>
|
||||
<o:p><img border="0" src="defvalserno.gif" width="969" height="797"></o:p></span></p>
|
||||
|
||||
<li>
|
||||
<p class=MsoNormal style='background:white'><font face="Verdana">
|
||||
<span lang=EN-US>Save the card and exit the Card Editor.</span></font></p></li>
|
||||
<li>
|
||||
<p class=MsoNormal style='background:white'>
|
||||
<span style="background-position: 0 0"><font face="Verdana">C</font></span><font face="Verdana"><span lang=EN-US>reate a new text file
|
||||
by right-clicking in a File Explorer vault view and
|
||||
clicking </span></font><span lang=EN-US><strong><font face="Verdana">New >
|
||||
Text File</font></strong><span lang=EN-US style='font-family:Arial'><font face="Verdana">.
|
||||
<br><br>The file data card displays a serial number in <b>Title</b> of the newly added
|
||||
file.</font><o:p></o:p></span></span></p></li>
|
||||
</ol>
|
||||
<blockquote>
|
||||
<p class=MsoNormal style='background:white'>
|
||||
<img border="0" src="txtpropserno.gif" width="643" height="286"></p>
|
||||
</blockquote>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
Reference in New Issue
Block a user