Hide Table of Contents
SOLIDWORKS Electrical API 2024.0.0
Electrical API
EwDocumentObjects.idl
Go to the documentation of this file.
1#pragma once
2
3#if (__midl >= 501)
4midl_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 "EwProjectObjects.idl";
12import "EwSymbolObjects.idl";
13import "EwTitleBlockObjects.idl";
14
15/************************************************************************/
16/* */
17/************************************************************************/
18
24[
25 object,
26 uuid(177B157B-38FE-470D-8A3A-1506B6919A24),
27 dual,
28 oleautomation,
29 nonextensible,
30 helpstring("IEwDocumentX Interface"),
31 pointer_default(unique)
32]
33interface IEwDocumentX : IDispatch
34{
46 IEwSymbolX getEwSymbolX (EwErrorCode* errorCode);
47
48
60 IEwTitleBlockX getEwTitleBlockX (EwErrorCode* errorCode);
61
62
75 IEwProjectX getEwProjectX (EwErrorCode* errorCode);
76
77
89 IEwProjectFileX getEwProjectFileX (EwErrorCode* errorCode);
90
91
100 VARIANT_BOOL doFileSave (EwErrorCode* errorCode);
101
102
110 EwErrorCode close ();
111
112};
113
118[
119 object,
120 uuid(F5EAF237-FBF6-4721-895B-DDF04D6DE73C),
121 dual,
122 oleautomation,
123 nonextensible,
124 helpstring("IEwDocumentManagerX Interface"),
125 pointer_default(unique)
126]
127interface IEwDocumentManagerX : IDispatch
128{
138 IEwDocumentX getEwDocumentCurrent (EwErrorCode* errorCode);
139
140
149 VARIANT getOpenEwDocumentArray (EwErrorCode* errorCode);
150
151
163 IEwDocumentX openEwDocumentFromFilePath (BSTR strFilePath, EwErrorCode* errorCode);
164
165};
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
IEwDocumentManagerX
Use this interface to manage the documents in the application.
Definition: EwDocumentObjects.idl:128
IEwDocumentManagerX::getEwDocumentCurrent
IEwDocumentX getEwDocumentCurrent(EwErrorCode *errorCode)
Get the IEwDocumentX from current document.
IEwDocumentManagerX::openEwDocumentFromFilePath
IEwDocumentX openEwDocumentFromFilePath(BSTR strFilePath, EwErrorCode *errorCode)
Open document file from the given path in application.
IEwDocumentManagerX::getOpenEwDocumentArray
VARIANT getOpenEwDocumentArray(EwErrorCode *errorCode)
Get the array of IEwDocumentX object for all open documents.
IEwDocumentX
Use this interface to manage an EwDocumentX object.
Definition: EwDocumentObjects.idl:34
IEwDocumentX::doFileSave
VARIANT_BOOL doFileSave(EwErrorCode *errorCode)
Saves the file to the local disk.
IEwDocumentX::getEwSymbolX
IEwSymbolX getEwSymbolX(EwErrorCode *errorCode)
Return an IEwSymbolX object from current document.
IEwDocumentX::getEwProjectFileX
IEwProjectFileX getEwProjectFileX(EwErrorCode *errorCode)
Return an IEwProjectFileX object from current document.
IEwDocumentX::getEwProjectX
IEwProjectX getEwProjectX(EwErrorCode *errorCode)
Return an IEwProjectX object from current document.
IEwDocumentX::getEwTitleBlockX
IEwTitleBlockX getEwTitleBlockX(EwErrorCode *errorCode)
Return an IEwTitleBlockX object from current document.
IEwDocumentX::close
EwErrorCode close()
Closes the open document.
IEwProjectFileX
Use this interface to manage file inside a project.
Definition: EwProjectObjects.idl:839
IEwProjectX
Use this interface to manage a project.
Definition: EwProjectObjects.idl:1665
IEwSymbolX
Use this interface to manage a symbol.
Definition: EwSymbolObjects.idl:573
IEwTitleBlockX
Use this interface to manage a definition of a title block.
Definition: EwTitleBlockObjects.idl:38
Generated on Mon Aug 28 2023 13:39:20 for SOLIDWORKS Electrical API by doxygen 1.9.4


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/EwDocumentObjects.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.

0.20.21