Hide Table of Contents
SOLIDWORKS Electrical API  2022.0.0
Electrical API
EwApplicationDockingPane.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 import "EnumDefinition.idl";
10 
15 [
16  object,
17  uuid(50e4bf1d-d238-4bbf-954f-e885f6f23b89),
18  dual,
19  nonextensible,
20  pointer_default(unique)
21 ]
22 interface IEwDockingPaneX : IDispatch
23 {
32  LONG getID (EwErrorCode* errorCode);
33 
34 
43  BSTR getTitle (EwErrorCode* errorCode);
44 
45 
54  EwErrorCode setTitle (BSTR strTitle);
55 
56 
65  BSTR getTabCaption (EwErrorCode* errorCode);
66 
67 
68 
77  BSTR getTitleToolTip (EwErrorCode* errorCode);
78 
79 
88  EwErrorCode setTitleToolTip (BSTR strTitleToolTip);
89 
90 
98  EwErrorCode close ();
99 
100 
108  EwErrorCode hide ();
109 
110 
119  VARIANT_BOOL isValid (EwErrorCode* errorCode);
120 
121 
130  VARIANT_BOOL isClosed (EwErrorCode* errorCode);
131 
132 
133 
142  VARIANT_BOOL isSelected (EwErrorCode* errorCode);
143 
144 
153  VARIANT_BOOL isTabsVisible (EwErrorCode* errorCode);
154 
155 
166  EwErrorCode attach (ULONGLONG hWnd);
167 
168 
176  EwErrorCode select ();
177 
178 
187  VARIANT_BOOL getEnabled (EwErrorCode* errorCode);
188 
189 
198  EwErrorCode setEnabled (VARIANT_BOOL bEnable);
199 
200 
208  EwErrorCode setFocus ();
209 
210 
219  EwErrorCode show (VARIANT_BOOL bSetFocus);
220 
221 
229  EwErrorCode remove ();
230 
231 
242  EwErrorCode setIconFromImage (BSTR strImageFilePath, COLORREF crMask);
243 
244 
254  EwErrorCode dockPane (EwDockingPaneDirection eDockingPaneDirection, LONG nID);
255 
256 
265  EwDockingPaneDirection getDirection (EwErrorCode* errorCode);
266 
267 
277  EwErrorCode attachPane (LONG nID);
278 
279 
290  EwErrorCode attachSelectedPane (EwDockingPaneStandard eDockingPaneStandard);
291 
292 
293 
294 };
295 
300 [
301  object,
302  uuid(60e38a1a-11ce-4515-98ec-f8e53ba3c787),
303  dual,
304  nonextensible,
305  pointer_default(unique)
306 ]
307 interface IEwDockingPaneManagerX : IDispatch
308 {
319  IEwDockingPaneX addPane (BSTR strCaption, EwDockingPaneDirection eDockingPaneDirection, EwErrorCode* errorCode);
320 
321 
332  IEwDockingPaneX getPaneByID (LONG nID, EwErrorCode* errorCode);
333 
334 
344  EwErrorCode removePaneByID (LONG nID);
345 
346 
355  VARIANT getPaneArray (EwErrorCode* errorCode);
356 
357 
367  BSTR getGUID (EwErrorCode* errorCode);
368 
369 
378  EwErrorCode setGUID (BSTR strGUID);
379 
380 
391  EwErrorCode saveDefaultPaneDetails (LONG nID);
392 
393 };
IEwDockingPaneX::hide
EwErrorCode hide()
Hide the pane.
IEwDockingPaneX::getTitleToolTip
BSTR getTitleToolTip(EwErrorCode *errorCode)
Get the caption Tooltip of the pane.
IEwDockingPaneX::attachPane
EwErrorCode attachPane(LONG nID)
Attach to another pane.
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
IEwDockingPaneX::getTitle
BSTR getTitle(EwErrorCode *errorCode)
Get the title of the pane.
IEwDockingPaneX::isClosed
VARIANT_BOOL isClosed(EwErrorCode *errorCode)
Check if the pane is closed.
IEwDockingPaneManagerX::getPaneArray
VARIANT getPaneArray(EwErrorCode *errorCode)
Return the list of ID of the panes.
IEwDockingPaneX::isTabsVisible
VARIANT_BOOL isTabsVisible(EwErrorCode *errorCode)
Check if the tab bar is visible.
IEwDockingPaneX::setEnabled
EwErrorCode setEnabled(VARIANT_BOOL bEnable)
Disable/enable the pane.
IEwDockingPaneManagerX::setGUID
EwErrorCode setGUID(BSTR strGUID)
Fill the GUID of the current Addin.
IEwDockingPaneX::getID
LONG getID(EwErrorCode *errorCode)
Get ID of the docking pane.
IEwDockingPaneX::getEnabled
VARIANT_BOOL getEnabled(EwErrorCode *errorCode)
Check if the tab bar is enabled.
IEwDockingPaneManagerX
Use this interface to manage all the docking Pane in the application.
Definition: EwApplicationDockingPane.idl:308
IEwDockingPaneX::isSelected
VARIANT_BOOL isSelected(EwErrorCode *errorCode)
Check if the pane is selected.
IEwDockingPaneX::setFocus
EwErrorCode setFocus()
Set the focus of the pane.
EwDockingPaneStandard
EwDockingPaneStandard
Standard Docking Pane.
Definition: EnumDefinition.idl:313
IEwDockingPaneManagerX::getPaneByID
IEwDockingPaneX getPaneByID(LONG nID, EwErrorCode *errorCode)
Return an IEwDockingPaneX that encapsulate the pane find by its identifier.
IEwDockingPaneManagerX::saveDefaultPaneDetails
EwErrorCode saveDefaultPaneDetails(LONG nID)
Save details of a Pane specified by the ID.
IEwDockingPaneX::getDirection
EwDockingPaneDirection getDirection(EwErrorCode *errorCode)
Determine the EwDockingPaneDirection enumeration of pPane.
IEwDockingPaneManagerX::addPane
IEwDockingPaneX addPane(BSTR strCaption, EwDockingPaneDirection eDockingPaneDirection, EwErrorCode *errorCode)
Return an IEwDockingPaneX added to the Docking Pane Manager.
IEwDockingPaneX::close
EwErrorCode close()
Close the pane.
IEwDockingPaneManagerX::removePaneByID
EwErrorCode removePaneByID(LONG nID)
Remove a Pane specified by the ID.
IEwDockingPaneX::attach
EwErrorCode attach(ULONGLONG hWnd)
Associate the pane with a user window.
EwDockingPaneDirection
EwDockingPaneDirection
Docking Pane direction enumeration.
Definition: EnumDefinition.idl:299
IEwDockingPaneManagerX::getGUID
BSTR getGUID(EwErrorCode *errorCode)
Return the GUID of the current Addin.
IEwDockingPaneX::select
EwErrorCode select()
Select the pane.
IEwDockingPaneX::isValid
VARIANT_BOOL isValid(EwErrorCode *errorCode)
Check if the pane is associated with a user window.
IEwDockingPaneX::setTitleToolTip
EwErrorCode setTitleToolTip(BSTR strTitleToolTip)
Set the caption Tooltip of the pane.
IEwDockingPaneX::setIconFromImage
EwErrorCode setIconFromImage(BSTR strImageFilePath, COLORREF crMask)
Add an icon from file.
IEwDockingPaneX::attachSelectedPane
EwErrorCode attachSelectedPane(EwDockingPaneStandard eDockingPaneStandard)
Attach to another specified pane.
IEwDockingPaneX::getTabCaption
BSTR getTabCaption(EwErrorCode *errorCode)
Get the tab caption of the pane.
IEwDockingPaneX::setTitle
EwErrorCode setTitle(BSTR strTitle)
Set a title for this object.
IEwDockingPaneX::dockPane
EwErrorCode dockPane(EwDockingPaneDirection eDockingPaneDirection, LONG nID)
Dock an existing pane.
IEwDockingPaneX
Use this interface to manage a docking Pane.
Definition: EwApplicationDockingPane.idl:23
IEwDockingPaneX::show
EwErrorCode show(VARIANT_BOOL bSetFocus)
Show (activate) the pane.
Generated on Wed Aug 18 2021 10:34:10 for SOLIDWORKS Electrical API by   doxygen 1.8.18


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/EwApplicationDockingPane.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) 2022 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