Hide Table of Contents
SOLIDWORKS Electrical API 2024.0.0
Electrical API
EwSymbolObjects.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
7import "oaidl.idl";
8import "ocidl.idl";
9
10import "EnumDefinition.idl";
11import "EwClassificationObjects.idl";
12
13/************************************************************************/
14/* In his file, all SYMBOL object */
15/************************************************************************/
16
17/************************************************************************/
18/* INTERFACES */
19/************************************************************************/
20
25[
26 object,
27 uuid(97D8E9CC-9C15-4DEF-AC7C-7BB7ED11164A),
28 dual,
29 oleautomation,
30 nonextensible,
31 helpstring("IEwSymbolPointX Interface"),
32 pointer_default(unique)
33]
34interface IEwSymbolPointX : IDispatch{
35
36
37
46
47
56
57
66
67
76
77
86
87
95 DOUBLE getXPos (EwErrorCode* errorCode);
96
97
105 EwErrorCode setXPos (DOUBLE dXValue);
106
107
115 DOUBLE getYPos (EwErrorCode* errorCode);
116
117
125 EwErrorCode setYPos (DOUBLE dYValue);
126
127
135 DOUBLE getAngle (EwErrorCode* errorCode);
136
137
145 EwErrorCode setAngle (DOUBLE dAngle);
146
147
157
158
167 EwErrorCode setTerminationTypeCode (BSTR strTerminationTypeCode);
168
169};
170
175[
176 object,
177 uuid(960C29C7-51FA-452E-865E-59F7C0669A7A),
178 dual,
179 oleautomation,
180 nonextensible,
181 helpstring("IEwSymbolCircuitX Interface"),
182 pointer_default(unique)
183]
184interface IEwSymbolCircuitX : IDispatch
185{
186
187
195 LONG getNumber (EwErrorCode* errorCode);
196
197
207
208
217
218
226 BSTR getType (EwErrorCode* errorCode);
227
228
237 EwErrorCode setType (BSTR strKeyCode);
238
239};
240
241
246[
247 object,
248 uuid(02C2A32C-B421-42C8-9A7B-48BCF979D50C),
249 dual,
250 oleautomation,
251 nonextensible,
252 helpstring("IEwSymbolFiltersX Interface"),
253 pointer_default(unique)
254]
255interface IEwSymbolFiltersX : IDispatch{
256
262
263
268 void setClassNodeID (LONG lNodeID);
269
270
276
277
282 void setEwSymbolType (EwSymbolType eSymbolTypes);
283
284
290
291
296 void setSymbolName (BSTR strName);
297
298
307 BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
308
309
318 EwErrorCode setDescription (BSTR lgCode, BSTR val);
319
320
326
327
332 void setEwMeasurementType (EwMeasurementType eMeasurementTypes);
333
334
340
341
346 void setLibraryCode (BSTR strLibraryCode);
347
348
354
355
360 void setManufacturer (BSTR strManufacturer);
361
362
368
369
374 void setReference (BSTR strReference);
375
376
382
383
388 void setModificationDateFrom (DATE modificationDateFrom);
389
390
396
397
402 void setModificationDateTo (DATE modificationDateTo);
403
404
410
411
416 void setCreationDateFrom (DATE creationDateFrom);
417
418
424
425
430 void setCreationDateTo (DATE creationDateTo);
431
432
438
439
444 void setEwSymbolCircuitCount (LONG lNbCircuit);
445
446
452
453
458 void setEwSymbolPointCount (LONG lConnectionPoint);
459
460
465 BSTR getRootMark ();
466
467
472 void setRootMark (BSTR strRootMark);
473
474
480
481
486 void setAssociatedMacro (BSTR strAssociatedMacro);
487
488
494
495
501
502
508
509
514 void setDisplayEwSymbolPoint (EwBooleanFiltersValue eBooleanFiltersValues);
515
516
522
523
529
530
540 EwErrorCode getEwSymbolArray (VARIANT* vArray);
541
542
548
549
554 void setTerminalStripDrawingSymbol (BSTR strTerminalStripDrawingSymbol);
555
556
557};
558
563[
564 object,
565 uuid(90C1D0BC-FDC7-4410-BB37-2A86CA6CA1EC),
566 dual,
567 oleautomation,
568 nonextensible,
569 helpstring("IEwSymbolX Interface"),
570 pointer_default(unique)
571]
573{
574
583 IEwSymbolCircuitX addEwSymbolCircuit (BSTR strCircuitCode, EwErrorCode* errorCode);
584
585
595
596
602
603
614
615
625 BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
626
627
637 EwErrorCode setDescription (BSTR lgCode, BSTR strValue);
638
639
647 LONG getID (EwErrorCode* errorCode);
648
649
657 BSTR getReference (EwErrorCode* errorCode);
658
659
667 EwErrorCode setReference (BSTR strReference);
668
669
677 BSTR getManufacturer (EwErrorCode* errorCode);
678
679
687 EwErrorCode setManufacturer (BSTR strManufacturer);
688
689
698 LONG getClassNodeID (EwErrorCode* errorCode);
699
700
710
711
720 BSTR getLibraryCode (EwErrorCode* errorCode);
721
722
730 EwErrorCode setLibraryCode (BSTR strLibraryCode);
731
732
740 BSTR getRootMark (EwErrorCode* errorCode);
741
742
750 EwErrorCode setRootMark (BSTR strRootMark);
751
752
760 BSTR getName (EwErrorCode* errorCode);
761
762
771 EwErrorCode setName (BSTR strSymbolName);
772
773
782
783
792
793
802
803
812
813
822
823
832
833
842
843
851 EwErrorCode setAssociatedMacro (BSTR strAssociatedMacro);
852
853
861 BSTR getStandard (EwErrorCode* errorCode);
862
863
871 EwErrorCode setStandard (BSTR strStandard);
872
873
881 VARIANT_BOOL isConnectionPointVisible (EwErrorCode* errorCode);
882
883
891 EwErrorCode showConnectionPoint (VARIANT_BOOL bVisible);
892
893
901 EwErrorCode getDoNotRotateAttributes (VARIANT_BOOL* bRotate);
902
903
911 EwErrorCode setDoNotRotateAttributes (VARIANT_BOOL bRotate);
912
913
927 EwErrorCode insertFromDwg (BSTR strDwgFilePath);
928
929
937 BOOL isAlreadyOpened (EwErrorCode* errorCode);
938
939
948
949
959
960
966
967
978
979
980
992
993
1005 LONG getClassID (EwErrorCode* errorCode);
1006
1007
1019
1020
1021
1022
1023
1024
1025
1026
1027
1040
1041};
1042
1047[
1048 object,
1049 uuid(D4CAA186-3BD6-462A-A3DC-E1DB39B7941E),
1050 dual,
1051 oleautomation,
1052 nonextensible,
1053 helpstring("IEwSymbolManagerX Interface"),
1054 pointer_default(unique)
1055]
1056interface IEwSymbolManagerX : IDispatch
1057{
1063
1064
1068 LONG getCount ();
1069
1070
1074 VARIANT getEwSymbolArray (EwErrorCode* errorCode);
1075
1076
1082
1083
1094 IEwSymbolX at (int iIndex, EwErrorCode* errorCode);
1095
1096
1110
1111
1124 IEwSymbolX findEwSymbolXByName (BSTR strName, EwErrorCode* errorCode);
1125
1126}
EwBooleanFiltersValue
All value for boolean filters.
Definition: EnumDefinition.idl:90
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
EwSymbolCrossRefType
All cross reference type of symbol.
Definition: EwEnumeration.idl:462
EwCircuitPassingType
All passing types of symbol circuit.
Definition: EwEnumeration.idl:699
EwSymbolType
All types of symbol.
Definition: EwEnumeration.idl:433
EwPointOrientation
Flow direction of symbol connexion point type.
Definition: EwEnumeration.idl:687
EwMeasurementType
All measurement type.
Definition: EwEnumeration.idl:284
Use this interface to manage an IEwClassificationX object.
Definition: EwClassificationObjects.idl:228
This interface is a generic interface for environment object methods.
Definition: EwObjectBaseObjects.idl:307
Use this interface to manage a circuit inside a symbol.
Definition: EwSymbolObjects.idl:185
EwErrorCode setType(BSTR strKeyCode)
Set the type of the current circuit.
EwErrorCode setEwCircuitPassingType(EwCircuitPassingType ePassingType)
Set the EwCircuitPassingType enum type of the current circuit.
EwCircuitPassingType getEwCircuitPassingType(EwErrorCode *errorCode)
Get the EwCircuitPassingType enum type of the current circuit.
LONG getNumber(EwErrorCode *errorCode)
Get the number of the current circuit.
BSTR getType(EwErrorCode *errorCode)
Get the type of the current circuit.
Use this interface to manage filter for EwSymbolX.
Definition: EwSymbolObjects.idl:255
DATE getModificationDateTo()
Get the "modification date to" of the filter.
void setEwMeasurementType(EwMeasurementType eMeasurementTypes)
Set/reset the measurement of the filter.
BSTR getSymbolName()
Get the symbol name of the filter.
void setDisplayEwSymbolPoint(EwBooleanFiltersValue eBooleanFiltersValues)
Set the display connection point value of the filter.
void setEwSymbolCrossRefType(EwSymbolCrossRefType eSymbolCrossRefTypes)
Set/reset the type of cross reference of the filter.
void setManufacturer(BSTR strManufacturer)
Set/reset the manufacturer of the filter.
BSTR getReference()
Get the reference of the filter.
void setRootMark(BSTR strRootMark)
Set/reset the root mark of the filter.
void setCreationDateTo(DATE creationDateTo)
Set/reset the "creation date to" of the filter.
void setEwSymbolCircuitCount(LONG lNbCircuit)
Set/reset the number of circuit of the filter.
void setReference(BSTR strReference)
Set/reset the reference of the filter.
EwSymbolCrossRefType getEwSymbolCrossRefType()
Get the type of cross reference of the filter.
BSTR getLibraryCode()
Get the library code of the filter.
void setDoNotRotateAttributes(EwBooleanFiltersValue eBooleanFiltersValue)
Set the value of "do not rotate attributes" of the filter.
BSTR getAssociatedMacro()
Get the associated macro of the filter.
BSTR getManufacturer()
Get the manufacturer of the filter.
EwBooleanFiltersValue getDoNotRotateAttributes()
Get the value of "do not rotate attributes" of the filter.
DATE getCreationDateTo()
Get the "creation date to" of the filter.
LONG getEwSymbolCircuitCount()
Get the number of circuit of the filter.
void setCreationDateFrom(DATE creationDateFrom)
Set/reset the "creation date from" of the filter.
LONG getEwSymbolPointCount()
Get the number of connection point of the filter.
EwMeasurementType getEwMeasurementType()
Get the measurement of the filter.
EwErrorCode getEwSymbolArray(VARIANT *vArray)
Return Array of Symbol according to filter.
BSTR getTerminalStripDrawingSymbol()
Get the TerminalStrip drawing symbol of the filter.
void setAssociatedMacro(BSTR strAssociatedMacro)
Set/reset the associated macro of the filter.
EwBooleanFiltersValue getDisplayEwSymbolPoint()
Get the display connection point value of the filter.
void setEwSymbolType(EwSymbolType eSymbolTypes)
Set/reset the symbol type of the filter.
void setModificationDateFrom(DATE modificationDateFrom)
Set/reset the modification date from of the filter.
EwSymbolType getEwSymbolType()
Get the symbol type of the filter.
EwErrorCode setDescription(BSTR lgCode, BSTR val)
Set/reset the description of the filter.
DATE getModificationDateFrom()
Get the modification date from of the filter.
void setClassNodeID(LONG lNodeID)
Set/reset the class ID of the filter.
BSTR getRootMark()
Get the root mark of the filter.
void setTerminalStripDrawingSymbol(BSTR strTerminalStripDrawingSymbol)
Set/reset the TerminalStrip drawing symbol of the filter.
LONG getClassNodeID()
Get the class ID of the filter.
void setModificationDateTo(DATE modificationDateTo)
Set/reset the "modification date to" of the filter.
void setSymbolName(BSTR strName)
Set/reset the symbol name of the filter.
BSTR getDescription(BSTR lgCode, EwErrorCode *errorCode)
Get the description of the filter.
DATE getCreationDateFrom()
Get the "creation date from" of the filter.
void setLibraryCode(BSTR strLibraryCode)
Set/reset the library code of the filter.
void setEwSymbolPointCount(LONG lConnectionPoint)
Set/reset the number of connection point of the filter.
Use this interface to manage EwSymbolX objects.
Definition: EwSymbolObjects.idl:1057
IEwSymbolFiltersX newEwSymbolFilters()
Create a IEwSymbolFiltesrX object to get symbols af associated environment.
IEwSymbolX at(int iIndex, EwErrorCode *errorCode)
Return an IEwSymbolX at a given position from the associated environment.
IEwSymbolX findEwSymbolXById(long lId, EwErrorCode *errorCode)
Find an IEwSymbolX by ID.
VARIANT getEwSymbolArray(EwErrorCode *errorCode)
return the array of IEwSymbolX of associated environment
IEwSymbolX newEwSymbol()
Create a IEwSymbolX object from the associated environnement.
IEwSymbolX findEwSymbolXByName(BSTR strName, EwErrorCode *errorCode)
Find an IEwSymbolX by his Name.
Use this interface to manage a connection point.
Definition: EwSymbolObjects.idl:34
EwErrorCode setEwPointOrientation(EwPointOrientation ePointOrientation)
Set the flow direction of the connection point.
EwErrorCode setTerminationTypeCode(BSTR strTerminationTypeCode)
Set the termination type code of the connection point.
EwErrorCode getNumber(LONG *lNo)
Get the number of the connection point.
BSTR getTerminationTypeCode(EwErrorCode *errorCode)
Get the termination type code of the connection point.
DOUBLE getAngle(EwErrorCode *errorCode)
Get the angle of the connection point.
EwErrorCode setYPos(DOUBLE dYValue)
Set the Y coordinate of the connection point.
EwErrorCode setEwSymbolCircuitNumber(LONG lCircuitNo)
Set the circuit number of the connection point.
LONG getEwSymbolCircuitNumber(EwErrorCode *errorCode)
Get the circuit number of the connection point.
EwErrorCode setAngle(DOUBLE dAngle)
Set the angle of the connection point.
DOUBLE getYPos(EwErrorCode *errorCode)
Get the Y coordinate of the connection point.
EwPointOrientation getEwPointOrientation(EwErrorCode *errorCode)
Get the flow direction of the connection point.
DOUBLE getXPos(EwErrorCode *errorCode)
Get the X coordinate of the connection point.
EwErrorCode setXPos(DOUBLE dXValue)
Set the X coordinate of the connection point.
Use this interface to manage a symbol.
Definition: EwSymbolObjects.idl:573
EwErrorCode setEwMeasurementType(EwMeasurementType eMeasurementType)
Set the measurement type of the symbol.
EwErrorCode setDoNotRotateAttributes(VARIANT_BOOL bRotate)
Set value of option "Do not rotate attributes".
EwErrorCode setClassNodeID(LONG lNodeId)
LONG getEwSymbolCircuitCount()
Count the number of circuit in this symbol.
EwErrorCode setLibraryCode(BSTR strLibraryCode)
Set the library code of the symbol.
EwSymbolCrossRefType getEwSymbolCrossRefType(EwErrorCode *errorCode)
Return the cross reference type of the symbol.
EwErrorCode setEwSymbolCrossRefType(EwSymbolCrossRefType eSymbolCrossRefType)
Set the cross reference type of the symbol.
BSTR getAssociatedMacro(EwErrorCode *errorCode)
Return the associated macro of the symbol.
EwErrorCode setDescription(BSTR lgCode, BSTR strValue)
Set a description of the symbol.
BSTR getName(EwErrorCode *errorCode)
Get the name of the symbol.
IEwClassificationX getClassification(EwErrorCode *errorCode)
Get the classification of the current symbol.
IEwSymbolCircuitX getEwSymbolCircuitAt(LONG index, EwErrorCode *errorCode)
Get a circuit inside the symbol.
EwErrorCode setRootMark(BSTR strRootMark)
Set the root mark of the symbol.
EwMeasurementType getEwMeasurementType(EwErrorCode *errorCode)
Return the measurement type of the symbol.
EwErrorCode showConnectionPoint(VARIANT_BOOL bVisible)
Show connection point.
EwErrorCode setEwSymbolType(EwSymbolType eSymbolType)
Set the type of the symbol.
BSTR getReference(EwErrorCode *errorCode)
Get the reference of the symbol.
EwErrorCode setClassID(LONG lID)
Set the class ID of this current symbol.
VARIANT_BOOL isConnectionPointVisible(EwErrorCode *errorCode)
Check if connection point are displayed.
EwErrorCode setStandard(BSTR strStandard)
Set the standard of the symbol.
EwErrorCode deleteEwSymbolPoint(LONG index)
Delete a connection point from the symbol.
IEwSymbolCircuitX addEwSymbolCircuit(BSTR strCircuitCode, EwErrorCode *errorCode)
Create and add a circuit in the symbol.
LONG getID(EwErrorCode *errorCode)
Get ID of the symbol.
BSTR getLibraryCode(EwErrorCode *errorCode)
BOOL isAlreadyOpened(EwErrorCode *errorCode)
Check if the drawing is already opened.
EwErrorCode deleteEwSymbolCircuitAt(LONG index)
Delete a circuit from the symbol.
IEwSymbolX duplicate(EwErrorCode *errorCode)
Duplicate current symbol.
EwErrorCode setName(BSTR strSymbolName)
Set the name of the symbol.
BSTR getStandard(EwErrorCode *errorCode)
Get the standard of the symbol.
EwSymbolType getEwSymbolType(EwErrorCode *errorCode)
Get the type of the symbol.
EwErrorCode insertFromDwg(BSTR strDwgFilePath)
Insert the object inside the current environment.
LONG getClassID(EwErrorCode *errorCode)
Get the class ID of current symbol.
EwErrorCode setReference(BSTR strReference)
Set the reference of the symbol.
LONG getClassNodeID(EwErrorCode *errorCode)
LONG getEwSymbolPointCount()
Count the number of connection point in the symbol.
EwErrorCode setAssociatedMacro(BSTR strAssociatedMacro)
Set the associated macro of the symbol.
BSTR getDescription(BSTR lgCode, EwErrorCode *errorCode)
Get a description of the symbol.
EwErrorCode getDoNotRotateAttributes(VARIANT_BOOL *bRotate)
Get value of option "Do not rotate attributes".
IEwSymbolPointX addEwSymbolPoint(EwErrorCode *errorCode)
Create and add a connection point for the symbol.
BSTR getManufacturer(EwErrorCode *errorCode)
Get the manufacturer of the symbol.
BSTR getRootMark(EwErrorCode *errorCode)
Get the root mark of the symbol.
IEwSymbolPointX getEwSymbolPointAt(LONG index, EwErrorCode *errorCode)
Get a connection point inside the symbol.
EwErrorCode setManufacturer(BSTR strManufacturer)
Set the manufacturer of the symbol.


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/EwSymbolObjects.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) 2024 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.