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 C# SamplesC# Samples
Expand List of SWE commandsList of SWE commands
Collapse ClassesClasses
Collapse Class ListClass List
Expand IEwAddInIEwAddIn
IEwAddinInternalX
Expand IEwAPIXIEwAPIX
Expand IEwApplicationSettingsXIEwApplicationSettingsX
Expand IEwApplicationXIEwApplicationX
Expand IEwArchiveEnvironmentXIEwArchiveEnvironmentX
Expand IEwCableCoreXIEwCableCoreX
Expand IEwCableReferenceManagerXIEwCableReferenceManagerX
Expand IEwCableReferenceXIEwCableReferenceX
Expand IEwCaptionBarControlXIEwCaptionBarControlX
Expand IEwCaptionBarXIEwCaptionBarX
Expand IEwClassificationManagerXIEwClassificationManagerX
Expand IEwClassificationXIEwClassificationX
Expand IEwClassXIEwClassX
IEwCommandContextX
Expand IEwCommandManagerXIEwCommandManagerX
Expand IEwCommandXIEwCommandX
Expand IEwDialogAlignPartsParametersSelectorXIEwDialogAlignPartsParametersSelectorX
Expand IEwDialogLocationSelectorXIEwDialogLocationSelectorX
Expand IEwDialogMacroSelectorXIEwDialogMacroSelectorX
Expand IEwDialogManufacturerPartOrderingXIEwDialogManufacturerPartOrderingX
Expand IEwDialogManufacturerPartSelectorXIEwDialogManufacturerPartSelectorX
Expand IEwDialogProgressXIEwDialogProgressX
Expand IEwDialogProjectManagerXIEwDialogProjectManagerX
Expand IEwDialogResumeXIEwDialogResumeX
Expand IEwDialogSummaryXIEwDialogSummaryX
Expand IEwDialogTaskXIEwDialogTaskX
Expand IEwDockingPaneManagerXIEwDockingPaneManagerX
Collapse IEwDockingPaneXIEwDockingPaneX
Expand IEwDocumentManagerXIEwDocumentManagerX
Expand IEwDocumentXIEwDocumentX
Expand IEwEnvironmentObjectXIEwEnvironmentObjectX
Expand IEwEnvironmentXIEwEnvironmentX
IEwInteropFactoryX
Expand IEwLibraryManagerXIEwLibraryManagerX
Expand IEwLibraryXIEwLibraryX
Expand IEwLockStringXIEwLockStringX
Expand IEwManagerDialogXIEwManagerDialogX
Expand IEwManufacturerPartCircuitXIEwManufacturerPartCircuitX
Expand IEwManufacturerPartManagerXIEwManufacturerPartManagerX
Expand IEwManufacturerPartTerminalXIEwManufacturerPartTerminalX
Expand IEwManufacturerPartXIEwManufacturerPartX
Expand IEwMenuItemXIEwMenuItemX
Expand IEwMenuManagerXIEwMenuManagerX
Expand IEwMenuXIEwMenuX
Expand IEwNotificationDialogXIEwNotificationDialogX
Expand IEwObjectBaseXIEwObjectBaseX
IEwObjectDispatchX
Expand IEwObjectXIEwObjectX
Expand IEwPointXIEwPointX
Expand IEwProjectAutomaticArrowsXIEwProjectAutomaticArrowsX
Expand IEwProjectBookManagerXIEwProjectBookManagerX
IEwProjectBookX
Expand IEwProjectCableManagerXIEwProjectCableManagerX
Expand IEwProjectCableXIEwProjectCableX
Expand IEwProjectComponentCircuitXIEwProjectComponentCircuitX
Expand IEwProjectComponentManagerXIEwProjectComponentManagerX
Expand IEwProjectComponentTerminalXIEwProjectComponentTerminalX
Expand IEwProjectComponentXIEwProjectComponentX
Expand IEwProjectConfigurationXIEwProjectConfigurationX
Expand IEwProjectEntity3DManagerXIEwProjectEntity3DManagerX
Expand IEwProjectEntity3DXIEwProjectEntity3DX
Expand IEwProjectExcelAutomationXIEwProjectExcelAutomationX
Expand IEwProjectExportDWGFilesXIEwProjectExportDWGFilesX
Expand IEwProjectExportPDFXIEwProjectExportPDFX
Expand IEwProjectExportPDMXIEwProjectExportPDMX
Expand IEwProjectExportReportXIEwProjectExportReportX
Expand IEwProjectFileConfigurationManagerXIEwProjectFileConfigurationManagerX
Expand IEwProjectFileConfigurationXIEwProjectFileConfigurationX
Expand IEwProjectFileManagerXIEwProjectFileManagerX
Expand IEwProjectFileXIEwProjectFileX
Expand IEwProjectFolderManagerXIEwProjectFolderManagerX
Expand IEwProjectFolderXIEwProjectFolderX
Expand IEwProjectFunctionManagerXIEwProjectFunctionManagerX
Expand IEwProjectFunctionXIEwProjectFunctionX
Expand IEwProjectGenerateTSDrawingXIEwProjectGenerateTSDrawingX
Expand IEwProjectHarnessManagerXIEwProjectHarnessManagerX
Expand IEwProjectHarnessXIEwProjectHarnessX
Expand IEwProjectInputOutputManagerXIEwProjectInputOutputManagerX
Expand IEwProjectInputOutputXIEwProjectInputOutputX
Expand IEwProjectLocationManagerXIEwProjectLocationManagerX
Expand IEwProjectLocationXIEwProjectLocationX
Expand IEwProjectManagerXIEwProjectManagerX
IEwProjectManufacturerPartCircuitX
Expand IEwProjectManufacturerPartManagerXIEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
Expand IEwProjectManufacturerPartXIEwProjectManufacturerPartX
Expand IEwProjectMultilingualTextFontXIEwProjectMultilingualTextFontX
Expand IEwProjectMultilingualTextManagerXIEwProjectMultilingualTextManagerX
Expand IEwProjectMultilingualTextXIEwProjectMultilingualTextX
Expand IEwProjectNumberDocumentsXIEwProjectNumberDocumentsX
Expand IEwProjectNumberMarksXIEwProjectNumberMarksX
Expand IEwProjectNumberWiresXIEwProjectNumberWiresX
Expand IEwProjectOptimizeWireOrderXIEwProjectOptimizeWireOrderX
Expand IEwProjectPrintConfigManagerXIEwProjectPrintConfigManagerX
Expand IEwProjectPrintConfigXIEwProjectPrintConfigX
Expand IEwProjectReportManagerXIEwProjectReportManagerX
Expand IEwProjectReportXIEwProjectReportX
Expand IEwProjectSnapshotManagerXIEwProjectSnapshotManagerX
Expand IEwProjectSnapshotXIEwProjectSnapshotX
Expand IEwProjectSymbolManagerXIEwProjectSymbolManagerX
Expand IEwProjectSymbolXIEwProjectSymbolX
Expand IEwProjectTagObjectXIEwProjectTagObjectX
Expand IEwProjectUpdateReplaceDataXIEwProjectUpdateReplaceDataX
Expand IEwProjectWireManagerXIEwProjectWireManagerX
Expand IEwProjectWireXIEwProjectWireX
Expand IEwProjectXIEwProjectX
Expand IEwResumeRowXIEwResumeRowX
Expand IEwRibbonComboBoxControlXIEwRibbonComboBoxControlX
Expand IEwRibbonControlXIEwRibbonControlX
Expand IEwRibbonGroupXIEwRibbonGroupX
Expand IEwRibbonQuickAccessControlXIEwRibbonQuickAccessControlX
Expand IEwRibbonTabXIEwRibbonTabX
Expand IEwRibbonXIEwRibbonX
Expand IEwRightsManagerXIEwRightsManagerX
Expand IEwSaveDWGImageXIEwSaveDWGImageX
Expand IEwSelectorDialogXIEwSelectorDialogX
Expand IEwSymbolCircuitXIEwSymbolCircuitX
Expand IEwSymbolFiltersXIEwSymbolFiltersX
Expand IEwSymbolManagerXIEwSymbolManagerX
Expand IEwSymbolPointXIEwSymbolPointX
Expand IEwSymbolXIEwSymbolX
Expand IEwTerminalTypeManagerXIEwTerminalTypeManagerX
Expand IEwTerminalTypeXIEwTerminalTypeX
Expand IEwTitleBlockManagerXIEwTitleBlockManagerX
Expand IEwTitleBlockXIEwTitleBlockX
Expand IEwWireTerminationTypeManagerXIEwWireTerminationTypeManagerX
Expand IEwWireTerminationTypeXIEwWireTerminationTypeX
Expand IEwXLSBookXIEwXLSBookX
Expand IEwXLSSheetXIEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Class Index
Expand Class HierarchyClass Hierarchy
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 2023.0.0
Electrical API
IEwDockingPaneX Interface Reference

Use this interface to manage a docking Pane. More...

Inheritance diagram for IEwDockingPaneX:

Public Member Functions

LONG getID (EwErrorCode *errorCode)
 Get ID of the docking pane. More...
 
BSTR getTitle (EwErrorCode *errorCode)
 Get the title of the pane. More...
 
EwErrorCode setTitle (BSTR strTitle)
 Set a title for this object. More...
 
BSTR getTabCaption (EwErrorCode *errorCode)
 Get the tab caption of the pane. More...
 
BSTR getTitleToolTip (EwErrorCode *errorCode)
 Get the caption Tooltip of the pane. More...
 
EwErrorCode setTitleToolTip (BSTR strTitleToolTip)
 Set the caption Tooltip of the pane. More...
 
EwErrorCode close ()
 Close the pane. More...
 
EwErrorCode hide ()
 Hide the pane. More...
 
VARIANT_BOOL isValid (EwErrorCode *errorCode)
 Check if the pane is associated with a user window. More...
 
VARIANT_BOOL isClosed (EwErrorCode *errorCode)
 Check if the pane is closed. More...
 
VARIANT_BOOL isSelected (EwErrorCode *errorCode)
 Check if the pane is selected. More...
 
VARIANT_BOOL isTabsVisible (EwErrorCode *errorCode)
 Check if the tab bar is visible. More...
 
EwErrorCode attach (ULONGLONG hWnd)
 Associate the pane with a user window. More...
 
EwErrorCode select ()
 Select the pane. More...
 
VARIANT_BOOL getEnabled (EwErrorCode *errorCode)
 Check if the tab bar is enabled. More...
 
EwErrorCode setEnabled (VARIANT_BOOL bEnable)
 Disable/enable the pane. More...
 
EwErrorCode setFocus ()
 Set the focus of the pane. More...
 
EwErrorCode show (VARIANT_BOOL bSetFocus)
 Show (activate) the pane. More...
 
EwErrorCode remove ()
 Remove the current pane. More...
 
EwErrorCode setIconFromImage (BSTR strImageFilePath, COLORREF crMask)
 Add an icon from file. More...
 
EwErrorCode dockPane (EwDockingPaneDirection eDockingPaneDirection, LONG nID)
 Dock an existing pane. More...
 
EwDockingPaneDirection getDirection (EwErrorCode *errorCode)
 Determine the EwDockingPaneDirection enumeration of pPane. More...
 
EwErrorCode attachPane (LONG nID)
 Attach to another pane. More...
 
EwErrorCode attachSelectedPane (EwDockingPaneStandard eDockingPaneStandard)
 Attach to another specified pane. More...
 

Detailed Description

Use this interface to manage a docking Pane.

Since
2021 SP0

Member Function Documentation

◆ attach()

EwErrorCode IEwDockingPaneX::attach ( ULONGLONG  hWnd)

Associate the pane with a user window.

The best place to create a user window and associate it with a pane is after the pane becomes visible. To catch this event use the DOCKINGPANE NOTIFY Handler.

Parameters
[in]hWndThe handler of the main window.
Returns
EwErrorCode 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

◆ attachPane()

EwErrorCode IEwDockingPaneX::attachPane ( LONG  nID)

Attach to another pane.

Parameters
[in]nIDthe ID of the pane to be attached.
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

◆ attachSelectedPane()

EwErrorCode IEwDockingPaneX::attachSelectedPane ( EwDockingPaneStandard  eDockingPaneStandard)

Attach to another specified pane.

Since
2021 SP1.
Parameters
[in]eDockingPaneStandardEwDockingPaneStandard enum that specify the Pane where the current DockingPane will be attached.
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 eDockingPaneStandard is not found
  • EW_UNDEFINED_ERROR if another error occurred

◆ close()

EwErrorCode IEwDockingPaneX::close ( )

Close the pane.

Returns
EwErrorCode 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

◆ dockPane()

EwErrorCode IEwDockingPaneX::dockPane ( EwDockingPaneDirection  eDockingPaneDirection,
LONG  nID 
)

Dock an existing pane.

Parameters
[in]eDockingPaneDirectionEwDockingPaneDirection enum type to specify the location docking.
[in]nIDthe ID of the Neighbour Pane. Optional, default value is 0.
Returns
EwErrorCode 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

◆ getDirection()

EwDockingPaneDirection IEwDockingPaneX::getDirection ( EwErrorCode errorCode)

Determine the EwDockingPaneDirection enumeration of pPane.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR: No error
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the EwDockingPaneDirection enumeration of pPane.

◆ getEnabled()

VARIANT_BOOL IEwDockingPaneX::getEnabled ( EwErrorCode errorCode)

Check if the tab bar is enabled.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR: No error
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
VARIANT_TRUE if pane is enabled.

◆ getID()

LONG IEwDockingPaneX::getID ( EwErrorCode errorCode)

Get ID of the docking pane.

Parameters
[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
will contain the ID of the docking pane.

◆ getTabCaption()

BSTR IEwDockingPaneX::getTabCaption ( EwErrorCode errorCode)

Get the tab caption of the pane.

Parameters
[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
will contain the tab caption of the pane.

◆ getTitle()

BSTR IEwDockingPaneX::getTitle ( EwErrorCode errorCode)

Get the title of the pane.

Parameters
[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
will contain the title of the pane.

◆ getTitleToolTip()

BSTR IEwDockingPaneX::getTitleToolTip ( EwErrorCode errorCode)

Get the caption Tooltip of the pane.

Parameters
[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
will contain the caption Tooltip of the pane.

◆ hide()

EwErrorCode IEwDockingPaneX::hide ( )

Hide the pane.

Returns
EwErrorCode 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

◆ isClosed()

VARIANT_BOOL IEwDockingPaneX::isClosed ( EwErrorCode errorCode)

Check if the pane is closed.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR: No error
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
VARIANT_TRUE if the pane is closed.

◆ isSelected()

VARIANT_BOOL IEwDockingPaneX::isSelected ( EwErrorCode errorCode)

Check if the pane is selected.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR: No error
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
VARIANT_TRUE if the pane is selected.

◆ isTabsVisible()

VARIANT_BOOL IEwDockingPaneX::isTabsVisible ( EwErrorCode errorCode)

Check if the tab bar is visible.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR: No error
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
VARIANT_TRUE if the tab bar is visible.

◆ isValid()

VARIANT_BOOL IEwDockingPaneX::isValid ( EwErrorCode errorCode)

Check if the pane is associated with a user window.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR: No error
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
VARIANT_TRUE if the pane is associated with a user window, false otherwise.

◆ remove()

EwErrorCode IEwDockingPaneX::remove ( )

Remove the current pane.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized or is not create by API
  • EW_UNDEFINED_ERROR if another error occurred

◆ select()

EwErrorCode IEwDockingPaneX::select ( )

Select the pane.

Returns
EwErrorCode 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

◆ setEnabled()

EwErrorCode IEwDockingPaneX::setEnabled ( VARIANT_BOOL  bEnable)

Disable/enable the pane.

Parameters
[in]bEnableTRUE to enable pane; FALSE to disable
Returns
EwErrorCode 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

◆ setFocus()

EwErrorCode IEwDockingPaneX::setFocus ( )

Set the focus of the pane.

Returns
EwErrorCode 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

◆ setIconFromImage()

EwErrorCode IEwDockingPaneX::setIconFromImage ( BSTR  strImageFilePath,
COLORREF  crMask 
)

Add an icon from file.

Image to Tab should be .ico, .bmp, .png file.

Parameters
[in]strImageFilePaththe full Image file path.
[in]crMaskColor mask for BMP and PNG images. Blanck (0x00FFFFFF) by default
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 file path doesn't exist or if not a .ico, .bmp, .png file.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setTitle()

EwErrorCode IEwDockingPaneX::setTitle ( BSTR  strTitle)

Set a title for this object.

Parameters
[in]strTitleTitle of the pane to be set.
Returns
EwErrorCode 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

◆ setTitleToolTip()

EwErrorCode IEwDockingPaneX::setTitleToolTip ( BSTR  strTitleToolTip)

Set the caption Tooltip of the pane.

Parameters
[in]strTitleToolTipCaption Tooltip of the pane to be set.
Returns
EwErrorCode 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

◆ show()

EwErrorCode IEwDockingPaneX::show ( VARIANT_BOOL  bSetFocus)

Show (activate) the pane.

Parameters
[in]bSetFocusTRUE to set focus
Returns
EwErrorCode 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


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: IEwDockingPaneX 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) 2023 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.