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
Expand 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
Public Member Functions | List of all members
IEwRibbonGroupX Interface Reference

Use this interface to manage the Ribbon group. More...

Inheritance diagram for IEwRibbonGroupX:
Inheritance graph
[legend]

Public Member Functions

BSTR getCaption (EwErrorCode *errorCode)
 Return the caption of this ribbon group. More...
 
EwErrorCode setCaption (BSTR strCaption)
 Set a new caption for this ribbon group. More...
 
IEwRibbonControlX addControl (EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
 Add a new control at the end of the ribbon group. More...
 
IEwRibbonControlX getControlAt (int iIndex, EwErrorCode *errorCode)
 Return the specified control of the current group. More...
 
int getControlCount (EwErrorCode *errorCode)
 Return the number of control in the current group. More...
 
EwErrorCode removeControl (int iIndex)
 Remove a control specified by the index. More...
 
EwErrorCode removeAll ()
 Remove all controls. More...
 
long getID (EwErrorCode *errorCode)
 Get the Id's of group. More...
 
IEwRibbonControlX insertControl (int nPosition, EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
 Insert a new control to a pop-up button in a ribbon. More...
 
IEwRibbonComboBoxControlX insertComboBoxControl (int nPosition, EwErrorCode *errorCode)
 Insert the ComboBox Control in the Ribbon Group. More...
 
IEwRibbonComboBoxControlX addComboBoxControl (EwErrorCode *errorCode)
 Add the ComboBox Control in the Ribbon Group. More...
 
int getIndex (EwErrorCode *errorCode)
 Return the index of the group. More...
 
VARIANT_BOOL getControlsGrouping (EwErrorCode *errorCode)
 Determines if control grouping is used. More...
 
EwErrorCode setControlsGrouping (VARIANT_BOOL bControlsGrouping)
 Group buttons in the group, false by default. More...
 
VARIANT_BOOL getControlsCentering (EwErrorCode *errorCode)
 Determine if controls are automatically center in group. More...
 
EwErrorCode setControlsCentering (VARIANT_BOOL bControlsCentering)
 Automatically center controls in group, false by default. More...
 
EwErrorCode setAllowReduce (EwRibbonGroupReductionLevels eRibbonGroupReductionLevels)
 Set this method to prevent group to be reduced. More...
 
EwRibbonGroupReductionLevels getAllowReduce (EwErrorCode *errorCode)
 Get the current reduce level for the ribbon group. More...
 

Detailed Description

Use this interface to manage the Ribbon group.

Since
2019

Member Function Documentation

◆ addComboBoxControl()

IEwRibbonComboBoxControlX IEwRibbonGroupX::addComboBoxControl ( EwErrorCode *  errorCode)

Add the ComboBox Control in the Ribbon Group.

Since
2022 SP0.
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if wrong input is provided
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonComboBoxControlX object.

◆ addControl()

IEwRibbonControlX IEwRibbonGroupX::addControl ( EwRibbonControlType  eRibbonControlType,
BSTR  strCommand,
EwErrorCode *  errorCode 
)

Add a new control at the end of the ribbon group.

Note
To add ComboBox Control use addComboBoxControl.
Parameters
[in]eRibbonControlTypetype of control
[in]strCommandthe name of a command to launch. Can be blanck.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized or EwRibbonControlType is invalid
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonControlX added to the Ribbon Tab.

◆ getAllowReduce()

EwRibbonGroupReductionLevels IEwRibbonGroupX::getAllowReduce ( EwErrorCode *  errorCode)

Get the current reduce level for the ribbon group.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
EwRibbonGroupReductionLevels enum type, can be:
  • kEwRibbonGroupReductionDisabled do not reduce
  • kEwRibbonGroupFullCaptionDontHided don't hide captions and don't hiding all when reduced
  • kEwRibbonGroupReduceCaptionDontHide hide captions but don't allow hiding all when reduced
  • kEwRibbonGroupFullReduction hide captions and allow hiding all when reduced

◆ getCaption()

BSTR IEwRibbonGroupX::getCaption ( EwErrorCode *  errorCode)

Return the caption of this ribbon group.

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
the caption of this ribbon group.

◆ getControlAt()

IEwRibbonControlX IEwRibbonGroupX::getControlAt ( int  iIndex,
EwErrorCode *  errorCode 
)

Return the specified control of the current group.

Parameters
[in]iIndexPosition of the control.
[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 index is negative or greater than the number of tabs
  • EW_UNDEFINED_ERROR if another error occurred
Returns
An IEwRibbonControlX specified.

◆ getControlCount()

int IEwRibbonGroupX::getControlCount ( EwErrorCode *  errorCode)

Return the number of control in the current group.

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
the number of control in the current group.

◆ getControlsCentering()

VARIANT_BOOL IEwRibbonGroupX::getControlsCentering ( EwErrorCode *  errorCode)

Determine if controls are automatically center in group.

Since
2022 SP1
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
true if controls are centered in group, false otherwise.

◆ getControlsGrouping()

VARIANT_BOOL IEwRibbonGroupX::getControlsGrouping ( EwErrorCode *  errorCode)

Determines if control grouping is used.

ControlsGrouping is for controls grouping within a ribbon group. When you set begin group to true it starts a new group of controls. SetControlsGrouping will group controls like in MS Word within the ribbon group. If you pass false it groups them like in a regular toolbar (divider line).

Since
2022 SP1
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
true if controls grouping is used, false otherwise.

◆ getID()

long IEwRibbonGroupX::getID ( EwErrorCode *  errorCode)

Get the Id's of group.

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
the id of the group.

◆ getIndex()

int IEwRibbonGroupX::getIndex ( EwErrorCode *  errorCode)

Return the index of the group.

Since
2022 SP0.
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
an integer that is the index of the current group.

◆ insertComboBoxControl()

IEwRibbonComboBoxControlX IEwRibbonGroupX::insertComboBoxControl ( int  nPosition,
EwErrorCode *  errorCode 
)

Insert the ComboBox Control in the Ribbon Group.

Since
2022 SP0.
Parameters
[in]nPositionposition where button must be inserted in ribbon group
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if wrong input is provided
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonComboBoxControlX.

◆ insertControl()

IEwRibbonControlX IEwRibbonGroupX::insertControl ( int  nPosition,
EwRibbonControlType  eRibbonControlType,
BSTR  strCommand,
EwErrorCode *  errorCode 
)

Insert a new control to a pop-up button in a ribbon.

Since
2022 SP0.
Note
To insert ComboBox Control use insertComboBoxControl.
Parameters
[in]nPositionposition where button must be inserted in ribbon group , if position is negative or higher than the number of control in group, then the control will be added to the queue of the group
[in]eRibbonControlTypetype of ribbon control
[in]strCommandthe name of a command to launch. Can be blank.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized or EwRibbonControlType is invalid
  • EW_BAD_INPUT if eType is not a good type or if the current button is not a pop-up button.
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonControlX added to the control.

◆ removeAll()

EwErrorCode IEwRibbonGroupX::removeAll ( )

Remove all controls.

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

◆ removeControl()

EwErrorCode IEwRibbonGroupX::removeControl ( int  iIndex)

Remove a control specified by the index.

Parameters
[in]iIndexthe index of the control 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 index is greater than the number of control or negative.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setAllowReduce()

EwErrorCode IEwRibbonGroupX::setAllowReduce ( EwRibbonGroupReductionLevels  eRibbonGroupReductionLevels)

Set this method to prevent group to be reduced.

Since
2023 SP0
Parameters
[in]eRibbonGroupReductionLevelsEwRibbonGroupReductionLevels enum type, can be:
  • kEwRibbonGroupReductionDisabled do not reduce
  • kEwRibbonGroupFullCaptionDontHided don't hide captions and don't hiding all when reduced
  • kEwRibbonGroupReduceCaptionDontHide hide captions but don't allow hiding all when reduced
  • kEwRibbonGroupFullReduction hide captions and allow hiding all when reduced
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected

◆ setCaption()

EwErrorCode IEwRibbonGroupX::setCaption ( BSTR  strCaption)

Set a new caption for this ribbon group.

Parameters
[out]strCaptionthe new caption to display.
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

◆ setControlsCentering()

EwErrorCode IEwRibbonGroupX::setControlsCentering ( VARIANT_BOOL  bControlsCentering)

Automatically center controls in group, false by default.

Since
2022 SP1
Parameters
[in]bControlsCenteringTRUE to center controls in group.
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

◆ setControlsGrouping()

EwErrorCode IEwRibbonGroupX::setControlsGrouping ( VARIANT_BOOL  bControlsGrouping)

Group buttons in the group, false by default.

This is for controls grouping within a ribbon group. When you set begin group to true it starts a new group of controls. SetControlsGrouping will group controls like in MS Word within the ribbon group. If you pass false it groups them like in a regular toolbar (divider line).

Since
2022 SP1
Parameters
[in]bControlsGroupingTRUE to use grouping for buttons.
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
Generated on Thu Aug 25 2022 16:02:39 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: IEwRibbonGroupX 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.

0.20.21