Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Add a Custom CommandAdd a Custom Command
Expand Add an Add-inAdd an Add-in
Expand Release NotesRelease Notes
Expand SampleSample
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
Collapse IDispatchIDispatch
IEwAPIX
IEwAddIn
IEwAddinInternalX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCaptionBarControlX
IEwCaptionBarX
IEwClassificationManagerX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwDockingPaneManagerX
IEwDockingPaneX
IEwDocumentManagerX
IEwDocumentX
IEwEnvironmentX
IEwLibraryManagerX
IEwLockStringX
IEwManagerDialogX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwMenuItemX
IEwMenuManagerX
IEwMenuX
IEwNotificationDialogX
Expand IEwObjectDispatchXIEwObjectDispatchX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileConfigurationManagerX
IEwProjectFileConfigurationX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectMultilingualTextFontX
IEwProjectMultilingualTextManagerX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectWireStyleManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonComboBoxControlX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonQuickAccessControlX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSaveDWGImageX
IEwSelectorDialogX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwTerminalTypeManagerX
IEwTitleBlockManagerX
IEwWireTerminationTypeManagerX
IEwXLSBookX
IEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand PDM Pro API Web ServicePDM Pro API Web Service
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Inspection API HelpSOLIDWORKS Inspection API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Expand DraftSight API HelpDraftSight API Help
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
SOLIDWORKS Electrical API 2024.0.0
Electrical API
IEwDockingPaneManagerX Interface Reference

Use this interface to manage all the docking Pane in the application. More...

Inheritance diagram for IEwDockingPaneManagerX:
Inheritance graph

Public Member Functions

IEwDockingPaneX addPane (BSTR strCaption, EwDockingPaneDirection eDockingPaneDirection, EwErrorCode *errorCode)
 Return an IEwDockingPaneX added to the Docking Pane Manager. More...
 
IEwDockingPaneX getPaneByID (LONG nID, EwErrorCode *errorCode)
 Return an IEwDockingPaneX that encapsulate the pane find by its identifier. More...
 
EwErrorCode removePaneByID (LONG nID)
 Remove a Pane specified by the ID. More...
 
VARIANT getPaneArray (EwErrorCode *errorCode)
 Return the list of ID of the panes. More...
 
BSTR getGUID (EwErrorCode *errorCode)
 Return the GUID of the current Addin. More...
 
EwErrorCode setGUID (BSTR strGUID)
 Fill the GUID of the current Addin. More...
 
EwErrorCode saveDefaultPaneDetails (LONG nID)
 Save default details of a Pane specified by the ID. More...
 
IEwDockingPaneX getPaneByType (EwPaneType eEwPaneType, EwErrorCode *errorCode)
 Return an IEwDockingPaneX that encapsulate the pane per type. More...
 
void insertIconOverlay (EwPaneType eEwPaneType, long long nHandle, EwErrorCode *errorCode)
 Insert an icon overlay to a pane by type. More...
 
void redrawPaneByType (EwPaneType eEwPaneType, EwErrorCode *errorCode)
 Redraw the pane by type. More...
 

Detailed Description

Use this interface to manage all the docking Pane in the application.

Since
2021 SP0

Member Function Documentation

◆ addPane()

IEwDockingPaneX IEwDockingPaneManagerX::addPane ( BSTR  strCaption,
EwDockingPaneDirection  eDockingPaneDirection,
EwErrorCode errorCode 
)

Return an IEwDockingPaneX added to the Docking Pane Manager.

Parameters
[in]strCaptionthe title text to draw on the new Pane.
[in]eDockingPaneDirectionEwDockingPaneDirection enum type to specify the location of the pane.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
An IEwDockingPaneX added to the Ribbon Pane.

◆ getGUID()

BSTR IEwDockingPaneManagerX::getGUID ( EwErrorCode errorCode)

Return the GUID of the current Addin.

Since
2022 SP0 Should be empty.
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR: No error
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the GUID.

◆ getPaneArray()

VARIANT IEwDockingPaneManagerX::getPaneArray ( EwErrorCode errorCode)

Return the list of ID of the panes.

Parameters
[in]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an Array of ID of panes

◆ getPaneByID()

IEwDockingPaneX IEwDockingPaneManagerX::getPaneByID ( LONG  nID,
EwErrorCode errorCode 
)

Return an IEwDockingPaneX that encapsulate the pane find by its identifier.

Parameters
[in]nIDthe ID of the Pane to retrieve.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the nID is negative.
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonPaneX that encapsulate the pane find by its identifier.

◆ getPaneByType()

IEwDockingPaneX IEwDockingPaneManagerX::getPaneByType ( EwPaneType  eEwPaneType,
EwErrorCode errorCode 
)

Return an IEwDockingPaneX that encapsulate the pane per type.

Parameters
[in]eEwPaneTypePane type.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS The pane cannot be found.
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonPaneX that encapsulate the pane.

◆ insertIconOverlay()

void IEwDockingPaneManagerX::insertIconOverlay ( EwPaneType  eEwPaneType,
long long  nHandle,
EwErrorCode errorCode 
)

Insert an icon overlay to a pane by type.

Since
2023 SP0
Parameters
[in]eEwPaneTypePane type
[in]nHandleIcon handle. It must be an HICON.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OBJECT_NOT_FOUND pane not found
  • EW_NO_ERROR if no error detected

◆ redrawPaneByType()

void IEwDockingPaneManagerX::redrawPaneByType ( EwPaneType  eEwPaneType,
EwErrorCode errorCode 
)

Redraw the pane by type.

Since
2023 SP0
Parameters
[in]eEwPaneTypePane type
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OBJECT_NOT_FOUND pane not found
  • EW_NO_ERROR if no error detected

◆ removePaneByID()

EwErrorCode IEwDockingPaneManagerX::removePaneByID ( LONG  nID)

Remove a Pane specified by the ID.

Parameters
[in]nIDthe ID of the Pane to remove.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the ID is negative or not found.
  • EW_UNDEFINED_ERROR if another error occurred

◆ saveDefaultPaneDetails()

EwErrorCode IEwDockingPaneManagerX::saveDefaultPaneDetails ( LONG  nID)

Save default details of a Pane specified by the ID.

Pane details like Direction, IsFloating, PaneAttachID, etc.

Since
2022 SP0
Parameters
[in]nIDthe ID of the Pane to save details.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the ID is negative or not found.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setGUID()

EwErrorCode IEwDockingPaneManagerX::setGUID ( BSTR  strGUID)

Fill the GUID of the current Addin.

Since
2022 SP0
Parameters
[in]strGUIDGUID of the current Addin.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred


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: IEwDockingPaneManagerX Interface Reference
*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.