Hide Table of Contents
SOLIDWORKS Electrical API  2021.0.0
Electrical API
EwProjectComponentObjects.idl
Go to the documentation of this file.
1 #pragma once
2 
3 #if (__midl >= 501)
4  midl_pragma warning(disable:2111) /* Disable warning MIDL2111 regarding identifier lengths exceeding 31 chars. */
5 #endif
6 
7 import "oaidl.idl";
8 import "ocidl.idl";
9 
10 import "EnumDefinition.idl";
11 
12 import "EwObjectBase.idl";
13 
18 [
19  object,
20  uuid(2097bc6a-03c3-11e5-8418-1697f925ec7b),
21  dual,
22  oleautomation,
23  nonextensible,
24  helpstring("IEwProjectComponentTerminalX Interface"),
25  pointer_default(unique)
26 ]
27 interface IEwProjectComponentTerminalX : IDispatch
28 {
29 
30 
31 };
32 
37 [
38  object,
39  uuid(e8994c3e-03c2-11e5-8418-1697f925ec7b),
40  dual,
41  oleautomation,
42  nonextensible,
43  helpstring("IEwProjectComponentCircuitX Interface"),
44  pointer_default(unique)
45 ]
47 {
48 
57 
58 
68 
69 
75 
76 
87 
88 
98  BSTR getKeyCode (EwErrorCode* errorCode);
99 
100 
117  EwErrorCode setKeyCode (BSTR strKey);
118 
119 
129  EwErrorCode setChannelAddress (BSTR strChannelAddress);
130 
131 
140  BSTR getChannelAddress (EwErrorCode* errorCode);
141 
142 
152  EwErrorCode setChannelGroup (BSTR strChannelGroup);
153 
154 
163  BSTR getChannelGroup (EwErrorCode* errorCode);
164 
165 
175  VARIANT_BOOL hasBreakPage (EwErrorCode* errorCode);
176 
177 
186  EwErrorCode setBreakPage (VARIANT_BOOL bBreakPage);
187 
188 
189 
190 
199  VARIANT_BOOL isAutomaticAddress (EwErrorCode* errorCode);
200 
201 
210  EwErrorCode setAutomaticAddress (VARIANT_BOOL bIsAutomaticAddress);
211 
212 
213 
222  EwErrorCode setHidden (VARIANT_BOOL bIsHidden);
223 
224 
233 
234 
235 
244 
245 
246 
254  long getSymbolID (EwErrorCode* errorCode);
255 
256 
257 
265  long getCircuitSymbolID (EwErrorCode* errorCode);
266 
267 
268 
276  long getComponentID (EwErrorCode* errorCode);
277 
278 
279 
280 
281 };
282 
287 [
288  object,
289  uuid(a6c4df3a-03c2-11e5-8418-1697f925ec7b),
290  dual,
291  oleautomation,
292  nonextensible,
293  helpstring("IEwProjectComponentX Interface"),
294  pointer_default(unique)
295 ]
297 {
298 
306  BSTR getTagPath (EwErrorCode* errorCode);
307 
308 
317  VARIANT_BOOL getToDraw (EwErrorCode* errorCode);
318 
319 
328  EwErrorCode setToDraw (VARIANT_BOOL bToDraw);
329 
330 
339 
340 
351 
352 
353 
354 
355 
356 
357 
358 
359 
360 
361 
362 
363 
364 
365 
366 
367 
368 
369 
370 
371 
372 
373 
374 
375 
376 
377 
378 
379 
380 
381 
382 };
383 
388 [
389  object,
390  uuid(b16df1f6-260e-11e5-b345-feff819cdc9f),
391  dual,
392  oleautomation,
393  nonextensible,
394  helpstring("IEwProjectComponentManagerX Interface"),
395  pointer_default(unique)
396 ]
397 interface IEwProjectComponentManagerX : IDispatch
398 {
402  LONG getCount ();
403 
404 
410 
411 
420 
421 
433 
434 
446 
447 
457 
458 
465 
466 
467 };
EwErrorCode setType(EwComponentType eComponentType)
Set the EwComponentType enum type of the component.
Generic interface for an object that belongs to a project.
Definition: EwObjectBase.idl:76
VARIANT_BOOL hasBreakPage(EwErrorCode *errorCode)
Return if this circuit component has a break page.
EwErrorCode setAutomaticAddress(VARIANT_BOOL bIsAutomaticAddress)
Sets to fill in automatic the channel address.
long getSymbolID(EwErrorCode *errorCode)
Return the Symbol ID associated with the circuit component.
VARIANT_BOOL getToDraw(EwErrorCode *errorCode)
Return true if it is drawable.
long getCircuitSymbolID(EwErrorCode *errorCode)
Return the Circuit Symbol ID associated with the circuit component.
Use this interface to manage ComponentTerminal inside a project.
Definition: EwProjectComponentObjects.idl:28
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
BSTR getTagPath(EwErrorCode *errorCode)
Get the Mark path of the component, example: -N1-R1-M1.
EwErrorCode setKeyCode(BSTR strKey)
Sets the Key for the cross reference.
EwErrorCode setChannelGroup(BSTR strChannelGroup)
Sets the new Channel Group.
EwComponentType
All types of component type.
Definition: EwEnumeration.idl:919
IEwProjectComponentX findEwProjectComponentByID(LONG lID, EwErrorCode *errorCode)
Find a Component object in the project with the target ID.
This interface is a generic interface for standard methods.
Definition: EwObjectBase.idl:26
LONG getEwProjectComponentTerminalCount()
Count the number of terminals.
EwComponentType getType(EwErrorCode *errorCode)
Return the EwComponentType enum type of the component.
BSTR getChannelGroup(EwErrorCode *errorCode)
Return the Channel Group.
long getComponentID(EwErrorCode *errorCode)
Return the Component ID associated with the circuit component.
BSTR getChannelAddress(EwErrorCode *errorCode)
Return the Channel Address.
Use this interface to manage a component inside a project.
Definition: EwProjectComponentObjects.idl:297
Use this interface to manage the components inside a project.
Definition: EwProjectComponentObjects.idl:398
IEwProjectComponentTerminalX addEwProjectComponentTerminal(EwErrorCode *errorCode)
Create and add a terminal.
EwErrorCode setToDraw(VARIANT_BOOL bToDraw)
Set this value to true to draw the terminal strip drawing of this component.
EwErrorCode setHidden(VARIANT_BOOL bIsHidden)
Sets to Hide this circuit component.
VARIANT getEwProjectComponentArray(EwErrorCode *errorCode)
Get all the Component objects ID in the project.
EwErrorCode setChannelAddress(BSTR strChannelAddress)
Sets the new Channel Address.
VARIANT_BOOL isAutomaticAddress(EwErrorCode *errorCode)
Return if the channel address is fill in automatic.
VARIANT getEwProjectComponentCircuitArray(EwErrorCode *errorCode)
Get the array of IEwProjectComponentCircuitX ID of the current project.
IEwProjectComponentTerminalX getEwProjectComponentTerminalAt(LONG index, EwErrorCode *errorCode)
Get a terminal.
Use this interface to manage component element inside a project.
Definition: EwProjectComponentObjects.idl:47
long getCircuitManufacturerPartID(EwErrorCode *errorCode)
Return the Circuit ManufacturerPart ID associated with the circuit component.
EwErrorCode setBreakPage(VARIANT_BOOL bBreakPage)
Add/Remove break page.
IEwProjectComponentCircuitX findEwProjectComponentCircuitByID(LONG lID, EwErrorCode *errorCode)
return an EwProjectComponentCircuitX according to an Id
EwErrorCode deleteEwProjectComponentTerminalAt(LONG index)
Delete a terminal.
IEwProjectComponentCircuitX newEwProjectComponentCircuitX()
Create an interface for a new Component Circuit object in the current project.
long getManufacturerPartID(EwErrorCode *errorCode)
Return the ManufacturerPart ID associated with the circuit component.
IEwProjectComponentX newEwProjectComponent()
Create an interface for a new Component object in the current project.
BSTR getKeyCode(EwErrorCode *errorCode)
Return the Key for the cross reference.


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   SOLIDWORKS Electrical API: idl_converted/EwProjectComponentObjects.idl Source File
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2021 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.